Experience League

Experience Cloud

Document Cloud

プログラムによるワークフローとのやり取り

ワークフローをカスタマイズおよび拡張する際は、以下の方法でワークフローオブジェクトにアクセスできます。

ワークフロー Java API の使用
ECMA スクリプトでのワークフローオブジェクトの取得
ワークフロー REST API の使用

ワークフロー Java API の使用

ワークフロー Java API は、com.adobe.granite.workflow パッケージといくつかのサブパッケージで構成されます。この API の最も重要な構成要素は、com.adobe.granite.workflow.WorkflowSession クラスです。WorkflowSession クラスは、デザイン時と実行時に、次のワークフローオブジェクトへのアクセスを可能にします。

ワークフローモデル
作業項目
ワークフローインスタンス
ワークフローデータ
インボックス項目

このクラスは、ワークフローのライフサイクルに介入するためのメソッドもいくつか提供します。

以下の表に、プログラムによってワークフローとやり取りする際に使用するいくつかの重要な Java オブジェクトの参照ドキュメントへのリンクを示します。以降の例では、コード内でクラスオブジェクトを取得および使用する方法を示します。

機能	オブジェクト
ワークフローへのアクセス	`WorkflowSession`
ワークフローインスタンスの実行とクエリー	`Workflow` `WorkItem` `WorkflowData`
ワークフローモデルの管理	`WorkflowModel` `WorkflowNode` `WorkflowTransition`
ワークフロー内の（またはそれ以外の）ノードの情報	`WorkflowStatus`

ECMA スクリプトでのワークフローオブジェクトの取得

スクリプトの設置で説明したように、AEM は、サーバー側 ECMA スクリプトを実行する ECMA スクリプトエンジンを（Apache Sling を通じて）提供します。org.apache.sling.scripting.core.ScriptHelper クラスは、sling 変数としてスクリプトで直ちに使用できます。

ScriptHelper クラスは、SlingHttpServletRequest へのアクセスを可能にします。これを使用することによって、最終的に WorkflowSession オブジェクトを取得できます。以下に例を示します。

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

ワークフロー REST API の使用

ワークフローコンソールではREST APIが多く使用されています。したがって、このページではワークフローのREST APIについて説明します。

メモ

curlコマンドラインツールを使用すると、ワークフローREST APIを使用してワークフローオブジェクトにアクセスし、インスタンスのライフサイクルを管理できます。このページの例では、curl コマンドラインツールから REST API を使用する方法を示します。

REST APIでは、次のアクションがサポートされています。

ワークフローサービスの開始または停止
ワークフローモデルの作成、更新、削除
ワークフローインスタンスの起動、休止、再開、終了
作業項目の完了、委任

メモ

Web 開発用の Firefox の拡張機能である Firebug を使用すると、コンソールの操作時に HTTP トラフィックを追跡できます。例えば、POST リクエストにより AEM サーバーに送信されたパラメーターと値を確認できます。

このページでは、AEMはポート4502でlocalhost上で動作し、インストールコンテキストは" /" (root)であると想定しています。実際のインストール状況が異なる場合は、HTTP リクエストが適用される URI を実際の状況に合わせて変更してください。

GET リクエストに対応するレンダリングは JSON レンダリングです。GETのURLは.json拡張子が必要です。例：

http://localhost:4502/etc/workflow.json

ワークフローインスタンスの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/etc/workflow/instances

HTTPリクエストメソッド	アクション
`GET`	使用可能なワークフローインスタンスをリストします。
`POST`	新しいワークフローインスタンスを作成します。パラメーターを以下に示します。 - `model`:それぞれのワークフローモデルのID `payloadType`(URI):ペイロードのタイプ(例えば、URL `JCR_PATH` )を含む。ペイロードはパラメーターとして送信され `payload`ます。`201` (`CREATED`)応答が、新しいワークフローインスタンスリソースのURLを含む場所ヘッダーと共に戻されます。

状態によるワークフローインスタンスの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/etc/workflow/instances.{state}

HTTPリクエストメソッド	アクション
`GET`	使用可能なワークフローインスタンスとその状態(`RUNNING`、`SUSPENDED`、`ABORTED`、`COMPLETED`)のリスト

ID によるワークフローインスタンスの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/etc/workflow/instances/{id}

HTTPリクエストメソッド	アクション
`GET`	それぞれのワークフローモデルへのリンクを含むインスタンスデータ（定義とメタデータ）を取得します。
`POST`	インスタンスの状態を変更します。新しい状態は、パラメーター`state`として送信され、次の値のいずれかを持つ必要があります。`RUNNING`、`SUSPENDED`、または`ABORTED`。新しい状態に到達できない場合（終了したインスタンスを休止している場合など）、 `409` (`CONFLICT`)応答がクライアントに戻されます。

ワークフローモデルの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/etc/workflow/models

HTTPリクエストメソッド	アクション
`GET`	使用可能なワークフローモデルを一覧表示します。
`POST`	新しいワークフローモデルを作成します. パラメータ`title`が送信されると、指定したタイトルで新しいモデルが作成されます。 JSONモデル定義をパラメーター`model`としてアタッチすると、指定した定義に従って新しいワークフローモデルが作成されます。応 `201` 答(`CREATED`)が、新しいワークフローモデルリソースのURLを含む場所ヘッダーと共に返送されます。同じことが、というファイルパラメータとしてモデル定義がアタッチされた場合にも起こり `modelfile`ます。との両方の `model` パラメーターの場合、シリアル化形式を定義するに `modelfile` `type` は、という追加のパラメーターが必要です。新しいシリアル化フォーマットは、OSGI API を使用して統合できます。標準の JSON シリアライザーは、ワークフローエンジンに付属しています。そのタイプは JSON です。フォーマットの例は、以下を参照してください。

例：ブラウザーで、http://localhost:4502/etc/workflow/models.jsonに対するリクエストは、次のようなjson応答を生成します。

[
    {"uri":"/var/workflow/models/activationmodel"}
    ,{"uri":"/var/workflow/models/dam/adddamsize"}
    ,{"uri":"/var/workflow/models/cloudconfigs/dtm-reactor/library-download"}
    ,{"uri":"/var/workflow/models/ac-newsletter-workflow-simple"}
    ,{"uri":"/var/workflow/models/dam/dam-create-language-copy"}
    ,{"uri":"/var/workflow/models/dam/dam-create-and-translate-language-copy"}
    ,{"uri":"/var/workflow/models/dam-indesign-proxy"}
    ,{"uri":"/var/workflow/models/dam-xmp-writeback"}
    ,{"uri":"/var/workflow/models/dam-parse-word-documents"}
    ,{"uri":"/var/workflow/models/dam/process_subasset"}
    ,{"uri":"/var/workflow/models/dam/dam_set_last_modified"}
    ,{"uri":"/var/workflow/models/dam/dam-autotag-assets"}
    ,{"uri":"/var/workflow/models/dam/update_asset"}
    ,{"uri":"/var/workflow/models/dam/update_asset_offloading"}
    ,{"uri":"/var/workflow/models/dam/dam-update-language-copy"}
    ,{"uri":"/var/workflow/models/dam/update_from_lightbox"}
    ,{"uri":"/var/workflow/models/cloudservices/DTM_bundle_download"}
    ,{"uri":"/var/workflow/models/dam/dam_download_asset"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-encode-video"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-thumbnail-replacement"}
    ,{"uri":"/var/workflow/models/dam/dynamic-media-video-user-uploaded-thumbnail"}
    ,{"uri":"/var/workflow/models/newsletter_bounce_check"}
    ,{"uri":"/var/workflow/models/projects/photo_shoot_submission"}
    ,{"uri":"/var/workflow/models/projects/product_photo_shoot"}
    ,{"uri":"/var/workflow/models/projects/approval_workflow"}
    ,{"uri":"/var/workflow/models/prototype-01"}
    ,{"uri":"/var/workflow/models/publish_example"}
    ,{"uri":"/var/workflow/models/publish_to_campaign"}
    ,{"uri":"/var/workflow/models/screens/publish_to_author_bin"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_publish_to_youtube"}
    ,{"uri":"/var/workflow/models/projects/request_copy"}
    ,{"uri":"/var/workflow/models/projects/request_email"}
    ,{"uri":"/var/workflow/models/projects/request_landing_page"}
    ,{"uri":"/var/workflow/models/projects/request_launch"}
    ,{"uri":"/var/workflow/models/request_for_activation"}
    ,{"uri":"/var/workflow/models/request_for_deactivation"}
    ,{"uri":"/var/workflow/models/request_for_deletion"}
    ,{"uri":"/var/workflow/models/request_for_deletion_without_deactivation"}
    ,{"uri":"/var/workflow/models/request_to_complete_move_operation"}
    ,{"uri":"/var/workflow/models/reverse_replication"}
    ,{"uri":"/var/workflow/models/salesforce-com-export"}
    ,{"uri":"/var/workflow/models/scene7"}
    ,{"uri":"/var/workflow/models/scheduled_activation"}
    ,{"uri":"/var/workflow/models/scheduled_deactivation"}
    ,{"uri":"/var/workflow/models/screens/screens-update-asset"}
    ,{"uri":"/var/workflow/models/translation"}
    ,{"uri":"/var/workflow/models/s7dam/request_to_remove_from_youtube"}
    ,{"uri":"/var/workflow/models/wcm-translation/create_language_copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/prepare_translation_project"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-i18n-dictionary"}
    ,{"uri":"/var/workflow/models/wcm-translation/sync_translation_job"}
    ,{"uri":"/var/workflow/models/wcm-translation/translate-language-copy"}
    ,{"uri":"/var/workflow/models/wcm-translation/update_language_copy"}
]

特定のワークフローモデルの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502*{uri}*

*{uri}*は、リポジトリ内のモデルノードへのパスです。

HTTPリクエストメソッド	アクション
`GET`	モデルの`HEAD`バージョン（定義とメタデータ）を取得します。
`PUT`	モデルの`HEAD`バージョンを更新します（新しいバージョンを作成します）。モデルの新しいバージョンの完全なモデル定義は、というパラメータとして追加する必要があり `model`ます。また、新しいモデルを作成する際と同様に`type`パラメーターが必要で、値`JSON`. が必要です。
`POST`	PUT の場合と同じ動作です。AEMウィジェットは`PUT`操作をサポートしないので、必要です。
`DELETE`	モデルを削除します。ファイアウォール/プロキシの問題を解決するために、`DELETE`の値を持つ`X-HTTP-Method-Override`ヘッダエントリを含む`POST`も`DELETE`リクエストとして受け入れられます。

例：ブラウザーで、http://localhost:4502/var/workflow/models/publish_example.jsonに対するリクエストは、次のコードに似たjson応答を返します。

{
  "id":"/var/workflow/models/publish_example",
  "title":"Publish Example",
  "version":"1.0",
  "description":"This example shows a simple review and publish process.",
  "metaData": 
  {
    "multiResourceSupport":"true",
    "tags":"wcm,publish"
  },
  "nodes":
  [{
    "id":"node0",
    "type":"START",
    "title":"Start",
    "description":"The start node of the workflow.",
    "metaData":
    {
    }
  },
  {
    "id":"node1",
    "type":"PARTICIPANT",
    "title":"Validate Content",
    "description":"Validate the modified content.",
    "metaData":
    {
      "PARTICIPANT":"admin"
    }
  },
  {
    "id":"node2",
    "type":"PROCESS",
    "title":"Publish Content",
    "description":"Publish the modified content.",
    "metaData":
    {
      "PROCESS_AUTO_ADVANCE":"true",
      "PROCESS":"com.day.cq.wcm.workflow.process.ActivatePageProcess"
    }
  },
  {
    "id":"node3",
    "type":"END",
    "title":"End",
    "description":"The end node of the workflow.",
    "metaData":
    {
    }
  }],
  "transitions":
  [{
    "from":"node0",
    "to":"node1",
    "metaData":
    {
    }
  },
  {
    "from":"node1",
    "to":"node2",
    "metaData":
    {
    }
  },
  {
    "from":"node2",
    "to":"node3",
    "metaData":
    {
    }
  }
]}

バージョンによるワークフローモデルの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/etc/workflow/models/{id}.{version}

HTTPリクエストメソッド	アクション
`GET`	指定されたバージョンのモデルのデータを取得します（存在する場合）。

（ユーザーの）インボックスの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/bin/workflow/inbox

HTTPリクエストメソッド	アクション
`GET`	ユーザーのインボックスにある作業項目を一覧表示します。ユーザーは、HTTP 認証ヘッダーによって識別されます。
`POST`	URIがパラメーター`item`として送信される作業項目を完了し、ステップバックする場合に`route`または`backroute`で定義される次のノードに従うワークフローインスタンスを進めます。パラメーター `delegatee` が送信されると、パラメーターによって識別される作業項目 `item` が、指定した参加者に委任されます。

WorkItem ID による（ユーザーの）インボックスの管理

以下の HTTP リクエストメソッドが、次の URL に適用されます。

http://localhost:4502/bin/workflow/inbox/{id}

HTTPリクエストメソッド	アクション
`GET`	IDで識別されるインボックス`WorkItem`のデータ（定義とメタデータ）を取得します。

例

実行中のすべてのワークフローとその ID のリストを取得する方法

実行中のすべてのワークフローのリストを取得するには、次の URL に対して GET を実行します。

http://localhost:4502/etc/workflow/instances.RUNNING.json

実行中のすべてのワークフローとその ID のリストを取得する方法 - curl を使用した REST

curl を使用した例：

curl -u admin:admin http://localhost:4502/etc/workflow/instances.RUNNING.json

結果に表示されるuriは、他のコマンドでインスタンスidとして使用できます。例：

[
    {"uri":"/etc/workflow/instances/server0/2017-03-08/request_for_activation_1"}
]

メモ

このcurlコマンドは、RUNNINGの代わりに、ワークフローステータスと共に使用できます。

ワークフローのタイトルを変更する方法

ワークフローコンソールの「インスタンス」タブに表示されているワークフローのタイトルを変更するには、次のように POST コマンドを送信します。

を: http://localhost:4502/etc/workflow/instances/{id}
使用するパラメーター：
- action:値は次のとおりです。 UPDATE
- workflowTitle:ワークフローのタイトル

ワークフローのタイトルを変更する方法 - curl を使用した REST

curl を使用した例：

curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/{id}

# for example
curl -u admin:admin -d "action=UPDATE&workflowTitle=myWorkflowTitle" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

すべてのワークフローモデルを一覧表示する方法

使用可能なすべてのワークフローモデルのリストを取得するには、次の URL に対して GET を実行します。

http://localhost:4502/etc/workflow/models.json

すべてのワークフローモデルを一覧表示する方法 - curl を使用した REST

curl を使用した例：

curl -u admin:admin http://localhost:4502/etc/workflow/models.json

メモ

「ワークフローモデルの管理」も参照してください。

WorkflowSession オブジェクトの取得

com.adobe.granite.workflow.WorkflowSessionクラスは、javax.jcr.Sessionオブジェクトまたはorg.apache.sling.api.resource.ResourceResolverオブジェクトから適用できます。

WorkflowSession オブジェクトの取得 - Java

JSP スクリプト（またはサーブレットクラスの Java コード）で、HTTP リクエストオブジェクトを使用して SlingHttpServletRequest オブジェクトを取得します。これにより、ResourceResolver オブジェクトへのアクセスが可能になります。ResourceResolverオブジェクトをWorkflowSessionに適応させます。

<%
%><%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false" 
    import="com.adobe.granite.workflow.WorkflowSession,
  org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
%>

WorkflowSession オブジェクトの取得 - ECMA スクリプト

sling SlingHttpServletRequest 変数を使用して、オブジェクトの取得に使用するオブジェクトを取得します。ResourceResolver ResourceResolverオブジェクトをWorkflowSessionオブジェクトに適合させます。

var wfsession = sling.getRequest().getResource().getResourceResolver().adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);

ワークフローモデルの作成、読み取り、削除

以下の例では、ワークフローモデルにアクセスする方法を説明しています。

Java および ECMA スクリプトコードは、WorkflowSession.createNewModel メソッドを使用します。
curl コマンドは、モデルの URL を使用してモデルに直接アクセスします。

例では以下を実行します。

（ID /var/workflow/models/mymodel/jcr:content/modelの）モデルを作成します。
モデルを削除します。

メモ

モデルを削除すると、モデルのmetaData子ノードのdeletedプロパティがtrueに設定されます。

モデルを削除しても、モデルノードは削除されません。

新しいモデルを作成する場合：

ワークフローモデルエディターでは、モデルが/var/workflow/modelsの下の特定のノード構造を使用する必要があります。モデルの親ノードは、次のプロパティ値を持つcq:Page型のjcr:contentノードでなければなりません。
- sling:resourceType: cq/workflow/components/pages/model
- cq:template: /libs/cq/workflow/templates/model
モデルを作成する際は、まずこの cq:Page ノードを作成し、その jcr:content ノードを model ノードの親として使用する必要があります。
一部のメソッドがモデルを識別するために必要とするid引数は、リポジトリ内のモデルノードの絶対パスです。

/var/workflow/models/<*model_name>*/jcr:content/model

メモ

すべてのワークフローモデルをリストする方法を参照してください。

ワークフローモデルの作成、読み取り、削除 - Java

<%@include file="/libs/foundation/global.jsp"%><%
%><%@page session="false" import="com.adobe.granite.workflow.WorkflowSession,
                 com.adobe.granite.workflow.model.WorkflowModel,
             org.apache.sling.api.SlingHttpServletRequest"%><%

SlingHttpServletRequest slingReq = (SlingHttpServletRequest)request;
WorkflowSession wfSession = slingReq.getResourceResolver().adaptTo(WorkflowSession.class);
/* Create the parent page */
String modelRepo = new String("/var/workflow/models");
String modelTemplate = new String ("/libs/cq/workflow/templates/model");
String modelName = new String("mymodel");
Page modelParent = pageManager.create(modelRepo, modelName, modelTemplate, "My workflow model");

/* create the model */
String modelId = new String(modelParent.getPath()+"/jcr:content/model")
WorkflowModel model = wfSession.createNewModel("Made using Java",modelId);

/* delete the model */
wfSession.deleteModel(modelId);
%>

ワークフローモデルの作成、読み取り、削除 - ECMA スクリプト

var resolver = sling.getRequest().getResource().getResourceResolver();
var wfSession = resolver.adaptTo(Packages.com.adobe.granite.workflow.WorkflowSession);
var pageManager = resolver.adaptTo(Packages.com.day.cq.wcm.api.PageManager);

//create the parent page node
var workflowPage = pageManager.create("/var/workflow/models", "mymodel", "/libs/cq/workflow/templates/model", "Created via ECMA Script");
var modelId = workflowPage.getPath()+ "/jcr:content/model";
//create the model
var model = wfSession.createNewModel("My Model", modelId);
//delete the model
var model = wfSession.deleteModel(modelId);

ワークフローモデルの削除 - curl を使用した REST

# deleting the model by its id
curl -u admin:admin -X DELETE http://localhost:4502/etc/workflow/models/{id}

メモ

必要な詳細のレベルを考慮した結果、curl はモデルの作成や読み取りに使用できないと見なされています。

ワークフローの状態の確認時のシステムワークフローの除外

WorkflowStatus APIを使用して、ノードのワークフローの状態に関する情報を取得できます。

各種メソッドには次のパラメーターがあります。

excludeSystemWorkflows

このパラメーターをtrueに設定して、関連する結果からシステムワークフローを除外する必要があることを示すことができます。

OSGi構成 AdobeGranite Workflow PayloadMapCacheを更新して、システムワークフローと見なすワークフローModelsを指定できます。デフォルト（実行時）のワークフローモデルを以下に示します。

/var/workflow/models/scheduled_activation/jcr:content/model
/var/workflow/models/scheduled_deactivation/jcr:content/model

タイムアウト後に参加者ステップを自動的に進める

事前定義した時間内に終了しなかった参加者ステップを自動的に進める必要がある場合は、以下の手順を実行します。

OSGI イベントリスナーを実装して、タスクの作成と変更をリスンします。
タイムアウト（期限）を指定し、その時点で実行されるようにスケジュールされた sling ジョブを作成します。
タイムアウトになり、ジョブが実行されるときに通知されるジョブハンドラーを作成します。

このハンドラーは、タスクがまだ完了していない場合に、タスクに対して必要なアクションを実行します。

メモ

実行するアクションは、この手法を使用できるよう明確に定義されている必要があります。

ワークフローインスタンスとのやり取り

（プログラムによって）ワークフローインスタンスとやり取りする方法について、以下に基本的な例を示します。

ワークフローインスタンスとのやり取り - Java

// starting a workflow
WorkflowModel model = wfSession.getModel(workflowId);
WorkflowData wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
Workflow[] workflows workflows = wfSession.getAllWorkflows();
Workflow workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

ワークフローインスタンスとのやり取り - ECMA スクリプト

// starting a workflow
var model = wfSession.getModel(workflowId);
var wfData = wfSession.newWorkflowData("JCR_PATH", repoPath);
wfSession.startWorkflow(model, wfData);

// querying and managing a workflow
var workflows = wfSession.getWorkflows(“RUNNING“);
var workflow= wfSession.getWorkflow(id);
wfSession.suspendWorkflow(workflow);
wfSession.resumeWorkflow(workflow);
wfSession.terminateWorkflow(workflow);

ワークフローインスタンスとのやり取り - curl を使用した REST

ワークフローの開始

# starting a workflow
curl -d "model={id}&payloadType={type}&payload={payload}" http://localhost:4502/etc/workflow/instances

# for example:
curl -u admin:admin -d "model=/var/workflow/models/request_for_activation&payloadType=JCR_PATH&payload=/content/we-retail/us/en/products" http://localhost:4502/etc/workflow/instances

インスタンスの一覧表示
```
# listing the instances
curl -u admin:admin http://localhost:4502/etc/workflow/instances.json
```
これにより、すべてのインスタンスが一覧表示されます。以下に例を示します。
```
[
    {"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_1"}
    ,{"uri":"/var/workflow/instances/server0/2018-02-26/prototype-01_2"}
]
```
メモ

特定のステータスのインスタンスを表示するには、実行中のすべてのワークフローのリストをIDと共に取得する方法を参照してください。

ワークフローの休止

# suspending a workflow
curl -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=SUSPENDED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

ワークフローの再開

# resuming a workflow
curl -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=RUNNING" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

ワークフローインスタンスの終了

# terminating a workflow
curl -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/{id}

# for example:
curl -u admin:admin -d "state=ABORTED" http://localhost:4502/etc/workflow/instances/server0/2017-03-08/request_for_activation_1

作業項目とのやり取り

（プログラムによって）作業項目とやり取りする方法について、以下に基本的な例を示します。

作業項目とのやり取り - Java

// querying work items
WorkItem[] workItems = wfSession.getActiveWorkItems();
WorkItem workItem = wfSession.getWorkItem(id);

// getting routes
List<Route> routes = wfSession.getRoutes(workItem);

// delegating
Iterator<Participant> delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

作業項目とのやり取り - ECMA スクリプト

// querying work items
var workItems = wfSession.getActiveWorkItems();
var workItem = wfSession.getWorkItem(id);

// getting routes
var routes = wfSession.getRoutes(workItem);

// delegating
var delegatees = wfSession.getDelegatees(workItem);
wfSession.delegateWorkItem(workItem, delegatees.get(0));

// completing or advancing to the next step
wfSession.complete(workItem, routes.get(0));

作業項目とのやり取り - curl を使用した REST

インボックスの作業項目の一覧表示

# listing the work items
curl -u admin:admin http://localhost:4502/bin/workflow/inbox

現在インボックス内にある作業項目の詳細が一覧表示されます。以下に例を示します。

[{
    "uri_xss": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
    "uri": "/var/workflow/instances/server0/2018-02-26/prototype-01_2/workItems/node2_var_workflow_instances_server0_2018-02-26_prototype-01_2",
    "currentAssignee_xss": "workflow-administrators",
    "currentAssignee": "workflow-administrators",
    "startTime": 1519656289274,
    "payloadType_xss": "JCR_PATH",
    "payloadType": "JCR_PATH",
    "payload_xss": "/content/we-retail/es/es",
    "payload": "/content/we-retail/es/es",
    "comment_xss": "Process resource is null",
    "comment": "Process resource is null",
    "type_xss": "WorkItem",
    "type": "WorkItem"
  },{
    "uri_xss": "configuration/configure_analyticstargeting",
    "uri": "configuration/configure_analyticstargeting",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/securitychecklist",
    "uri": "configuration/securitychecklist",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/enable_collectionofanonymoususagedata",
    "uri": "configuration/enable_collectionofanonymoususagedata",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  },{
    "uri_xss": "configuration/configuressl",
    "uri": "configuration/configuressl",
    "currentAssignee_xss": "administrators",
    "currentAssignee": "administrators",
    "type_xss": "Task",
    "type": "Task"
  }

作業項目の委任

# delegating
curl -d "item={item}&delegatee={delegatee}" http://localhost:4502/bin/workflow/inbox

# for example: 
curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_act_1&delegatee=administrators" http://localhost:4502/bin/workflow/inbox

メモ

delegatee は、ワークフローステップに有効なオプションである必要があります。

作業項目を完了する、または次のステップに進める

# retrieve the list of routes; the results will be similar to {"results":1,"routes":[{"rid":"233123169","label":"End","label_xss":"End"}]}
http://localhost:4502/etc/workflow/instances/<path-to-the-workitem>.routes.json

# completing or advancing to the next step; use the appropriate route ID (rid value) from the above list
curl -d "item={item}&route={route}" http://localhost:4502/bin/workflow/inbox

# for example:
curl -u admin:admin -d "item=/etc/workflow/instances/server0/2017-03-08/request_for_activation_1/workItems/node1_etc_workflow_instances_server0_2017-03-08_request_for_activation_1&route=233123169" http://localhost:4502/bin/workflow/inbox

ワークフローイベントのリスン

OSGi イベントフレームワークを使用して、com.adobe.granite.workflow.event.WorkflowEvent クラスが定義するイベントをリスンします。このクラスは、イベントの対象に関する情報を取得するのに役立ついくつかのメソッドも提供します。例えば、getWorkItem メソッドは、イベントに関与する作業項目の WorkItem オブジェクトを返します。

次のサンプルコードでは、ワークフローイベントをリスンし、イベントのタイプに応じてタスクを実行するサービスを定義しています。

package com.adobe.example.workflow.listeners;

import org.apache.sling.event.jobs.JobProcessor;
import org.apache.sling.event.jobs.JobUtil;

import org.osgi.service.event.Event;
import org.osgi.service.event.EventHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Service;

import com.adobe.granite.workflow.event.WorkflowEvent;
import com.adobe.granite.workflow.exec.WorkItem;

/**
 * The <code>WorkflowEventCatcher</code> class listens to workflow events. 
 */
@Component(metatype=false, immediate=true)
@Service(value=org.osgi.service.event.EventHandler.class)
public class WorkflowEventCatcher implements EventHandler, JobProcessor {

 @Property(value=com.adobe.granite.workflow.event.WorkflowEvent.EVENT_TOPIC)
 static final String EVENT_TOPICS = "event.topics";

 private static final Logger logger = LoggerFactory.getLogger(WorkflowEventCatcher.class);

 public void handleEvent(Event event) {
  JobUtil.processJob(event, this);
 }

 public boolean process(Event event) {
  logger.info("Received event of topic: " + event.getTopic());
  String topic = event.getTopic();

  try {
   if (topic.equals(WorkflowEvent.EVENT_TOPIC)) {
    WorkflowEvent wfevent = (WorkflowEvent)event;
    String eventType = wfevent.getEventType();
    String instanceId = wfevent.getWorkflowInstanceId();

    if (instanceId != null) {
     //workflow instance events
     if (eventType.equals(WorkflowEvent.WORKFLOW_STARTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_RESUMED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_SUSPENDED_EVENT)) {
      // your code comes here...
     } else if (
       eventType.equals(WorkflowEvent.WORKFLOW_ABORTED_EVENT) ||
       eventType.equals(WorkflowEvent.WORKFLOW_COMPLETED_EVENT)) {
      // your code comes here...
     }
     // workflow node event
     if (eventType.equals(WorkflowEvent.NODE_TRANSITION_EVENT)) {
      WorkItem currentItem = (WorkItem) event.getProperty(WorkflowEvent.WORK_ITEM);
      // your code comes here...
     }
    }
   }
  } catch(Exception e){
   logger.debug(e.getMessage());
   e.printStackTrace();
  }
  return true;
 }
}

adobe.com 上のリソース

Content Insights Auto Text Summarization Automated Onboarding Targeted Content Version History Dynamic Forms

このページ

次を表示：

プライバシー（更新済み）

利用規約