AEM ワークフローの変数 variables-in-aem-workflows

ワークフローモデルの変数は、そのデータタイプに基づいて値を格納する方法です。ワークフローステップで変数の名前を使用して、変数に格納されている値を取得できます。変数名を使用して、ルーティング上の決定を行う式を定義することもできます。

AEM ワークフローモデルでは、次のことができます。

次のビデオでは、AEM ワークフローモデルで変数を作成、設定および使用する方法を示します。

変数は、MetaDataMap インターフェイスの拡張です。ECMAScript で MetaDataMap を使用すると、変数を使用して保存されたメタデータにアクセスできます。

変数の作成 create-a-variable

変数は、ワークフローモデルのサイドキックにある「変数」セクションを使用して作成します。AEM ワークフロー変数は、次のデータタイプをサポートしています。

AEM Forms ワークフローで使用できるその他の複雑なデータタイプについては、AEM Forms ワークフローの変数を参照してください。ArrayList データタイプを使用して、変数コレクションを作成します。すべてのプリミティブデータタイプと複合データタイプに対して ArrayList 変数を作成できます。例えば、ArrayList 変数を作成し、サブタイプとして String を選択して、変数を使用して複数の文字列値を格納します。

変数を作成するには：

変数を作成する場合、次のプラクティスをお勧めします。

変数の設定 set-a-variable

「変数を設定」ステップを使用して、変数の値を設定し、値が設定される順序を定義できます。変数は、変数マッピングが「変数を設定」ステップにリストされている順序で設定されます。

変数値を変更すると、変更が発生したプロセスのインスタンスのみに影響します。例えば、ワークフローが開始され変数データが変更されると、変更はそのワークフローのインスタンスのみに影響します。変更は、以前に開始された、または後で開始されたワークフローの他のインスタンスには影響しません。

変数のデータタイプに応じて、次のオプションを使用して変数の値を設定できます。

また、JSON DOT 表記法または XPATH 表記法を使用して、JSON または XML タイプの変数の特定の要素を更新することもできます。

変数間マッピングの追加 add-mapping-between-variables

変数間マッピングを追加するには、次の手順を実行します。

例 1：XML 変数をクエリして、文字列変数の値を設定 example-query-an-xml-variable-to-set-value-for-a-string-variable

XML ファイルを保存する XML タイプの変数を選択します。XML 変数をクエリして、XML ファイルで使用可能なプロパティの文字列変数の値を設定します。「XML 変数に XPATH を指定」フィールドを使用して、文字列変数に格納するプロパティを定義します。

この例では、formdata XML 変数を選択して cc-app.xml ファイルを格納します。formdata 変数をクエリすることで、cc-app.xml ファイルで使用可能な emailAddress プロパティの値を格納する emailaddress 文字列変数の値を設定できます。

例 2：式を使用して、他の変数に基づいて値を格納 example2

式を使用して変数の和を計算し、結果を変数に格納します。

この例では、式エディターを使用して式を定義し、assetscost 変数と balanceamount 変数の和を計算し、その結果を totalvalue 変数に格納します。

式エディターの使用 use-expression-editor

実行時の変数の値を計算するのにも式を使用します。変数は、式を定義する式エディターを提供します。

式エディターを使用して、次の操作を行います。

これは、次の変更を加えたアダプティブフォームのルールエディターに基づいています。変数のルールエディター：

詳しくは、アダプティブフォームのルールエディターを参照してください。

変数を使用 use-a-variable

変数を使用して、入力と出力を取得したり、ステップの結果を保存したりできます。ワークフローエディターには、次の 2 種類のワークフローステップが用意されています。

変数をサポートするワークフローステップ workflow-steps-with-support-for-variables

移動ステップ、OR‧分割ステップ、およびすべての‧AEM‧Forms‧Workflow‧ステップでは、変数をサポートしています。

OR 分割ステップ or-split-step

OR 分割は、ワークフロー内に分割を作成し、以降は 1 つの分岐だけがアクティブになります。これを使用すると、ワークフローに条件付き処理パスを導入できます。必要に応じて、各分岐にワークフローステップを追加できます。

分岐のルーティング式は、ルール定義、ECMA スクリプト、または外部スクリプトを使用して定義できます。

変数を使用して、式エディターを使用したルーティング式を定義できます。OR 分割ステップでルーティング式を使用する方法について詳しくは、「OR 分割ステップ」を参照してください。

この例では、ルーティング式を定義する前に、例 2を使用して totalvalue 変数の値を設定します。totalvalue 変数の値が 50000 より大きい場合、分岐 1 はアクティブになります。同様に、totalvalue 変数の値が 50000 未満の場合に、Branch 2 をアクティブにするルールを定義できます。

同様に、外部スクリプトパスを選択するか、ルーティング式の ECMA スクリプトを指定して、アクティブな分岐を評価します。「分岐名の変更」を選択して、分岐に別名を指定します。

その他の例については、ワークフローモデルの作成を参照してください。

移動ステップ go-to-step

移動ステップ ​を使用すると、ルーティング式の結果に応じて、ワークフローモデルで次に実行するステップを指定できます。

OR 分割ステップと同様に、ルール定義、ECMA スクリプト、または外部スクリプトを使用して、移動ステップのルーティング式を定義できます。

変数を使用して、式エディターを使用したルーティング式を定義できます。移動ステップでルーティング式を使用する方法について詳しくは、「移動ステップ」を参照してください。

この例では、actiontaken 変数の値が Need more info に等しい場合、移動ステップは次のステップとして「Review Credit Card Application」を指定します。

移動ステップでのルール定義の使用するその他の例については、For ループのシミュレーションを参照してください。

Forms ワークフロー中心のワークフローステップ forms-workflow-centric-workflow-steps

すべての AEM Forms Workflow ステップは、変数をサポートします。詳しくは、OSGi での Forms 中心のワークフローを参照してください。

変数をサポートしないワークフローステップ workflow-steps-without-support-for-variables

MetaDataMap インターフェイスを使用して、変数をサポートしないワークフロー手順の変数にアクセスできます。

変数値の取得 retrieve-the-variable-value

データタイプに基づいて既存の変数の値を取得するには、ECMA スクリプトで次の API を使用します。

AEM Forms ワークフローで使用できる追加の複雑な変数データタイプの API について詳しくは、 AEM Forms ワークフローの変数を参照してください。

例

次の API を使用して、string データタイプの値を取得します。

workItem.getWorkflowData().getMetaDataMap().get(accname, Packages.java.lang.String)

変数値の更新 update-the-variable-value

変数の値を更新するには、ECMA スクリプトで次の API を使用します。

workItem.getWorkflowData().getMetaDataMap().put(variableName, value)

例

workItem.getWorkflowData().getMetaDataMap().put(salary, 50000)

Salary 変数の値を 50000 に更新します。

ワークフローを呼び出す変数の設定 apiinvokeworkflow

API を使用して変数を設定し、それらを渡してワークフローインスタンスを呼び出すことができます。

workflowSession.startWorkflows は、モデル、wfData、metaData を引数として使用します。MetaDataMap を使用して変数の値を設定します。

この API では、 variableName 変数は metaData.put(variableName, value) を使用して value に設定されます。

import com.adobe.granite.workflow.model.WorkflowModel;
import com.adobe.granite.workflow.metadata.MetaDataMap;
import com.adobe.aemfd.docmanager.Document;

/*Assume that you already have a workflowSession and modelId along with the payloadType and payload*/
WorkflowData wfData = workflowSession.newWorkflowData(payloadType, payload);
MetaDataMap metaData = wfData.getMetaDataMap();
metaData.put(variableName, value); //Create a variable "variableName" in your workflow model
WorkflowModel model = workflowSession.getModel(modelId);
workflowSession.startWorkflow(model, wfData, metaData);

変数の編集 edit-a-variable

変数の削除 delete-a-variable

変数を削除する前に、ワークフローから変数のすべての参照を削除します。この変数がワークフローで使用されていないことを確認します。

変数を削除するには：