ワークフローモデルは、各種タイプの一連のステップで構成されます。これらのステップを、それぞれのタイプに応じてパラメーターやスクリプトで設定および拡張し、必要な機能とコントロールを実現することができます。
この節では、標準ワークフローのステップについて説明します。
モジュール固有のステップについては、次の資料も参照してください。
各ステップコンポーネントには、 ステップのプロパティ 必要なプロパティを定義および編集できるダイアログ。
大部分のワークフローステップコンポーネントでは、プロパティダイアログの「共通」タブで、次のプロパティを組み合わせて使用できます。
タイトル
ステップのタイトル。
説明
ステップの説明。
ワークフローステージ
適用するドロップダウンセレクター ステージ をステップに追加します。
タイムアウト
ステップが「タイムアウト」するまでの期間です。
オフ、即時、1 時間、6 時間、12 時間、24 時間から選択できます。
タイムアウトハンドラー
ステップがタイムアウトしたときにワークフローを制御するハンドラーです。例:
Auto Advancer
ハンドラー処理の設定
実行後にワークフローを次のステップに自動的に進めるには、このオプションを選択します。選択しない場合、実装スクリプトでワークフローの進行を処理する必要があります。
多くのワークフローステップコンポーネントでは、プロパティダイアログの「ユーザー/グループ」タブで、次のプロパティを使用できます。
電子メールでユーザーに通知します
ユーザー / グループ
AND 分割は、ワークフロー内に分割を作成し、両方のブランチをアクティブにします。必要に応じて、各分岐にワークフローステップを追加できます。このステップを使用して、ワークフローに複数の処理パスを導入できます。例えば、複数のレビューステップを並列で発生させ、時間を節約することができます。
を編集します。 AND 分割 プロパティ:
必要に応じて、各ブランチにワークフローステップを追加します。
A コンテナ ステップは、子ワークフローとして実行される別のワークフローモデルを開始します。
この コンテナ では、ワークフローモデルを再利用して、一般的な一連のステップを実装できます。 例えば、1 つの翻訳ワークフローモデルを複数の編集ワークフローで使用することができます。
このステップを設定するには、次のタブを編集および使用します。
コンテナ
移動ステップを使用すると、ワークフローモデル内で実行する次のステップを ECMAScript の結果に応じて指定できます。
true
:移動ステップが完了すると、ワークフローエンジンが指定のステップを実行します。
false
:移動ステップが完了すると、通常のルーティングロジックが次に実行するステップを決定します。
移動ステップを使用すると、ワークフローモデル内に詳細なルーティング構造を実装できます。例えば、ループを実装するには、 ステップに移動 を定義し、ループ条件を評価するスクリプトを使用して、ワークフロー内の前のステップを実行できます。
このステップを設定するには、次のタブを編集および使用します。
プロセス
「スクリプトのパス」または「スクリプト」のどちらかを指定してください。両方のオプションを同時に使用することはできません。両方のプロパティの値を指定した場合、この手順では スクリプトパス.
ループをシミュレートするには、発生したループの繰り返し回数を記録する必要があります。
例えば、複数の JCR ノードに対してアクションを実行するワークフローを実装するには、ループカウンターをノードのインデックスとして使用できます。回数を保持するには、ワークフローインスタンスのデータマップに integer
値を保存します。回数を増分したり、回数を終了基準と比較するには、移動ステップのスクリプトを使用します。
function check(){
var count=0;
var keyname="loopcount"
try{
if (workflowData.getMetaDataMap().containsKey(keyname)){
log.info("goto script: found loopcount key");
count= parseInt(workflowData.getMetaDataMap().get(keyname))+1;
}
workflowData.getMetaDataMap().put(keyname,count);
}catch(err) {
log.info(err.message);
return false;
}
if (parseInt(count) <7){
return true;
} else {
return false;
}
}
OR 分割は、ワークフロー内に分割を作成し、どちらか 1 つのブランチだけをアクティブにします。これを使用すると、ワークフローに条件付き処理パスを導入できます。必要に応じて、各分岐にワークフローステップを追加できます。
OR 分割の作成について詳しくは、https://helpx.adobe.com/experience-manager/using/aem64_workflow_servlet.html を参照してください。
を編集します。 OR 分割 プロパティ:
共通
ブランチ: x>
ブランチごとに別個のタブがあります。
「スクリプトのパス」または「スクリプト」のどちらかを指定してください。両方のオプションを同時に使用することはできません。両方のプロパティの値を指定した場合、この手順では スクリプトパス.
OR 分割用のルールの定義を参照してください。
必要に応じて、各ブランチにワークフローステップを追加します。
参加者ステップでは、特定のアクションの所有者を割り当てることができます。ワークフローは、ユーザーがそのステップを手動で了承した場合にのみ進行します。ワークフロー上で誰かにアクションを起こさせたい場合、例えばレビューの手順などで使用します。
余談になりますが、アクションを割り当てる際には、ユーザー認証を考慮する必要があります。ユーザーは、ワークフローのペイロードであるページにアクセスする必要があるからです。
このステップを設定するには、次のタブを編集および使用します。
次の場合、ワークフロー開始者には常に通知が送信されます。
一部のプロパティでは、電子メール通知を有効にするように設定する必要があります。電子メールテンプレートをカスタマイズしたり、新しい言語用の電子メールテンプレートを追加することもできます。AEM でメール通知を設定するには、メール通知の設定を参照してください。
ダイアログ参加者ステップは、作業項目を割り当てられたユーザーから情報を収集するために使用します。このステップは、ワークフロー内で後で使用する少量のデータを収集するのに役立ちます。
ステップの完了時、作業項目を完了ダイアログには、ダイアログで定義したフィールドが表示されます。各フィールドで収集されたデータは、ワークフローペイロードのノードに保存されます。後続のワークフローステップは、この値をリポジトリから読み取ることができます。
このステップを設定するには、作業項目を割り当てるユーザーまたはグループ、およびダイアログへのパスを指定します。
このステップを設定するには、次のタブを編集および使用します。
ダイアログ
ダイアログを作成するには:
ウィジェットデータは、ワークフローペイロードまたは作業項目のメタデータに保存できます。widget ノードの name
プロパティの形式によって、データの保存場所が決定されます。
データをペイロードと共に保存
ウィジェットデータをワークフローペイロードのプロパティとして保存するには、ウィジェットノードの name プロパティの値に次の形式を使用します。
./jcr:content/nodename
データは、ペイロードのノードの nodename
プロパティに保存されます。ノードにこのプロパティが含まれていない場合は、プロパティが作成されます。
ペイロードと共に保存した場合は、後で同じペイロードを持つダイアログを使用したときに、プロパティの値が上書きされます。
データを作業項目と共に保存
ウィジェットデータを作業項目のメタデータのプロパティとして保存するには、name プロパティの値に次の形式を使用します。
nodename
データは、作業項目 metadata
の nodename
プロパティに保存されます。この場合は、同じペイロードを持つダイアログを使用しても、データは保存されます。
ダイアログ構造
ダイアログ参加者ステップのダイアログは、コンポーネントのオーサリング用に作成するダイアログと似ています。ダイアログは、次の場所に保存されます。
/apps/myapp/workflow/dialogs
標準のタッチ操作対応 UI 用ダイアログは、次のノード構造を持ちます。
newComponent (cq:Component)
|- cq:dialog (nt:unstructured)
|- content
|- layout
|- items
|- column
|- items
|- component0
|- component1
|- ...
詳しくは、ダイアログの作成と設定を参照してください。
ダイアログパスのプロパティ
ダイアログ参加者手順には、ダイアログパスのプロパティ(および参加者手順のプロパティ)があります。ダイアログパスのプロパティの値は、ダイアログの dialog
ノードへのパスです。
例えば、ダイアログが、ノードに保存されている EmailWatch
というコンポーネントに含まれているとします。
/apps/myapp/workflows/dialogs
タッチ操作対応 UI の場合、ダイアログパスのプロパティには次の値を使用します。
/apps/myapp/workflow/dialogs/EmailWatch/cq:dialog
ダイアログ定義の例
次の XML コードスニペットは、ペイロードコンテンツの String
ノードに watchEmail
値を保存するダイアログを表しています。title ノードは、TextField コンポーネントを表します。
jcr:primaryType="nt:unstructured"
jcr:title="Watcher Email Address Dialog"
sling:resourceType="cq/gui/components/authoring/dialog">
<content jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/foundation/container">
<layout jcr:primaryType="nt:unstructured"
margin="false"
sling:resourceType="granite/ui/components/foundation/layouts/fixedcolumns"
/>
<items jcr:primaryType="nt:unstructured">
<column jcr:primaryType="nt:unstructured"
sling:resourceType="granite/ui/components/foundation/container">
<items jcr:primaryType="nt:unstructured">
<title jcr:primaryType="nt:unstructured"
fieldLabel="Notification Email Address"
name="./jcr:content/watchEmails"
sling:resourceType="granite/ui/components/foundation/form/textfield"
/>
</items>
</column>
</items>
</content>
</cq:dialog>
タッチ操作対応 UI の場合、この例は次のようなダイアログになります。
動的参加者ステップコンポーネントは参加者ステップに似ていますが、参加者が実行時に自動的に選択される点が異なります。
このステップを設定するには、ダイアログと、作業項目を割り当てる参加者を識別する参加者選択を選択します。
このステップを設定するには、次のタブを編集および使用します。
参加者選択
ダイアログ
参加者選択を作成します。そのために、あらゆる選択ロジックまたは選択条件を使用できます。例えば、参加者選択を使用して、(グループ内で)最も作業項目が少ないユーザーを選択できます。任意の数の参加者選択を作成して、ワークフローモデル内の動的参加者ステップコンポーネントの異なるインスタンスで使用できます。
作業項目を割り当てるユーザーを選択する OSGi サービスまたは ECMAScript を作成します。
ECMAScript
スクリプトには、ユーザー ID を String
値として返す、getParticipant という関数を含める必要があります。カスタムスクリプトは、例えば /apps/myapp/workflow/scripts
フォルダーまたはサブフォルダーに格納します。
標準 AEM インスタンスには、次のサンプルスクリプトが付属しています。
/libs/workflow/scripts/initiator-participant-chooser.ecma
/libs
パス内の設定は一切変更しないでください。
/libs
のコンテンツは、インスタンスを次回アップグレードするとき(場合によってはホットフィックスまたは機能パックを適用したとき)に上書きされるからです。
このスクリプトは、ワークフロー開始者を参加者として選択します。
function getParticipant() {
return workItem.getWorkflow().getInitiator();
}
ワークフローイニシエーター参加者選択コンポーネントは、動的参加者手順を拡張し、このスクリプトを手順の実装として使用します。
OSGi サービス
サービスは、com.day.cq.workflow.exec.ParticipantStepChooser インターフェイスを実装する必要があります。このインターフェイスは、次の構成要素を定義します。
SERVICE_PROPERTY_LABEL
フィールド:このフィールドを使用して、参加者選択の名前を指定します。この名前が、動的参加者ステップのプロパティで使用可能な参加者選択のリストに表示されます。getParticipant
メソッド:動的に解決されるプリンシパル ID を String
値として返します。getParticipant
メソッドは、動的に解決されるプリンシパル ID を返します。この ID は、グループ ID またはユーザー ID のいずれかになります。
ただし、グループ ID を使用できるのは、参加者ステップに対してのみです(参加者のリストが返された場合)。動的参加者手順の場合は、空のリストが返されるので、委任のために使用することはできません。
動的参加者ステップコンポーネントに対して実装を使用可能にするには、サービスを書き出す OSGi バンドルに Java クラスを追加し、バンドルを AEM サーバーにデプロイします。
ランダム参加者選択は、ランダムにユーザーを選択するサンプルサービスです(com.day.cq.workflow.impl.process.RandomParticipantChooser
)。この ランダム参加者選択 ステップコンポーネントサンプルは、 動的参加者ステップ では、このサービスをステップの実装として使用します。
次の Java クラスは、ParticipantStepChooser
インターフェイスを実装します。このクラスは、ワークフローを開始した参加者の名前を返します。このコードでは、サンプルスクリプト(initator-participant-chooser.ecma
)と同じロジックを使用しています。
@Property
注釈では、SERVICE_PROPERTY_LABEL
フィールドの値を Workflow Initiator Participant Chooser
に設定します。
package com.adobe.example;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;
import org.osgi.framework.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.adobe.granite.workflow.WorkflowException;
import com.adobe.granite.workflow.WorkflowSession;
import com.adobe.granite.workflow.exec.ParticipantStepChooser;
import com.adobe.granite.workflow.exec.WorkItem;
import com.adobe.granite.workflow.metadata.MetaDataMap;
@Component
@Service
@Properties({
@Property(name = Constants.SERVICE_DESCRIPTION, value = "An example implementation of a dynamic participant chooser."),
@Property(name = ParticipantStepChooser.SERVICE_PROPERTY_LABEL, value = "Workflow Initiator Participant Chooser (service)") })
public class InitiatorParticipantChooser implements ParticipantStepChooser {
private Logger logger = LoggerFactory.getLogger(this.getClass());
public String getParticipant(WorkItem arg0, WorkflowSession arg1,
MetaDataMap arg2) throws WorkflowException {
String initiator = arg0.getWorkflow().getInitiator();
logger.info("Assigning Dynamic Participant Step work item to {}",initiator);
return initiator;
}
}
動的参加者手順プロパティダイアログの参加者選択リストには、このサービスを表す Workflow Initiator Participant Chooser (script)
という項目が含まれています。
「ワークフローモデルが開始されると、ログには、ワークフローを開始し、作業項目を割り当てられたユーザーの ID が示されます。 この例では、admin
ユーザーがワークフローを開始しています。
13.09.2015 15:48:53.037 *INFO* [10.176.129.223 [1347565733037] POST /etc/workflow/instances HTTP/1.1] com.adobe.example.InitiatorParticipantChooser Assigning Dynamic Participant Step work item to admin
フォーム参加者ステップは、作業項目が開かれるとフォームを表示します。ユーザーがフォームに入力して送信すると、フィールドデータがワークフローペイロードのノードに保存されます。
このステップを設定するには、作業項目を割り当てるユーザーまたはグループ、およびフォームへのパスを指定します。
この節では、ページオーサリングの基盤コンポーネントのフォームセクションについて説明します。
このステップを設定するには、次のタブを編集および使用します。
フォーム
通常どおり、フォーム参加者ステップで使用するフォームを作成します。ただし、フォーム参加者ステップ用のフォームには、次の設定が必要です。
フォームの開始コンポーネントでは、アクションタイププロパティが Edit Workflow Controlled Resource(s)
に設定されている必要があります。
フォームの開始コンポーネントには、Form Identifier
プロパティの値が必要です。
フォームコンポーネントでは、エレメント名プロパティを、フィールドデータを保存するノードのパスに設定する必要があります。パスは、ワークフローペイロードのコンテンツ内のノードを指す必要があります。値には次の形式を使用します。
./jcr:content/path_to_node
フォームには、ワークフロー送信ボタンコンポーネントを含める必要があります。このコンポーネントのプロパティは一切設定しないでください。
ワークフローの要件によって、フィールドデータを保存する場所が決定されます。例えば、フィールドデータを使用して、ページコンテンツのプロパティを設定できます。要素名プロパティの次の値は、フィールドデータを jcr:content
ノードの redirectTarget
プロパティの値として保存します。
./jcr:content/redirectTarget
次の例では、フィールドデータはペイロードページのテキストコンポーネントのコンテンツとして使用されています。
./jcr:content/par/text_3/text
「最初の例は、 cq:Page
コンポーネントのレンダリング。 2 番目の例は、ペイロードページに「」という ID を持つテキストtext_3
コンポーネントが含まれる場合にのみ使用できます。
フォームは、リポジトリ内のどこにでも配置できますが、ワークフローユーザーにはフォームを読み取るための権限が必要です。
ランダム参加者選択手順は、生成された作業項目をリストからランダムに選択されたユーザーに割り当てる参加者選択です。
このステップを設定するには、次のタブを編集および使用します。
引数
ワークフローイニシエーター参加者選択ステップは、生成された作業項目を、そのワークフローを開始したユーザーに割り当てる参加者選択です。共通プロパティ以外に、設定するプロパティはありません。
このステップを設定するには、次のタブを使用して編集します。
A 処理ステップ は、ECMAScript を実行するか、OSGi サービスを呼び出して自動処理を実行します。
このステップを設定するには、次のタブを編集および使用します。
プロセス
プロセス:実行するプロセス実装。ドロップダウンメニューを使用して、ECMAScript または OSGi サービスを選択します。参考情報:
ハンドラー処理の設定:実行後にワークフローを次のステップに自動的に進めるには、このオプションを選択します。選択しない場合、実装スクリプトでワークフローの進行を処理する必要があります。
引数:プロセスに渡される引数。