通知効果

Automate アプリケーションを使用すると、条件が満たされたときに他のプラットフォームユーザーに自動的に通知を送信することができます。

通知は、プラットフォーム内で直接、またはメールで送信することができます。内容は静的に定義することも、関数を介して動的に決定することもできます。通知には PDF 添付ファイルも含めることができます。このページには、通知の 受信者、内容、および 添付ファイル のオプションに関する情報が含まれています。

受信者

通知を設定するとき、まず誰が通知を受け取るべきかを定義する必要があります。受信者は、Foundry のユーザーやグループで、静的受信者リスト または オブジェクトプロパティを介した動的な定義 のいずれかで定義することができます。

静的受信者リスト

通知の受信者を定義する最初のオプションは、これらの受信者を Static の下で静的リストとして提供することです。リストを定義するには、関連するテキストフィールドをクリックして、受信者になるユーザーやグループを選択します。

オブジェクトプロパティを介した動的な受信者定義

2番目のオプションは、影響を受けるオブジェクトのオブジェクトプロパティを介して通知の受信者を動的に定義することです。この設定オプションには、ライブ評価 をサポートするオブジェクトセット条件が必要です。

動的な受信者定義では、通知の受信者をランタイムで決定するために、ユーザーID または グループID を含むオブジェクトプロパティを指定することができます。したがって、オブジェクトプロパティの型は String または Array of String のいずれかでなければなりません。

以下に示す例では、Contract オブジェクトタイプに対してオブジェクトの変更条件を定義します。その後、ユーザーIDの配列を含む Contract Owners プロパティを使用して、通知の受信者のセットを定義することができます。

内容

通知の内容を定義する方法は2つあります：プレーン通知 または 関数生成通知 の形式で。

プレーン通知

プレーン通知では、通知の内容を直接指定するためのインターフェースコンポーネントを提供します。Heading と Message を提供する必要があります。また、URL Link を変更することもできます。デフォルトでは、URL リンクはメール内でのみ表示されるプラットフォーム内の通知へのリンクです。

また、Advanced email configuration を使用して、メールの値を設定することもできます。デフォルトでは、上記でプラットフォーム内の通知に対して提供した Heading、Message、および URL link の値が使用されます。必要に応じて、詳細なメール設定で HTML を使用することもできます。

行ったすべての変更は、設定コンポーネントの右側でライブプレビューされます。

最後に、通知の 添付ファイル を定義することもできます。

関数生成通知

プレーン通知を使用する代わりに、通知を動的に生成する関数で通知をバックアップすることもできます。これは、プレーン通知では満たせない通知のニーズに対してのみ使用すべきです。

独自の通知関数を作成するには、Functions documentation の指示に従ってください。関数は Notification または Notification | undefined のいずれかを返す必要があります。undefined が返された場合、Automate は通知をスキップします。これは、関数のロジックで通知を送信するかどうかを条件付きで決定するために使用することができます。

通知関数を作成し、公開した後、通知効果でそれを使用することができます。関数とバージョンを選択することから始めます。その後、インターフェースが更新され、関数の定義に応じて必要な入力が表示されます。

条件効果の入力と受信者の使用

入力パラメーターのタイプにより、静的な値を提供するだけでなく、特殊な効果の入力を使用することができます。サポートされる効果の入力には以下のものがあります：

• Recipient: User タイプの関数の入力に使用でき、通知がレンダリングされる受信者を関数に渡します。
• Condition effect input: 条件が効果入力を公開している場合、ここでそれらの効果入力を使用することができます。関数のパラメーターの型は、公開される効果入力の型と一致していなければなりません。条件によって公開される型は、条件のタイプと実行モードによります。

以下の例では、Recipient 入力と Contract modified 条件効果入力が使用されて、受信者と自動化をトリガーした対象オブジェクトに合わせたカスタム通知を作成しています。

添付ファイル

通知効果に Notepad documents または Notepad template documents からの PDF を添付するように設定することができます。PDF は、各受信者ごとにランタイムで自動的に生成されます。

添付ファイルセクションで + Select を選択し、Notepad ドキュメントまたは Notepad テンプレートを選択します。次に、添付ファイルのファイル名を指定します。選択したリソースタイプにより、次のセクションで説明するように、より多くの値を提供する必要があるかもしれません。

Notepad テンプレート

Notepad テンプレートは、通知効果が実行されたときに Notepad ドキュメントを動的に生成して PDF としてエクスポートするために使用できます。これは Notepad テンプレート入力を介して行われます。Notepad テンプレート入力を使用して、生成ステップ中に Notepad ドキュメントに値を渡すことができます。Notepad テンプレートの機能については、templates documentation を参照してください。

Notepad テンプレートと Template version を選択した後、必要な Template Inputs が表示されます。Automate アプリケーションは、静的な値と condition effect inputs を Notepad テンプレート入力に渡すことをサポートしています。テンプレートがオブジェクトまたはオブジェクトセットのテンプレート入力を公開し、条件が同じタイプの条件効果入力を公開している場合、条件効果入力をテンプレートに渡すことができます。

以下の画像は、Notepad テンプレート Support tickets overview が通知効果に添付されている例を示しています。テンプレート入力 support tickets は Object added to set 条件によって公開される New Support Tickets 条件入力に接続されています。したがって、条件がトリガーされるたびに、条件をトリガーしたオブジェクトが使用されて、テンプレートからドキュメントの PDF を生成します。