オントロジーの構築アクションサイドエフェクト通知

注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

通知

新しいルールを追加ドロップダウンメニューから、アクションに通知を追加できます。通知を追加する方法について詳しくはこちら。

新しいルールを追加のドロップダウンメニュー

通知を設定するには、受信者とコンテンツを指定する必要があります。以下のセクションでは、これらのオプションについて詳しく説明します。

受信者

通知の受信者オプションを設定すると、アクションの実行時に通知を受け取る Foundry ユーザーを指定できます。通知は受信者ごとに個別に送信されます。メール通知の CC(カーボンコピー)受信者としてユーザーを追加することには対応していません。

受信者を指定するには、次の方法を利用できます。

受信者ドロップダウン
  • 固定: 設定では、アクションの実行時に常に通知されるユーザーまたはグループを選択できます。

  • パラメーターから: アクションのパラメーターに Foundry のユーザーIDまたはグループIDがある場合、そのパラメーターを通知の受信者として指定できます。

    • この方法を使うと、このアクションを使用するアプリケーションやモジュールのユーザーインターフェースで、送信者が1人以上の受信者を選択できるようにしたり、アクションを実行するユーザーを自動的に検出して通知を送信したりできます。
  • オブジェクトパラメーターの属性から: アクションにオブジェクトパラメーターがあり、そのオブジェクトのプロパティのいずれかに Foundry のユーザーIDまたはグループIDが含まれている場合、パラメーターのそのプロパティを受信者として指定できます。Foundry のユーザーIDおよびグループIDのリストでも、この方法を利用できます。

  • 関数から: 上記の選択肢でユースケースに対応できない場合は、アクションのパラメーターを受け取り、通知するユーザーまたはグループのリストを返すカスタム関数を作成できます。ユーザーまたはグループのリストを返す関数の作成方法について詳しくはこちら。

    関数に基づいて受信者を指定するユースケースの例を以下に示します。

    • 受信者を指定するほかの選択肢を組み合わせる場合。たとえば、オブジェクトパラメーターの属性から指定された assignee に通知するとともに、固定の追加受信者にも常に通知する場合です。
    • ほかのパラメーターやパラメーターのプロパティ値に基づいて受信者を選択する場合。たとえば、EMEA で新しいタスクが発生するたびに特定のユーザーに通知し、北米で新しいタスクが発生するたびに別のユーザーに通知する場合です。
    • 構造化された選択肢では対応できない、その他のカスタムロジックを使用する場合。

受信者は、通知の配信方法に関する個人設定を変更できます。たとえば、あるユーザーは Web ブラウザーでのみ通知を受け取るように選択し、別のユーザーはプラットフォーム内のトーストとメールの両方を受け取るように選択する場合があります。ユーザーが個人設定でアクション通知をオフにしている場合、そのユーザーには通知されません。ただし、Foundry にログインし、ワークスペースで「通知」、次に「すべて表示」に移動すると、通知を閲覧できます。

コンテンツ

通知のコンテンツをカスタマイズするには、いくつかの選択肢があります。コンテンツはテンプレートで設定することも、カスタム関数から生成することもできます。テンプレートコンテンツを選択すると、設定ダイアログでコンテンツ全体を直接設定できます。関数コンテンツを使用するには、適切な通知タイプを返す公開済みの関数が必要です。

コンテンツの種類のドロップダウン

コンテンツの構成要素

  1. 主題: 通常、コンテンツには件名が含まれます。デフォルトでは、すべての配信方法で同じ件名になります。

  2. 本体: 通知の本文です。プラットフォーム内の通知では、通知トースト内に表示されます。メールでは、メールの本文内に表示されます。

  3. リンク: リンクを指定できます。リンクは、通知の本文コンテンツのすぐ下にボタンとして表示されます。ボタンのテキストはカスタマイズできます。

    • リンクの設定には、次の選択肢を利用できます。
      • 既存のオブジェクトパラメーターへのリンク
      • Workshop アプリへのリンク
      • Carbon ワークスペースへのリンク
      • 新しく作成されたオブジェクトへのリンク
  4. メールの詳細設定: 通知を設定する際に、メールで通知を配信するときに使用するカスタム本文コンテンツを指定できます。このオプションでは、HTML を使用して、プラットフォーム内の通知では利用できない高度な書式設定を行えます。プレビューには、パラメーターへの参照を除いた通知の表示が示されます。受信者がこのコンテンツを受け取るのは、メールで通知を受け取るように個人設定している場合のみです。

上記の主題、本体、リンクでは、3重の波括弧を使用してパラメーターやユーザー属性を参照できます。セクションの編集中に、利用可能なパラメーターのいずれかをクリックすると、そのパラメーターまたはユーザー属性を参照する正しい波括弧の構文が自動生成されます。

  1. 関数から:「関数から」を選択した場合、上記のセクションは設定しません。代わりに、カスタムコンテンツの各セクションを指定する適切なプロパティを持つ Notification オブジェクトを返す関数を指定する必要があります。次のいずれかに該当する場合は、関数の使用が必要になることがあります。
    • 受信者やアクションの入力パラメーターによって、通知のコンテンツがまったく異なる場合。
    • メールとプラットフォーム内の通知で、異なる件名を使用する場合。
    • Foundry 外部のシステムやアプリケーションへのリンクを含む、完全なリンク URL を使用する場合。
    • コンテンツを表示する際に、関連検索や集計を行う、またはパラメーターで渡されるデータ以外のデータをクエリする場合。
    • テンプレートコンテンツのオプションでは対応できない、その他のカスタム要件がある場合。

Notification の戻り値の型の詳細は、Functions のドキュメントを参照してください。

通知コンテンツの生成に使用されるオントロジーのデータには、現在のアクションの編集内容が適用される前のオントロジーの状態が反映されます。通知の受信者が特定のオブジェクトの最新の状態にアクセスできるようにするには、オブジェクトパラメーターから参照されるオブジェクトへのリンク、または新しく作成されたオブジェクトへのリンクを通知に埋め込むことができます。ただし、新しく作成されたオブジェクトへのリンクは、そのオブジェクトが関数ではなく「オブジェクトを作成」ルールで作成された場合に限ります。


設定例

以下は通知の設定例です。

ラベル付きの通知設定例
  1. 受信者の設定
  2. コンテンツの設定
    • テンプレート(オントロジーアプリのダイアログで直接設定)または関数(すべての要素が揃った Notification オブジェクトを返す関数を指定)から選択します。
  3. テンプレート通知の主題。
  4. アクションで利用可能なパラメーターに基づく、利用可能なパラメーター。パラメーターをクリックすると、そのパラメーターを参照する {{{}}} 構文が生成されます。
  5. テンプレート通知の本体コンテンツ。
  6. テンプレート通知のリンク設定(任意)。
  7. テンプレート通知のメール用のカスタム HTML コンテンツ(任意)。

その他の重要な情報

受信者数の上限

  • 「関数から」オプションを使用して通知内容を表示する場合、受信者数の上限は50人です。内容の設定オプションで「関数から」を選択すると、設定パネルに警告が表示され、アクションの実行時に毎回受信者数が確認されます。受信者数が上限を超えている場合、赤いエラートーストが表示され、アクションの実行に失敗します。
  • 「テンプレート」オプションを使用して設定ダイアログで内容を直接設定する場合、1件のアクション通知の受信者数の上限は500人です。

関数で表示する内容の受信者数上限に関する警告

内容の長さの上限

  • 件名の最大文字数は250文字です。
  • 本文の最大文字数は1,000文字です。メールでカスタム HTML コンテンツを表示する場合、最大文字数は51,200文字です。

これらの内容の長さの上限は、通知の表示時に検証され、上限を超える内容は切り詰められる点に留意してください。つまり、表示される内容が動的な場合(たとえば、通知内容にオブジェクトデータが含まれる場合)、許容される最大文字数を超える内容は切り詰められ、末尾の ... で示されます。

厳格な秘匿化

Foundry インスタンスで送信メール通知の「厳格な秘匿化」または「グループ秘匿化」が有効になっている場合、カスタム通知内容は表示されません。代わりに、ユーザーは以下に示す汎用メッセージを受信します。「表示」を選択すると Foundry に移動し、通知内容の全文を閲覧できます。Foundry のメール内容の秘匿化について詳しくはこちら。

厳格な秘匿化が適用されたメール内容のデフォルト

受信者のユーザーアカウント

  • 通知を送信する前にデータに対する権限を確認するため、グループは個々のユーザーに展開されます。
  • Foundry のユーザーIDおよびグループIDは、設定のアカウントで確認できます。通知の設定インターフェースには、固定の受信者を選択するためのユーザーおよびグループのセレクターがあります。ここには、アクションを設定するユーザーが十分な権限を持つユーザーとグループのみが表示されます。
  • オブジェクトプロパティを参照して受信者を設定する場合は、そのプロパティに Foundry のユーザーIDまたはグループIDが文字列として保存されていることを確認してください。条件付き書式設定を使用すると、関連するユーザーまたはグループの表示名を表示できます(詳細は、値の書式設定のドキュメントを参照してください)。
  • メールアドレスへの直接送信には対応していません。

新しく作成されたオブジェクトへのリンク

通知の表示時点ではオブジェクト RID が生成されていないため、新しいオブジェクトにリンクする際は、その主キーを参照する必要があります。

例: 新しい task オブジェクトを作成するアクションがあり、タスクの作成時に一意の ID を生成するとします。アクション通知内では、Object Explorer が提供するパラメーターの選択肢を使用して、新しく作成されたオブジェクトへのリンクを表示します。

  • 関数により生成された内容を使用する場合、URL リンクを指定する方法は次の2つに対応しています。
    • 完全なリンクの例: https://<your-foundry-instance>.com/workspace/module/view/latest/<module-rid>
    • 相対リンクの例: /module/view/latest/<module-rid>

受信者に必要なデータアクセス権限

  • ユーザーが受信できるのは、閲覧を許可されているデータを含む通知のみです。
  • 受信者が複数いる場合、すべての受信者が、通知内容に表示されるオブジェクトデータへのアクセス権限を持っている必要があります。
  • アクションを設定する際、サイドバーのセキュリティ & 実行条件タブの下部で、通知の失敗に対処する2つの方法を利用できます。
    • すべてのユーザーが権限を持つことが必要(デフォルト): 必要なアクセス権限を持たない受信者がいる場合、アクションの適用を試みた際にエラーが表示されます。この場合、データは編集されず、通知も送信されません。
    • いずれかのユーザーが権限を持つことが必要: オブジェクトを閲覧できるユーザーが1人以上いる場合、アクションの実行に成功します。権限を持つユーザーのみが通知を受信します。

メール内容の秘匿化をオーバーライドして無効にする

組織の設定で許可されている場合、特定のアクションタイプについて、組織レベルで設定されたその他の厳格な秘匿化設定を回避し、秘匿化されていない内容を送信するアクションタイプを作成できます。

メール通知の秘匿化をオーバーライドするには、セキュリティ & 実行タブに移動し、通知設定 > 通知の編集を無効にするに移動します。

通知の編集を無効にするオプションがある通知設定。

組織でこの機能を有効にする方法については、メールの秘匿化に関するドキュメントページを参照してください。