ワークフロープロセスのリファレンス

AEM には、ワークフローモデルの作成に使用できるプロセスステップがいくつか用意されています。組み込みステップに含まれていないタスクについては、カスタムのプロセスステップを追加することができます(ワークフローモデルの作成を参照)。

プロセスの特徴

プロセスステップごとに特徴を説明します。

Java クラスか ECMA パスか

プロセスステップは、Java クラスまたは ECMAScript によって定義されます。

  • Java クラスのプロセスの場合は、完全修飾クラス名を指定します。
  • ECMAScript プロセスの場合は、スクリプトへのパスを指定します。

ペイロード

ペイロードは、ワークフローインスタンスの処理対象となるエンティティです。ペイロードは、ワークフローインスタンスが開始されるコンテキストによって暗黙的に選択されます。

例えば、ワークフローが AEM ページ「P 」に適用された場合は、ワークフローが進むたびに「P」がステップからステップに引き渡され、各ステップで必要に応じて「P **」に対して何らかの処理がおこなわれます。

最も多いのは、ペイロードがリポジトリ内の JCR ノード(例えば AEM ページまたはアセット)である場合です。JCRノードのペイロードは、JCRパスまたはJCR識別子(UUID)の文字列として渡されます。 ペイロードがJCRプロパティ(JCRパスとして渡される)、URL、バイナリオブジェクト、または汎用のJavaオブジェクトである場合があります。 ペイロードで動作する個々のプロセスステップは、通常、特定のタイプのペイロードを期待するか、ペイロードのタイプに応じて動作が異なります。 以下に説明する各プロセスに対して、予想されるペイロードタイプ(存在する場合)が説明されます。

引数

一部のワークフロープロセスは引数を受け取ります。引数は、ワークフローステップを設定するときに管理者が指定します。

引数は、ワークフローエディターの​プロパティ​ウィンドウの「プロセスの引数」プロパティに単一文字列として入力します。以下に説明する各プロセスに対して、引数文字列の形式を単純なEBNF文法で記述します。 例えば、次のように、引数文字列が1つ以上のカンマ区切りのペアで構成されていることを示します。各ペアは名前(文字列)と値で構成され、重複コロンで区切られています。

    args := name '::' value [',' name '::' value]*
    name := /* A string */
    value := /* A string */

タイムアウト

このタイムアウト期間が経過すると、ワークフローステップは動作しなくなります。タイムアウトを適用するワークフロープロセスもありますが、タイムアウトを適用せず、無視するワークフロープロセスもあります。

権限

WorkflowProcessに渡されたセッションは、ワークフロープロセスサービスのサービスユーザーによって支援されます。このユーザーは、リポジトリのルートに次の権限を持ちます。

  • jcr:read
  • rep:write
  • jcr:versionManagement
  • jcr:lockManagement
  • crx:replicate

WorkflowProcessの実装にその権限セットが十分でない場合は、必要な権限を持つセッションを使用する必要があります。

これをおこなうには、必要な(ただし最小限の)権限のサブセットを持つよう作成されたサービスユーザーを使用する方法が推奨されます。

注意

AEM 6.2 より前のバージョンからアップグレードする場合は、実装の更新が必要になる場合があります。

以前のバージョンでは、管理者セッションが WorkflowProcess 実装に渡されたので、特定の ACL を定義しなくてもリポジトリへのフルアクセスが可能でした。

現在、権限は上述のように定義されています(権限を参照)。実装を更新するために推奨される方法も同様です。

コードの変更を実行できない場合は、短期的な解決方法も後方互換性の目的で利用できます。

  • Webコンソール(/system/console/configMgr)を使用して、AdobeGranite Workflow Configuration Service​を探します

  • Workflow Process Legacy Mode を有効にします。

これにより、管理者セッションを WorkflowProcess 実装に渡すという古い動作に戻り、再びリポジトリ全体に無制限にアクセスできるようになります。

ワークフロー制御プロセス

次のプロセスは、コンテンツに対して何も実行しません。 ワークフロー自体の動作を制御する役割を果たします。

AbsoluteTimeAutoAdvancer (Absolute Time AutoAdvancer)

AbsoluteTimeAutoAdvancer(絶対時刻自動アドバンサー)プロセスは、AutoAdvancer とまったく同じように動作します。例外は、指定された長さの時間が経過した後ではなく、指定された日時にタイムアウトする点です。

  • Java クラス: com.adobe.granite.workflow.console.timeout.autoadvance.AbsoluteTimeAutoAdvancer
  • ペイロード:なし
  • 引数:なし
  • タイムアウト:設定された日時に達すると、プロセスはタイムアウトします。

AutoAdvancer (Auto Advancer)

AutoAdvancer プロセスは、ワークフローを次のステップに自動的に進めます。次に生じる可能性のあるステップが複数ある場合(例えば OR 分岐がある場合)、このプロセスは、デフォルトのルートが指定されているときはそのルートに沿ってワークフローを進め、指定されていないときはワークフローを進めません​**。

  • Java クラス: com.adobe.granite.workflow.console.timeout.autoadvance.AutoAdvancer

  • ペイロード:なし

  • 引数:なし

  • タイムアウト:設定された時間が経過すると、プロセスはタイムアウトします。

ProcessAssembler (プロセスアセンブラ)

ProcessAssembler プロセスは、単一のワークフローステップ内で複数のサブプロセスを順番に実行します。ProcessAssembler を使用するには、ワークフロー内にこのタイプのステップを 1 つ作成し、実行するサブプロセスの名前と引数を示す引数を設定します。

  • Java クラス: com.day.cq.workflow.impl.process.ProcessAssembler

  • ペイロード:DAM アセット、AEM ページ、ペイロードなしのいずれか(サブプロセスの要件によって異なります)。

  • 引数

        args := arg [',' arg]
        arg := processname ['::' processargs]
        processname := /* A fully qualified Java Class or absolute
        repository path to an ECMAScript */
        processargs := processarg [';' processarg]*
        processarg := '[' nobracketprocessarg ']' | nobracketprocessarg
        nobracketprocessarg := listitem [':' listitem]*
        listitem := /* A string */
  • タイムアウト:適用されます。

次に例を示します。

  • アセットからメタデータを抽出します。
  • 指定した3つのサイズの3つのサムネールを作成します。
  • アセットが元々GIFでもPNGでもない(JPEGが作成されない場合)と仮定して、アセットからJPEG画像を作成します。
  • アセットの最終変更日を設定
com.day.cq.dam.core.process.ExtractMetadataProcess,
    com.day.cq.dam.core.process.CreateThumbnailProcess::[140:100];[48:48];[319:319:false],
    com.day.cq.dam.core.process.CreateWebEnabledImageProcess::dimension:1280:1280;mimetype:image/jpeg,
    com.day.cq.dam.core.process.AssetSetLastModifiedProcess

基本プロセス

以下のプロセスは単純なタスクを実行するか、例として機能します。

注意

/libs パス内の設定は​一切​変更しないでください。

これは、次回インスタンスをアップグレードする際に/libsの内容が上書きされるためです(修正プログラムまたは機能パックを適用すると、上書きされる場合があります)。

を削除します。

指定されたパスにある項目が削除されます。

  • ECMAScriptパス: /libs/workflow/scripts/delete.ecma

  • ペイロード:JCRパス

  • 引数:なし

  • タイムアウト:無視

noop

これはヌルプロセスです。処理は実行しませんが、デバッグメッセージをログに記録します。

  • ECMAScriptパス: /libs/workflow/scripts/noop.ecma

  • ペイロード:なし

  • 引数:なし

  • タイムアウト:無視

rule-false

これは、check()メソッドでfalseを返すnullプロセスです。

  • ECMAScriptパス: /libs/workflow/scripts/rule-false.ecma

  • ペイロード:なし

  • 引数:なし

  • タイムアウト:無視

sample

これは、ECMAScript プロセスのサンプルです。

  • ECMAScriptパス: /libs/workflow/scripts/sample.ecma

  • ペイロード:なし

  • 引数:なし

  • タイムアウト:無視

urlcaller

これは、指定されたURLを呼び出す簡単なワークフロープロセスです。 通常、URLは、単純なタスクを実行するJSP(または他のサーブレットに相当する)への参照です。 このプロセスは開発およびデモンストレーションのときにのみ使用し、実稼動環境では使用しないようにする必要があります。引数は、URL、ログイン、パスワードを指定します。

  • ECMAScriptパス: /libs/workflow/scripts/urlcaller.ecma

  • ペイロード:なし

  • 引数

        args := url [',' login ',' password]
        url := /* The URL to be called */
        login := /* The login to access the URL */
        password := /* The password to access the URL */

例:http://localhost:4502/my.jsp, mylogin, mypassword

  • タイムアウト:無視

LockProcess

ワークフローのペイロードをロックします。

  • Java クラス: com.day.cq.workflow.impl.process.LockProcess

  • ペイロード: JCR_PATHおよびJCR_UUID

  • 引数:​なし

  • タイムアウト:​無視されます。

次の状況下では、このステップは無効です。

  • ペイロードは既にロックされています
  • ペイロードノードにjcr:content子ノードが含まれていません

UnlockProcess

ワークフローのペイロードをロック解除します。

  • Java クラス: com.day.cq.workflow.impl.process.UnlockProcess

  • ペイロード: JCR_PATHおよびJCR_UUID

  • 引数:​なし

  • タイムアウト:​無視されます。

次の状況下では、このステップは無効です。

  • ペイロードは既にロック解除されています
  • ペイロードノードにjcr:content子ノードが含まれていません

バージョン管理プロセス

以下のプロセスは、バージョン関連のタスクを実行します。

CreateVersionProcess

ワークフローペイロード(AEM ページまたは DAM アセット)の新しいバージョンを作成します。

  • Java クラス: com.day.cq.wcm.workflow.process.CreateVersionProcess

  • ペイロード:ページまたはDAMアセットを参照するJCRパスまたはUUID

  • 引数:なし

  • タイムアウト:尊敬

このページ