Workshop でアクションを使用する

Foundry のアクションを使用すると、定義済みのルールセット（アクションタイプと呼ばれます）に基づいて、オブジェクトデータの編集、作成、削除、リンクを行えます。たとえば、アクションによって、ユーザーは次の操作を 1 個以上実行できます。

• 新しい Flight オブジェクトを作成し、その Flight Number、Time of Departure、Origin、Destination プロパティを入力します。
• 既存の Flight オブジェクトを変更して、Destination プロパティを変更します。
• 特定の Flight オブジェクトを特定の Passenger オブジェクトにリンクします。
• 誤って作成した Flight オブジェクトを削除します。

アクションは、複雑なオブジェクトデータの編集を使いやすいインターフェースで包むことで、アプリケーションの作成者が、ユーザーによるオブジェクトデータへのライトバックに、わかりやすく安全な構成要素を使用できるようにします。これらの構成要素は、次のように活用できます。

• 複数のアプリケーション（Workshop や Object View など）で使用して、業務プロセスのワークフローに対応できます。
  • アクションの定義に基づいてフォームコンポーネントが自動生成されるため、オブジェクトデータへのライトバックと、それに関連するユーザーインターフェースを別々に定義する必要はありません。Workshop とアクションの主要なインタラクションについては、以下で詳しく説明します。
• きめ細かな権限を設定し、ユーザーや条件に応じて異なるライトバック権限を付与できます。
  • たとえば、分析担当者には新しい調査の開始を許可し、調査を終了する機能はマネージャーユーザーグループのメンバーに制限できます。

Ontology Manager でアクションを定義する

このセクションでは、Workshop 内でのアクションの使用に焦点を当て、アクション設定の簡単な想定例を示します。アクションの定義に関する詳細は、アクションのドキュメントをご覧ください。

この例は説明用であり、記載されているすべての手順をそのまま実行できるとは限りません。Foundry オントロジーはニーズとデータに合わせてカスタマイズされているため、このチュートリアルを完了するために必要なオントロジーオブジェクトにアクセスできない場合があります。

アクションの管理者は、Ontology Manager でアクションタイプの作成、設定、編集を行えます。アクセスするには、アプリのサイドバーから Ontology Manager を選択します。アクションタイプタブ（以下のスクリーンショットを参照）には既存のアクションタイプの一覧が表示され、選択して表示および編集できます。新規アクションタイプボタンを使用すると、新しいアクションタイプを最初から定義できます。また、基となるオブジェクトタイプから直接アクションタイプを作成することもできます。オブジェクトタイプに移動し、アクションタイプのボックスで新しいアクションタイプを作成するを選択します。

オブジェクトタイプの新しいアクションタイプを作成するボタンを選択して開始します。この例では、既存の Flight オブジェクトの Destination プロパティを変更できる「Modify Flight Destination」アクションを定義します。

作成ウィザードでは、新しいアクションタイプをセットアップするための主要な手順を順に実行できます。表示名を入力し、オブジェクトを変更オプションの下で変更を選択して、アクションタイプを設定します。オブジェクトのドロップダウンから、以前に作成した Flight オブジェクトを選択し、このアクションタイプで変更する Comment プロパティと Destination プロパティを選択します。

アクションタイプ定義の最初のタブは概要と呼ばれ、アクションの API 名（一意の ID）、ユーザー向けの表示名、ユーザー向けの説明、ステータスを定義できます。これらの項目の一部は、前の手順に基づいてすでに入力されています。未入力の項目には、以下のような値を入力します。API名は保存後に編集できないため、慎重に選択することが重要です。

次に、このアクションタイプ定義のルールタブを選択します。ここでは、アクションタイプの中核となるルール、つまり出力や実行内容を設定します。このアクションタイプで操作するオブジェクトタイプと変更の種類を選択すると、変更ルールとして設定されたルールと、追加されたプロパティを確認できます。必要に応じて、ドロップダウンからプロパティを追加できます。

パラメータータブには、アクションタイプのパラメーター、つまり入力が一覧表示されます。パラメーターは、ルールセクションによってすでに自動追加されています。

次に、アクションタイプの基本的な実行条件を設定します。この例では、変更後の目的地に対して、ユーザーが有効な 3 文字の空港コード（EWR など）を入力したことを確認するのが目的です。セキュリティ & 実行条件タブに移動し、実行条件セクションで条件を追加を選択します。この例では、パラメーター条件テンプレートを使用して、Destination プロパティを ^[A-Z]{3}$ のような正規表現と比較します。これにより、目的地パラメーターに入力された値がちょうど 3 文字であることを確認できます。条件を満たさず実行に失敗する可能性がある理由をユーザーに詳しく伝えるには、サイドバーの下部にエラーメッセージを追加します。

新しいアクションタイプをテストするには、パラメータータブに戻り、画面右側のフォームのプレビューを使用します。さまざまな値を入力し、確定ボタンを選択できます。これはアクションを実行できるかどうかをテストするだけで、実際にアクションを実行することはありません。

これで最初のアクションタイプの設定が完了しました。オントロジーに保存する必要があります。画面右上の保存ボタンを選択し、モーダルに表示される変更の一覧を確認してから、さらに 2 回保存を選択して確定します。

最初のアクションタイプが保存されました。Workshop に移動し、このアクションタイプをユーザーが実行できるモジュールを作成します。

Workshop 内でアクションを使用する

Workshop では、ボタングループやインラインアクションウィジェットなど、さまざまなウィジェットを通じてユーザーにアクションを公開できます。以下の例では、フライトの受信トレイモジュールから始め、この Workshop モジュール内のボタングループを通じてアクションをトリガーする方法を説明します。

ボタングループ

Workshop のボタングループウィジェットを使用すると、モジュールの作成者は、モジュールに 1 個以上のボタンを追加できます。この例では、ボタングループを使用して Workshop でアクションを公開する方法に焦点を当てます。

ボタングループでアクションを設定する

Workshop モジュールにボタングループを追加した後、画面上のモジュール内でボタングループを 1 回クリックすると、画面右側にウィジェットの設定パネルが開きます。主要な設定オプションはウィジェットの設定タブにあり、ボタンタイプ、ボタンの設定、表示と書式設定の 3 個のセクションに分かれています。ボタンタイプセクションと表示と書式設定セクションでは、ボタンのレイアウトと詳細な表示オプションを制御します。この例では、ボタンの設定セクションに焦点を当てます。このセクションでは、モジュールの作成者が基本的な表示オプションを設定し、ボタンが選択されたときにアクションをどのように適用するかを決定できます。

上記のボタンの設定セクションでは、テキスト、色、左アイコン、右アイコンのオプションを調整して、ボタンの表示を制御できます。例として、ボタンからトリガーする「Modify Destination」アクションに対して、これらの 4 個のオプションを設定します。

上記の設定により、以下のようなボタンが作成されます。適切なテキスト、色、アイコンを使用してボタンに正確なラベルを付けることで、選択したときに何が起こるのかをユーザーが理解しやすくなります。プリセットの Intent（なし、Primary、成功、警告、危険）を選択するか、16 進数コードなどでカスタムの色を指定できます。

ボタンにラベルを付けたら、クリック時セクションに進み、目的のアクションを接続します。アクションを選択ドロップダウンを選択し、フィルター処理して「Modify Destination」アクションを選択します。すると、以下の画面が表示され、上記の「Modify Destination」アクションの作成時に定義した 3 個のアクションパラメーターがすべて含まれています。

パラメーターのデフォルト値を使用して、アクションパラメーターに任意のデフォルト値を設定します。すべてのパラメーターを一度に設定するには、すべてのパラメーターを追加を選択します。クリアするには、すべてのパラメーターを削除を選択します。各パラメーターは、オブジェクトリスト、オブジェクト参照、Integer、文字列など、アクションタイプ定義の入力に対応します。各パラメーターには、次の 2 個の選択肢があります。

• Workshop モジュール内の変数と同じデフォルト値を設定する
  • これを行うには、Selected Flight パラメーターの「デフォルトなし」の値を選択し、フライトのオブジェクトテーブルが出力する「アクティブなオブジェクト」変数に設定します。設定すると、パラメーターを表示（アクションフォームでユーザーがデフォルト値をさらに変更できます）、非表示（アクションフォームでパラメーターがユーザーにまったく表示されません）、無効（アクションフォームでパラメーターが読み取り専用として表示されます）に設定する追加オプションが表示されます。この例では、デフォルトの表示オプションを保持します。
• デフォルト値を設定しない
  • デフォルト値のないパラメーターは、アクションフォームで最初は空の項目として表示され、ユーザーが値を入力します。
  • この例では、Modified Destination と Comment(s) の項目にデフォルト値を設定しません。

ボタングループからアクションを適用する

ボタングループでアクションを設定した後、ユーザーが Workshop モジュールの Modify Destination ボタンを選択すると、アクションフォームが表示されます。項目のデフォルト値は上記の設定に基づきます。Selected Flight 項目はモジュール変数に基づいて自動入力され、Modified Destination 項目とコメント項目はユーザーが入力できるよう空のままになります。

上記のフォームでは、アクションフォームの左下に 1件の問題が示されています。1件のテキストにカーソルを合わせると、Modified Destination 項目が現在、有効な 3 文字の空港コードではないことが問題であると確認できます。

アクションフォームへの入力が完了し、すべてのパラメーターが検証に合格すると、アクションを実行できます（確定ボタンが利用可能になります）。

確定を選択すると、モジュールの上部に緑色のトースト通知が表示されます。これは、アクションの実行に成功し、入力した変更を反映するように、選択した Flight オブジェクトが更新されたことを示します。

アクションにイベントを連鎖させる

アクションのライフサイクルの特定の時点で Workshop イベントを実行するには、ウィジェット設定の下部で、次のイベントトリガーのいずれかを選択します。

• **アクション送信開始時：**アクションの実行が開始されたときにイベントを実行します。
• **アクション 送信の成功時：**アクションの実行に成功した後にイベントを実行します。

これらのトリガーを使用して、アクションのワークフロー中にデータの更新、別のページへの移動、変数の更新を行えます。

メディアアップローダーウィジェットからアクションをトリガーする

ユーザーがメディアアップローダーウィジェット経由でファイルをアップロードしたときにも、アクションをトリガーできます。これは、処理、情報の拡充、リンクなど、新しくアップロードされたメディアを利用するワークフローに役立ちます。

メディアアップローダーウィジェットは、ウィジェットピッカーで**メディアアップローダー（レガシー）**というラベルで表示され、新しく設定する際にはメディアセットの宛先が非表示になります。メディアセットにアップロードするには、ボタングループを使用してアクションフォームを開くか、インラインアクションウィジェットを使用します。データセットとフォルダーの保存先は引き続き利用可能です。

アップロード時にアクションをトリガーするようメディアアップローダーを設定する際には、特別なファイル識別子の値を使用して、アクションのパラメーター設定でアップロードされたファイルを参照できます。

• データセットへのアップロードでは、ファイル識別子はアップロードされたファイル名です。
• Compass フォルダーへのアップロードでは、ファイル識別子はアップロードされたファイルの RID です。
• メディアセットへのアップロードでは、ファイル識別子はアップロードされたファイルの Media Reference です。

複数ファイルのアップロードが有効な場合、設定されたアクションはアップロードされた各ファイルに対して 1 回ずつトリガーされ、ファイル識別子は処理対象の個々のファイルに対応します。

ボタンの設定、アップロード先、許可されるファイル拡張子、動的なアップロード先、複数ファイルのオプションなどの設定の詳細については、メディアアップローダーウィジェットのドキュメントをご覧ください。