ほかのアクションタイプを探索する

はじめにのチュートリアルでは、単一のオブジェクトのプロパティを変更するルールという、1種類のアクションタイプを作成します。アクションタイプでは、プロパティの編集以外にもさまざまな操作を表現できます。同じ設定画面で、オブジェクトの作成と削除、オブジェクト間のリンクの管理、関数によるカスタムロジックの実行、外部システムの呼び出し、ユーザーへの通知、ビルドのトリガー、シナリオの編集内容のマージも行えます。

このページでは、これらの機能とそれぞれの用途を紹介し、リファレンスドキュメントへのリンクを示します。例では、はじめにのチュートリアルで使用した Demo Ticket オブジェクトタイプを引き続き使用するため、同じオントロジーで手順に沿って進められます。

前提条件

• はじめにのチュートリアルを完了してください。このチュートリアルでは、このページの以降の内容で理解していることを前提とする、作成ウィザード、パラメーター、実行条件について説明しています。
• 変更する予定のオブジェクトタイプが編集できるように設定されていることを確認してください。

ルールを設定する場所

以下の機能はルールで設定します。ルールは2か所で追加できます。

作成ウィザードでは、新しいアクションタイプの最初のルールを設定します。アクションタイプのステップで、オブジェクトタブを開き、オブジェクトタイプを選択してから、オブジェクトアクションでアクションによる変更内容を選択します。マッピングのステップで、含めるプロパティを選択します。はじめにのチュートリアルでは、この流れを説明しています。

すでに存在するアクションタイプの場合は、Ontology Manager で開き、ルールタブを選択してから、新しいルールを追加を選択し、必要なルールを選択します。このページで説明するすべてのルールをここで追加できます。

単一のアクションタイプに複数のルールを組み合わせることができます。ただし、関数ルールは例外で、ほかのオントロジールールとは組み合わせられません。

ルールを選択する

ルールのリファレンスでは、すべてのルールについて詳しく説明しています。

オブジェクトを作成および削除する

はじめにのチュートリアルでは、ユーザーが選択したオブジェクトを変更します。代わりに新しいチケットを作成するには、オブジェクトを作成するルールを追加し、Demo Ticket オブジェクトタイプを選択します。オブジェクトタイプの主キー（この例では Ticket ID）は、入力が必要な必須プロパティです。プロパティを追加を選択して、Title、Status、Priority など、新しいオブジェクトに必要なほかのプロパティを追加します。

プロパティを追加するたびに、同じ名前のパラメーターが自動的に作成され、そのパラメーターにプロパティがマッピングされます。代わりに、オブジェクト参照パラメーターのオブジェクトのプロパティ、ユーザーが変更できない固定値、現在のユーザー、または実行時刻にプロパティをマッピングすることもできます。すべてのマッピングオプションについては、値とパラメーターを確認してください。

残りのケースには、関連する2つのルールで対応できます。

• オブジェクトを作成または変更： オブジェクト参照パラメーターで指定されたオブジェクトを変更します。オブジェクトが指定されていない場合は、自動生成された一意の ID またはユーザーが送信した主キーを使用して、新しいオブジェクトが作成されます。
• オブジェクトを削除： オブジェクト参照パラメーターで指定されたオブジェクトを削除します。このルールでは、同じアクションが作成するオブジェクトを参照できません。

オブジェクト間のリンクを管理する

アクションでは、オブジェクトのプロパティだけでなく、オブジェクト間の関連付けも管理できます。必要なルールは、リンクタイプのカーディナリティによって異なります。

多対多のリンクタイプの場合は、リンクを作成ルールを追加して、オブジェクト参照パラメーターで指定された2個のオブジェクトを関連付けます。または、リンク削除ルールを追加して、それらの関連付けを削除します。

一対一または一対多のリンクタイプの場合、関連付けはオブジェクトの外部キープロパティに保存されます。リンクルールではなく、オブジェクトを変更するルールを使用して、そのプロパティを設定またはクリアします。

単一のアクションで、オブジェクトとその多対多のリンクを作成することもできます。多対多のリンクタイプを持つオブジェクトタイプでオブジェクトを作成するルールを設定し、プロパティを追加の下にあるリンクを追加を選択して、リンクタイプを選択し、リンクを設定します。

関数でカスタムロジックを実行する

ルールは編集内容を宣言的なマッピングとして記述しますが、それだけでは十分でない場合もあります。ユーザーが選択したオブジェクトにリンクされているすべてのオブジェクトを変更したい場合、複数のオブジェクトを読み取るビジネスロジックからプロパティ値を計算したい場合、または複数のタイプのオブジェクトを作成して相互にリンクしたい場合は、オントロジー編集関数でアクションを実装することを検討してください。

Function実行ルールを1つ追加し、公開済みの関数と使用するバージョンを選択します。関数のすべての入力がアクションタイプのパラメーターとして作成され、ほかのパラメーターと同じように制約を設定できます。Function実行ルールは、ほかのオントロジールールと組み合わせられません。関数のコードだけで、それらのルールでできることをすべて表現できるためです。

詳しいウォークスルーは、関数ベースのアクションのチュートリアルに沿って進めてください。アクションが参照する関数のバージョンを変更する方法も説明しています。デフォルトでは、アクションは選択したバージョンを使用し続けます。代わりに実行時にバージョン範囲を解決するには、自動アップグレードを有効にします。有効にする前に、そのページで説明している権限と破壊的変更に関するトレードオフを確認してください。

Webhook で外部システムを呼び出す

Foundry 外部のシステムがプロセスの一部における信頼できる情報源である場合、Webhook ルールはアクションの適用時にそのシステムへリクエストを送信します。アクションのパラメーターは、入力として Webhook に渡せます。

リクエストを送信するルールは2種類あり、追加するルールによって実行のタイミングが決まります。

• Webhook: オブジェクトの編集が適用された後にリクエストが送信されます。このルールは副次的効果グループから追加します。アクションタイプにはこのルールを複数含めることができ、失敗してもエンドユーザーには表示されません。エンドユーザーには、すでに成功メッセージが表示されている場合があります。
• 書き戻し Webhook: ほかのルールが評価される前にリクエストが送信されます。このルールは外部リクエストグループから追加します。リクエストに失敗した場合、編集は適用されず、エンドユーザーに失敗が表示されます。アクションタイプにはこのルールを1個だけ含めることができ、その出力パラメーターは後続のルールで使用できます。

ルールで Webhook を選択するには、Data Connection にその Webhook がすでに存在している必要があります。設定手順については Webhook をセットアップするに沿って進め、入力パラメーター、出力パラメーター、認証オプションについては Webhook を確認してください。

アクションの適用時にユーザーに通知する

通知ルールは、アクションが適用されたことをユーザーに知らせます。受信者には、固定のユーザー集合を指定することも、オブジェクトパラメーターのプロパティから導出することもできます。また、通知内容にはアクションのパラメーターを参照するテンプレートを使用できます。各受信者には、ご自身の通知設定に応じて、プラットフォーム内のプッシュ通知、メール、またはその両方が届きます。

通知はアクションによる編集がすべて適用された後に送信されますが、通知内容は編集前のオントロジーの状態から生成されます。具体的な例については通知をセットアップするに沿って進め、受信者と通知内容のすべてのオプションについては通知を確認してください。

ビルドをトリガーする

スケジュールルールは、アクションの適用時にスケジュールのビルドをトリガーします。このルールはアドバンスドグループから追加します。これにより、オントロジー内のエンドユーザーのワークフローで、アクションの一環としてデータセットを再計算できます。スケジュールはプロジェクトスコープモードである必要があります。

スケジュールルールを含むアクションタイプは、ビルドの完了を待たず、ビルドの開始後にオントロジーの編集を適用します。パラメーター化されたスケジュールに値を渡す方法と、その結果として実行されたスケジュールの RID をオブジェクトに記録する方法については、スケジュールのビルドをトリガーするを確認してください。

シナリオの編集をマージする

シナリオ内で行われた編集は、そのシナリオのサンドボックス内にのみ存在し、メインのオントロジーには影響しません。マージアクションは、ステージングされたすべての編集を単一のトランザクションとしてコミットします。マージアクションには、シナリオの RID を保持するシナリオパラメーターが必要です。この値は通常、Workshop の変数またはオントロジー SDK アプリケーションから渡されます。

マージアクションを作成する方法は2つあります。

• 新しいアクションタイプを作成し、作成ウィザードでシナリオタブを選択してから、関連するオブジェクトタイプとリンクタイプを追加してマージの対象範囲を定義します。
• すでに存在するアクションタイプのルールタブから、シナリオの適用ルールを追加します。

いずれの場合も、アクションタイプのセキュリティ & 実行条件タブを使用して、マージを実行できるユーザーを定義します。設定の詳細については、シナリオをマージするを確認してください。

インターフェースに対してアクションを実行する

インターフェースには、オントロジーの編集ごとに専用のルールがあります。

• インターフェースのオブジェクトを作成
• インターフェースのオブジェクトを修正する
• インターフェースのオブジェクトを削除
• インターフェースのオブジェクトにリンクを作成
• インターフェースのオブジェクトからリンクを削除

各ルールは、特定の1個のオブジェクトタイプではなく、そのインターフェースを実装する任意のオブジェクトタイプを対象とします。変更ルールと削除ルールでは、オブジェクト参照パラメーターの代わりにインターフェース参照パラメーターを使用します。インターフェースに対するアクションを確認してください。

ルール内で構造体プロパティをマッピングする

構造体プロパティは、プロパティのフィールドと同じ構成のネストされたフィールドを持つ構造体パラメーターから値を取得します。ルール内でプロパティをマッピングし、すべてのフィールドがマッピングされていることを確認してください。構造体に対するアクションを確認してください。

次のステップ

• テスト実行でアクションタイプを検証する。
• ルールの完全なリファレンスを確認する。
• パラメーターでユーザーが実行時に指定できる内容を定義する。
• 実行条件でアクションを適用できるタイミングを制限する。
• プラットフォームのほかの場所でアクションを使用する。