パラメーター

パラメーターは、アクションタイプの入力です。Workshop、Slate、Object View などの Foundry アプリケーションとルールの間のインターフェースとして機能します。パラメーターは、外部の値を格納する変数のように扱われます。各パラメーターはデータ型によって定義され、そのデータ型によって受け取れる値の種類が決まります。パラメーターには、データ型以外にもさまざまな設定項目があります。各パラメーターについて、フォームに表示するかどうか、ユーザーが変更できるかどうかを個別に設定できます。

Value Type でアクションパラメーターを制約することで、Foundry 全体で検証ルールを再利用できます。

パラメーターはアクションタイプ内で値を受け渡します。ルール内で参照してオブジェクト、リンク、または副次的効果に値を渡すことや、実行条件内で参照してアクションを実行できるかどうかを確認することができます。また、アクションによって変更される前のオブジェクトプロパティの現在の値にアクセスしたり、オーバーライド内で参照して後続のパラメーターの設定を変更したりすることもできます。

たとえば、選択したチケットのステータスをユーザーが変更できるアクションタイプでは、パラメーターを Ticket オブジェクトタイプにすることができます。Status パラメーターは文字列として定義されます。アクションを実行するとき、オブジェクトタイプのパラメーターは選択された Ticket オブジェクトの値を受け取り、Status パラメーターには変更後のステータスが格納されます。その後、アクションタイプは両方のパラメーターの値をルールに渡し、ルールを実行してオブジェクトを編集します。

パラメーターはホストアプリケーションから値を受け取ることもできるため、アクションによって変更される前のプロパティ値を取得できます。Workshop の変数として、previous_status は選択された Ticket オブジェクトの Status プロパティの現在の値を受け取ることができます。この値をアクション内の非表示のパラメーター Previous Status に渡し、Status パラメーターには更新後のステータスを格納できます。アクションを実行すると、アクションタイプは Previous Status と Status の両方の値をルールに渡し、ルールを実行してオブジェクトを編集します。