ワークフローモデルの作成 creating-workflow-models

CAUTION
AEM 6.4 の拡張サポートは終了し、このドキュメントは更新されなくなりました。 詳細は、 技術サポート期間. サポートされているバージョンを見つける ここ.
CAUTION
クラシック UI の使用については、 AEM 6.3 ドキュメント 参照用。

次の項目を作成します。 ワークフローモデル :ユーザーがワークフローを開始したときに実行される一連の手順を定義します。 ワークフローを一時的なものにするか、複数のリソースを使用するかなど、モデルのプロパティを定義することもできます。

ユーザーがワークフローを開始すると、1 つのインスタンスが開始されます。これは、次の場合に作成される、対応するランタイムモデルです。 同期 変更内容。

新しいワークフローの作成 creating-a-new-workflow

最初に新しいワークフローモデルを作成すると、そのモデルには次の内容が含まれます。

  • フロー開始 ​ステップと​ フロー終了 ​ステップ。

    これらのステップは、ワークフローの始まりと終わりを表します。これらの手順は必須で、編集または削除できません。

  • 手順 1」という名前のサンプルの​ 参加者 ​ステップ。

    このステップは、作業項目をワークフロー開始者に割り当てるように設定されています。このステップを編集または削除し、必要に応じてステップを追加します。

エディターを使用して新しいワークフローを作成するには:

  1. を開きます。 ワークフローモデル コンソール~の方法で ツール, ワークフロー, モデル 例:

    http://localhost:4502/aem/workflow

  2. 作成」を選択してから、「モデルを作成」を選択します。

  3. この ワークフローモデルを追加 ダイアログボックスが表示されます。 次を入力します。 タイトル および 名前 (オプション)を選択する前に 完了.

  4. 新しいモデルが​ ワークフローモデル ​コンソールに表示されます。

  5. 新しいワークフローを選択し、「編集​」をクリックすると、ワークフローが設定のために開かれます

    wf-01

NOTE
(CRX パッケージを使用して)プログラムによってモデルを作成する場合は、次の場所にサブフォルダーを作成することもできます。
/var/workflow/models
例:/var/workflow/models/prototypes
このフォルダーは、 そのフォルダー内のモデルへのアクセスの管理.

ワークフローの編集 editing-a-workflow

既存のワークフローモデルは、次の目的で編集できます。

の編集 デフォルトまたはレガシー (標準)ワークフロー には、 セーフコピー は、変更がおこなわれる前に実行されます。

ワークフローの更新が完了したら、 同期 から ランタイムモデルの生成. 詳しくは、 ワークフローを同期 」を参照してください。

ワークフローの同期 — ランタイムモデルの生成 sync-your-workflow-generate-a-runtime-model

同期 (エディターツールバーの右側)に、 ランタイムモデル. ランタイムモデルは、ユーザーがワークフローを開始したときに実際に使用されるモデルです。 変更内容を​ 同期 ​しない場合は、その変更内容は実行時には反映されません。

ワークフローに変更を加える場合は、 同期 個々のダイアログ(ステップなど)に独自の保存オプションがある場合でも、ランタイムモデルを生成する。

変更がランタイム(保存済み)モデルと同期された場合、 同期済み が代わりに表示されます。

一部のステップには、必須のフィールドが含まれているか、組み込みの検証が含まれています。 これらの条件が満たされない場合、 同期 モデル。 例えば次のように、参加者 ​ステップで参加者が定義されていない場合などです。

wf-21

初めてのデフォルトまたはレガシーワークフローの編集 editing-a-default-or-legacy-workflow-for-the-first-time

を開くと、 デフォルトまたはレガシーモデル (編集用):

  • この 手順 ブラウザーを使用できません(左側)。

  • ツールバーで「編集」操作を利用できます(右側)。

  • 次の理由から、最初はモデルとそのプロパティが読み取り専用モードで開かれます。

    • デフォルトのワークフローは /libs にあります。
    • レガシーワークフローは、 /etc

選択 編集 は次のようになります。

  • ワークフローが /conf にコピーされます。
  • ~を作る 手順 使用可能なブラウザー
  • 変更を加えられるようになります。
NOTE
詳しくは、ワークフローモデルの場所を参照してください。

wf-22

モデルへのステップの追加 adding-a-step-to-a-model

実行するアクティビティを表す手順をモデルに追加する必要があります。各手順は特定のアクティビティを実行します。 標準のAEMインスタンスでは、様々なステップコンポーネントを使用できます。

モデルを編集すると、使用可能なステップが 手順 ブラウザー。 次に例を示します。

wf-10

NOTE
AEMと共にインストールされる主なステップコンポーネントについて詳しくは、 ワークフローステップのリファレンス.

モデルにステップを追加するには:

  1. 既存のワークフローモデルを編集用に開きます。 ワークフローモデル ​コンソールで、必要なモデルを選択し、編集 ​をクリックします。

  2. を開きます。 手順 ブラウザ;using サイドパネルを切り替え(上部のツールバーの左端) ここでは、以下のことができます。

    • フィルター を参照してください。
    • ドロップダウンセレクターを使用して、選択を特定のステップのグループに限定します。
    • 「説明を表示アイコン」 wf-stepinfo-icon を選択して、適切な手順の詳細を確認する。

    wf-02

  3. 適切なステップをモデル内の必要な場所にドラッグします。

    例: 参加者ステップ.

    フローに追加された後は、次の操作を実行できます。 ステップの設定.

    wf-03

  4. 必要に応じて、手順やその他の更新をいくつでも追加します。

    実行時に、ステップはモデルに表示される順序で実行されます。 ステップコンポーネントを追加した後、モデル内の別の場所にドラッグできます。

    既存のステップのコピー、切り取り、貼り付け、グループ化、削除もできます。例えば ページエディター。

    分割ステップは、ツールバーオプション wf-collapseexpand-toolbar-icon を利用して折りたたんだり展開したりできます。

  5. 同期(エディターツールバー)をクリックして変更内容を確認し、ランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

ワークフローステップの設定 configuring-a-workflow-step

以下が可能です。 設定 をクリックし、 ステップのプロパティ ダイアログボックス

  1. 次の手順で ステップのプロパティ ステップのダイアログボックスは、次のいずれかの方法で表示されます。

    • ワークフローモデルのステップをタップし、「 」を選択します。 設定 を選択します。
    • ステップをダブルクリックします。
    note note
    NOTE
    AEMと共にインストールされる主なステップコンポーネントについて詳しくは、 ワークフローステップのリファレンス.
  2. の設定 ステップのプロパティ 必要に応じて使用できるプロパティは、ステップのタイプに応じて異なります。複数のタブを使用することもできます。 例えば、新しいワークフローで Step 1 として表示されるデフォルトの​ 参加者ステップ ​では、次のようになります。

    wf-11

  3. チェックマークをクリックして、アップデート内容を確認します。

  4. 同期(エディターツールバー)をクリックして変更内容を確認し、ランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

一時的なワークフローの作成 creating-a-transient-workflow

次の項目を作成できます。 一時的 新しいモデルを作成する場合、または既存のモデルを編集する場合のワークフローモデル:

  1. 次のワークフローモデルを開く: 編集中.

  2. 選択 ワークフローモデルのプロパティ をクリックします。

  3. ダイアログボックスで、をアクティブにします。 一時的なワークフロー (必要に応じて非アクティブ化):

    wf-07

  4. 保存して閉じる」をクリックし、同期(エディターツールバー)をクリックして変更内容を確認し、ランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

NOTE
ワークフローを一時的モードで実行した場合は、AEM にはワークフロー履歴が保存されません。したがって、そのワークフローに関連する情報は、タイムラインに表示されません。 🔗

タッチ UI でワークフローモデルを使用可能にする make-workflow-models-available-in-touchui

クラシック UI に表示されるワークフローモデルがタッチ UI の​ タイムライン ​レールの選択ポップアップメニューに表示されない場合は、設定に従ってワークフローモデルを使用可能にします。以下の手順は、アクティベーションのリクエスト ​と呼ばれるワークフローモデルの使用を説明します。

  1. 該当するモデルがタッチ対応 UI で使用できないことを確認します。/assets.html/content/dam パスを使用してアセットにアクセスします。アセットを選択します。左側のレールで​ タイムライン ​を開きます。ワークフローを開始 ​をクリックして、アクティベーションのリクエスト モデルがポップアップリストに存在しないことを確認します。

  2. ツール/一般/タグ付け ​と移動します。ワークフロー ​を選択します。

  3. 作成/タグを作成」を選択します。タイトル ​を DAM に、名前 ​を dam に、それぞれ設定します。送信 ​を選択します。
    ワークフローモデルでタグを作成する

  4. ツール/ワークフロー/モデル ​に移動します。アクティベーションのリクエスト ​を選択し、次に​ 編集 ​を選択してください。

  5. 選択 編集 を開き、 ワークフローモデルのプロパティ. 次に移動: 基本 タブをクリックします。

  6. Workflow : DAM を​ タグ ​フィールドに追加します。チェック(チェックマーク)で選択を確認します。

  7. 保存して閉じる ​でタグの追加を確認します。
    モデルのページプロパティの編集

  8. 同期 ​でプロセスを完了します。タッチ操作対応 UI でワークフローを使用できるようになりました。

マルチリソースサポートのためのワークフローの設定 configuring-a-workflow-for-multi-resource-support

次のワークフローモデルを設定できます。 マルチリソースのサポート 新しいモデルを作成する場合、または既存のモデルを編集する場合:

  1. 次のワークフローモデルを開く: 編集中.

  2. 選択 ワークフローモデルのプロパティ をクリックします。

  3. ダイアログボックスで、をアクティブにします。 マルチリソースのサポート (必要に応じて非アクティブ化):

    wf-08

  4. 変更内容を「保存して閉じる」で確認し、「同期」(エディターツールバー)でランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

ワークフローステージの設定(ワークフローの進行状況を表示) configuring-workflow-stages-that-show-workflow-progress

ワークフローステージ タスクを処理する際のワークフローの進行状況を視覚化します。

CAUTION
ワークフローステージが ページプロパティ ​が含まれていますが、どのワークフローステップにも使用されていない場合、進行状況バーには(現在のワークフローステップに関係なく)進行状況は表示されません。

使用可能なステージは、ワークフローモデルで定義されます。既存のワークフローモデルを更新して、ステージ定義を含めることができます。 ワークフローモデルに対して任意の数のステージを定義できます。

定義するには ステージ ワークフローの場合:

  1. 編集するワークフローモデルを開きます。

  2. 選択 ワークフローモデルのプロパティ をクリックします。 次に、 ステージ タブをクリックします。

  3. 必要な​ ステージ ​を追加(および配置)します。ワークフローモデルに対して任意の数のステージを定義できます。

    次に例を示します。

    wf-08-1

  4. クリック 保存して閉じる をクリックしてプロパティを保存します。

  5. ワークフローモデル内の各ステップにステージを割り当てます。 次に例を示します。

    wf-09

    1 つのステージを複数のステップに割り当てることができます。 次に例を示します。

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
    ステップ ステージ
    手順 1 作成
    手順 2 作成
    手順 3 レビュー
    手順 4 承認
    手順 5 承認
    手順 6 完了
  6. 同期」(エディターツールバー)をクリックして変更内容を確定し、ランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

パッケージでのワークフローモデルの書き出し exporting-a-workflow-model-in-a-package

  1. を使用して新しいパッケージを作成します。 パッケージマネージャー:

    1. 次の方法でパッケージマネージャーに移動します。 ツール, 導入, パッケージ.
    2. パッケージを作成」をクリックします。
    3. 次を指定: パッケージ名、および必要に応じてその他の詳細。
    4. OK」をクリックします。
  2. 新しいパッケージのツールバーの「編集」をクリックします。

  3. フィルター」タブを開きます。

  4. フィルターを追加」を選択し、ワークフローモデルの​ 設計 ​のパスを指定します。

    /conf/global/settings/workflow/models/<*your-model-name*>

    完了」をクリックします。

  5. フィルターを追加」を選択し、ランタイムワークフローモデルのパスを指定します​

    /var/workflow/models/<*your-model-name*>

    完了」をクリックします。

  6. モデルで使用されるカスタムスクリプトに対してフィルターを追加します。

  7. クリック 保存 をクリックして、フィルター定義を確認します。

  8. 選択 ビルド をクリックします。

  9. 選択 ダウンロード をクリックします。

ワークフローを使用したフォーム送信の処理 using-workflows-to-process-form-submissions

選択したワークフローで処理されるフォームを設定できます。 ユーザーがフォームを送信すると、フォーム送信のデータをペイロードとして使用した新しいワークフローインスタンスが作成されます。

フォームで使用するワークフローを設定するには、次の手順を実行します。

  1. 新しいページを作成し、編集用に開きます。

  2. を追加します。 フォーム コンポーネントをページに追加します。

  3. の設定 フォーム開始 ページに表示されたコンポーネント

  4. ワークフローを開始」で、使用可能なワークフローの中から目的のワークフローを選択します。

    wf-12

  5. チェックマークを使用して、新しいフォーム設定を確認します。

ワークフローのテスト testing-workflows

ワークフローをテストする際には、様々なペイロードタイプを使用することをお勧めします。開発されたタイプとは異なるタイプを含む。 例えば、ワークフローで Assets を処理する場合は、ページをペイロードとして設定し、エラーがスローされないことを確認して、アセットをテストします。

例えば、次のようにして、新しいワークフローをテストします。

  1. コンソールからワークフローモデルを開始します。

  2. ペイロード ​を定義して確定します。

  3. ワークフローが進行するように、必要に応じてアクションを実行します。

  4. ワークフローの実行中にログファイルを監視します。

また、AEMを デバッグ ログファイル内のメッセージ。 詳しくは、ログを参照してください。開発が完了したら、ログレベル ​を​ 情報 ​に戻します。

examples

例:公開のリクエストを承認/拒否する(単純な)ワークフローの作成 example-creating-a-simple-workflow-to-accept-or-reject-a-request-for-publication

ワークフロー作成の可能性をいくつか示すために、ここでは、Publish Example ワークフローのバリエーションを作成します。

  1. 新しいワークフローモデルを作成.

    新しいワークフローには、次の情報が含まれます。

    • フロー開始
    • Step 1
    • フロー終了
  2. Step 1 を削除します(この例には不適切なステップタイプです)。

    • ステップをクリックし、コンポーネントツールバーの「削除」を選択します。アクションを確認します。
  3. 次の ワークフロー ステップブラウザーの選択、 参加者ステップ をワークフロー上に配置し、次の間に配置します。 フロー開始 および フロー終了.

  4. プロパティダイアログボックスを開くには、次のいずれかを実行します。

    • 参加者ステップをクリックし、コンポーネントツールバーの「設定」を選択します。
    • 参加者ステップをダブルクリックします。
  5. 共通」タブで、「タイトル」と「説明」の両方に Validate Content と入力します。

  6. を開きます。 ユーザー/グループ タブ:

    • 有効化 電子メールでユーザーに通知.
    • ユーザー/グループ」フィールドで「Administratoradmin)」を選択します。
    note note
    NOTE
    E メールを送信する場合は、 メールサービスとユーザーアカウントの詳細を設定する必要があります.
  7. チェックマークを付けて更新を確認します。

    ワークフローモデルの概要に戻ります。ここで、参加者ステップが Validate Content という名前に変更されます。

  8. OR 分岐 ​をワークフローにドラッグして、「Validate Content」と「フロー終了」の間に配置します。

  9. を開きます。 OR 分割 設定用。

  10. 設定:

    • 共通:選択 2 ブランチ
    • ブランチ 1:選択 デフォルトルート.
    • ブランチ 2:確実にする デフォルトルート が選択されていません。
  11. 更新内容を OR 分割.

  12. ドラッグ 参加者ステップ 左側のブランチに対して、プロパティを開き、次の値を指定して、変更を確定します。

    • タイトルReject Publish Request
    • ユーザー/グループprojects-administrators など
    • メールでユーザーに通知する:有効にすると、ユーザーにメールで通知が届きます。
  13. プロセスステップ ​を右側のブランチにドラッグし、プロパティを開き、次の値を指定してから変更内容を確認します。

    • タイトルPublish Page as Requested
    • プロセスActivate Page を選択します。このプロセスは、選択されているページをパブリッシャーインスタンスに公開します。
  14. クリック 同期 (エディターのツールバー)を使用して、ランタイムモデルを生成します。

    詳しくは、 ワークフローを同期 」を参照してください。

    新しいワークフローモデルは次のようになります。

    wf-13

  15. このワークフローをページに適用します。その結果、ユーザーが「コンテンツを検証」ステップの「完了」に移動すると、「リクエストに応じてページを公開」と「公開リクエストを拒否」のどちらを実行するかを選択できます。

    chlimage_1-182

例:OR 分割のルールの定義 example-defining-a-rule-for-an-or-split

OR 分割 ステップを使用すると、ワークフローに条件付き処理パスを導入できます。

OR ルールを定義するには:

  1. 2 つのスクリプトを作成し、リポジトリに保存します。例えば、次の場所です。

    /apps/myapp/workflow/scripts

    note note
    NOTE
    スクリプトには、ブール値を返す関数 check() を含める必要があります。
  2. ワークフローを編集し、 OR 分割 をモデルに追加します。

  3. のプロパティを編集 ブランチ 1OR 分割:

    • 」を true に設定して、これを「デフォルトのルート」として定義します。

    • ルール」として、そのスクリプトへのパスを設定します。次に例を示します。

      /apps/myapp/workflow/scripts/myscript1.ecma

    note note
    NOTE
    必要に応じて、ブランチの順序を切り替えることができます。
  4. OR 分割 ​の​ ブランチ 2 のプロパティを編集します。

    • ルール」として、もう 1 つのスクリプトへのパスを設定します。次に例を示します。

      /apps/myapp/workflow/scripts/myscript2.ecma

  5. 各ブランチ内の個々のステップのプロパティを設定します。「ユーザー/グループ」が設定されていることを確認します。

  6. クリック 同期 (エディターのツールバー)を使用して、ランタイムモデルに対する変更を保持します。

    詳しくは、 ワークフローを同期 」を参照してください。

関数 Check() function-check

NOTE
詳しくは、 ECMAScript の使用.

次のサンプルスクリプトは、ノードが /content/we-retail/us/en の下に位置する JCR_PATH の場合、true を返します。

function check() {
    if (workflowData.getPayloadType() == "JCR_PATH") {
      var path = workflowData.getPayload().toString();
      var node = jcrSession.getItem(path);

      if (node.getPath().indexOf("/content/we-retail/us/en") >= 0) {
       return true;
      } else {
       return false;
      }
     } else {
      return false;
     }
}

例:アクティベーションのカスタマイズリクエスト example-customized-request-for-activation

標準搭載の任意のワークフローをカスタマイズできます。 動作をカスタマイズするには、該当するワークフローの詳細をオーバーレイします。

例: アクティベーションのリクエスト. このワークフローは、 サイト コンテンツ作成者が適切なレプリケーション権限を持っていない場合に、自動的にトリガーされます。 詳しくは、ページオーサリングのカスタマイズ - アクティベーションをリクエストワークフローのカスタマイズを参照してください。

recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e