ドキュメントの検索
karat

+

K

APIリファレンス ↗
オントロジーアクションタイプサイドエフェクト通知
Feedback

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

通知

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

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

通知の設定には、受信者内容の指定が必要です。以下のセクションではこれらのオプションについて詳細に説明します。

受信者

通知の受信者オプションの設定により、アクションが実行された際に通知を受け取るFoundryユーザーの集合を指定できます。通知は各受信者に個別に送信されます。メール通知のCC(カーボンコピー)受信者としてユーザーを追加することはサポートされていません。

受信者の指定には、いくつかの方法がサポートされています:

受信者ドロップダウン
  • **静的:**設定で、アクションが実行されるたびに常に通知を受け取るユーザーやグループの集合を選択することができます。

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

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

  • **関数から:**上記のオプションでカバーされないユースケースがある場合、アクションのパラメーターを入力とするカスタム関数を作成して、通知を受け取るべきユーザーやグループのリストを返すことができます。ユーザーやグループのリストを返す関数の書き方について詳しくはこちら。

    関数に基づく受信者の使用例としては、以下のようなものがあります:

    • 他の受信者オプションの組み合わせ。例えば、オブジェクトパラメーターの属性から指定されたassigneeと、常に通知を受け取る静的な追加受信者の集合を通知します。
    • 他のパラメーターやパラメーターのプロパティ値に基づく受信者選択。例えば、新しいタスクがEMEAにある場合は一つのユーザーセットに通知し、新しいタスクが北米にある場合は別のユーザーセットに通知します。
    • 構造化オプションには収まらない他のカスタムロジック。

受信者は、通知がどのように配信されるかの設定を変更することができます。例えば、一部のユーザーはウェブブラウザでのみ通知を受け取ることを選択するかもしれませんし、別のユーザーはプラットフォーム内のトーストとメールの両方で受け取ることを選択するかもしれません。ユーザーが個人設定でアクション通知をオフにしている場合、通知は送信されません。ただし、Foundryにログインしたときに「通知」から「すべて見る」を選択して通知を表示することは可能です。

内容

通知の内容をカスタマイズするためのいくつかのオプションがあります。内容はテンプレートまたはカスタム関数を介して設定することができます。テンプレート内容を選択すると、設定ダイアログ内で直接完全な内容を設定することができます。関数内容では、適切な通知タイプを返す公開関数を持つ必要があります。

内容タイプドロップダウン

内容の要素

  1. **件名:**通常、内容には件名が含まれます。デフォルトでは、これはすべての配信方法で同じになります。
  2. **本文:**通知の本文です。プラットフォーム内の通知では、この内容が通知トースト内に表示されます。メールの場合、メールの本文内にレンダリングされます。
  3. **リンク:**リンクを指定することができます。これは通知の本文内容のすぐ下にあるボタンとして表示されます。ボタンのテキストはカスタマイズできます。
    • リンクの設定には以下のオプションが利用可能です:
      • 既存のオブジェクトパラメーターへのリンク
      • Workshopアプリへのリンク
      • Carbonワークスペースへのリンク
      • 新規作成されたオブジェクトへのリンク
  4. **高度なメール設定:**通知を設定する際、メールで通知を配信するときに使用するカスタム内容本文を指定することができます。このオプションを使用すると、プラットフォーム内の通知ではサポートされていないより高度なフォーマットのHTMLを使用することができます。プレビューでは、パラメーター参照を除いた通知の見た目を確認することができます。受信者は、通知をメールで受け取る設定をしている場合に限り、この内容を受け取ります。

上記の件名、本文、リンクでは、トリプルハンドルバーを使用してパラメーターやユーザー属性を参照することができます。セクションを編集する際、利用可能なパラメーターの一つをクリックすると、そのパラメーターやユーザー属性の正しいハンドルバー参照が自動的に生成されます。

  1. 関数から:"関数から"を選択すると、上記にリストしたセクションを設定しません。代わりに、カスタム内容の各セクションを指定するプロパティを持つNotificationオブジェクトを返す関数を提供する必要があります。以下の条件のいずれかに該当する場合、関数を使用する必要があります:
    • 通知内容が受信者やアクションへの入力パラメーターによって全く異なる場合。
    • メールとプラットフォーム内の通知で異なる件名を設定したい場合。
    • フルリンクURLを使用したい場合、Foundryの外部に存在するシステムやアプリケーションへのリンクを含む。
    • 内容のレンダリング時にパラメーター経由で提供されるデータを超えて検索周辺、集約、またはデータをクエリしたい場合。
    • テンプレート内容オプションでは不可能な他のカスタム要件がある場合。

通知の戻りタイプについての詳細は、関数ドキュメンテーションを参照してください。

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


例の設定

これは通知のための設定例です。

Example notification Configuration Labelled
  1. 受信者 の設定
  2. コンテンツ の設定
    • テンプレートから選択(オントロジーアプリのダイアログで直接設定)または関数(完全に形成された Notification オブジェクトを返す関数を指定)。
  3. テンプレート通知のための 件名 ライン。
  4. アクションに対する利用可能な パラメーター に基づいて利用可能な パラメーター。パラメーターをクリックして、そのパラメーターを参照する {{{}}} 構文を生成します。
  5. テンプレート通知のための 本文 コンテンツ。
  6. テンプレート通知のための リンク 設定(オプション)。
  7. テンプレート通知とともに カスタム HTML コンテンツをメールで (オプション)。

他の重要な情報

最大受信者制限

  • 通知コンテンツをレンダリングするために "From a Function" オプションを使用する場合、受信者は最大50人です。コンテンツ設定オプションの下で "From a Function" を選択したときに設定パネルに警告が表示され、アクションが実行されるたびに受信者の数が確認されます。受信者の数が制限を超えている場合、赤いエラートーストが表示され、アクションは実行に失敗します。
  • コンテンツが設定ダイアログで直接設定された場合、単一のアクション通知の最大受信者数は500人です。

Function-rendered Content max-recipients warning

コンテンツの長さ制限

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

これらの最大コンテンツ長は、通知がレンダリングされるときに検証および切り捨てられることを覚えておいてください。これは、レンダリングされたコンテンツが動的である場合(例えば、通知コンテンツがオブジェクトデータを含む場合)、許可された最大長を超える任意のコンテンツが切り捨てられ、末尾の ... で示されることを意味します。

厳格な削除

あなたの Foundry インスタンスで "Strict Redaction" または "Group Redaction" が有効になっている場合、カスタム通知コンテンツはレンダリングされません。代わりに、ユーザーは以下に示す一般的なメッセージを受け取ります。"View" を選択すると、Foundry に移動し、完全な通知コンテンツを表示することができます。Foundry でのメールコンテンツの削除について詳しく学ぶ。

Strict redaction email content default

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

  • グループは個々のユーザーに解決され、通知を送信する前にデータの権限を確認します。
  • Foundry ユーザーとグループの ID は、アカウントの設定から見つけることができます。通知の設定インターフェースは、静的な受信者セットを選択するときにユーザーとグループのセレクターを提供します。これは、アクションを設定する人が適切な権限を持つユーザーとグループのみを表示します。
  • 受信者がオブジェクトプロパティへの参照を介して設定されている場合、プロパティが Foundry ユーザーまたはグループ ID を文字列として保存していることを確認してください。関連するユーザーまたはグループの表示名を表示するために条件付き書式設定を使用することができます(詳細については、値の書式設定のドキュメンテーションを参照してください)。
  • メールアドレスに直接送信することはサポートされていません。

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

新しく作成したオブジェクトをリンクするときは、その主キーを参照する必要があります。なぜなら、通知がレンダリングされる時間までにオブジェクト RID は生成されないからです。

例: 新しい task オブジェクトを作成するアクションを持ち、タスクを作成するときに一意の ID を生成します。アクション通知の中で、新しく作成されたオブジェクトへのリンクをObject Explorer によって提供されるパラメーターオプションを使用してレンダリングします。

  • Function 生成コンテンツを使用して URL リンクを指定するときにサポートされている2つの方法があります:
    • 完全なリンクの例:https://<your-foundry-instance>.com/workspace/module/view/latest/<module-rid>
    • 相対リンクの例:/module/view/latest/<module-rid>

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

  • ユーザーは、閲覧を許可されたデータを含む通知のみを受け取ることができます。
  • 複数の受信者がいる場合、すべての受信者は通知コンテンツでレンダリングされたオブジェクトデータにアクセスする必要があります。
  • アクションを設定するとき、通知の失敗を処理するための2つの方法が、サイドバーの Security & Submission Criteria タブの下部で利用可能です:
    • すべてのユーザーが権限を持つことを要求する(デフォルト): 必要なアクセス権を持たない受信者がいる場合、アクションを適用しようとするとエラーが表示されます。これが起こると、データは編集されず、通知は送信されません。
    • 任意のユーザーが権限を持つことを要求する: 少なくとも1人のユーザーがオブジェクトを見ることができれば、アクションは成功します。権限を持つユーザーだけが通知を受け取ります。