フィードバックを送信
Developer Guide
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

ワークフローコンテクストの利用

Liferay のワークフロー は承認プロセスとして使用されます。 プロセスの各ステップにおいて、ワークフローは、 Map<String, Serializable> オブジェクトで利用可能な特定のデータを持っており、スクリプトやカスタムコードでは workflowContextとして参照されます。 ワークフローコンテキスト情報は、Liferayのワークフローエンジンが正しく機能するために重要です。 これを理解することで、カスタムコードやワークフロースクリプトでどのように使用するのが最適かを判断することができます。

例えば、ワークフローのコンテキストでは、以下のことができます。

注

ServiceContext を使用して、 workflowContext が使用できないコンテキストで属性を設定します。 たとえば、カスタム コードが BlogsEntryLocalService#addEntryを呼び出す場合、それに ServiceContext オブジェクトを提供する必要があります。 ServiceContext#setAttribute を使用して、ワークフローでアクセスするデータを渡すことができます。 workflowContextを扱う際には、いくつかの注意点があります。

  • 修正可能でなければならないので、スレッドセーフではありません。 並列実行のコンテクストでは注意が必要です。

    例えば、フォークノードを持つワークフローにおいて、ワークフローの両方のフォークで workflowContext を更新することは推奨されません。

  • その最初の型のパラメータ（属性の キー ）は、Stringです。 これは、2番目の属性に格納されている値を検索するために使用されます。

  • その2番目の型パラメータ（各属性の 値 ）は、データベースに保存されているため、 Serializable となっています。 これにより、ワークフローのすべてのステップでアクセスできるようになります。

重要

DXP 2024.Q3 以降、スクリプトはデフォルトで無効になっています。 システム設定 → スクリプト管理 (セキュリティ カテゴリ) で有効にできます。

任意のワークフローノードのワークフローコンテキストキーと値を印刷するには、次のようなスクリプトアクションを追加します。

<actions>
   <action>
      <name>print-workflow-context</name>
      <script>
         <![CDATA[
         for (Map.Entry<String, Serializable> mapEntry :
               workflowContext.entrySet()) {
                  out.println(mapEntry.getKey(), mapEntry.getValue());
         }
         ]]>
      </script>
      <script-language>groovy</script-language>
      <execution-type>onEntry</execution-type>
   </action>
</actions>

ノードが入力されると、ログに出力されます。

entryType, Blogs Entry
companyId, 37401
entryClassPK, 40226
entryClassName, com.liferay.blogs.model.BlogsEntry
groupId, 37441
taskComments,
userPortraitURL, /image/user_portrait?img_id=0&img_id_token=IpLU58ogLTDf%2FDIfo8Ukg0YxiUE%3D&t=1626283728181
serviceContext, com.liferay.portal.kernel.service.ServiceContext@565b5550
userId, 37448
url, http://localhost:8080/group/guest/~/control_panel/manage?p_p_id=com_liferay_blogs_web_portlet_BlogsAdminPortlet&p_p_lifecycle=0&p_p_state=maximized&_com_liferay_blogs_web_portlet_BlogsAdminPortlet_mvcRenderCommandName=%2Fblogs%2Fview_entry&_com_liferay_blogs_web_portlet_BlogsAdminPortlet_entryId=40226&p_p_auth=rRDR0ncV
userURL, http://localhost:8080/web/test

ワークフロー定義のワークフローコンテキスト属性へのアクセス

workflowContext 属性に <script>からアクセスするには、 Map#get メソッドを使用して取得します。

import com.liferay.portal.kernel.workflow.WorkflowConstants;

String className = (String)workflowContext.get(WorkflowConstants.CONTEXT_ENTRY_CLASS_NAME);

上記の例では String を取得していますが、workflowContext の属性の中には、long として使用しなければならないものがあります（例えば、メソッドのパラメータとして渡される場合など）。 これには、 GetterUtil ユーティリティクラスが役立ちます。

import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;

long classPK = GetterUtil.getLong((String)workflowContext.get(WorkflowConstants.CONTEXT_ENTRY_CLASS_PK));

WorkflowConstants オブジェクト フィールドを使用すると、エラーが発生しやすい文字列リテラルを回避するのに役立ちます。 workflowContext フィールドの前には、すべて CONTEXT が付けられます（例： CONTEXT_COMPANY_ID）。

ワークフロー定義でのワークフローコンテキスト属性の設定

workflowContextに属性を設定する場合は、 Map#put 方式を使用します。 この例では、 assetTitleを設定しています。

import com.liferay.asset.kernel.model.AssetRenderer;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.portal.kernel.workflow.WorkflowHandler;
import com.liferay.portal.kernel.workflow.WorkflowHandlerRegistryUtil;

String className = (String)workflowContext.get(WorkflowConstants.CONTEXT_ENTRY_CLASS_NAME);

WorkflowHandler workflowHandler = WorkflowHandlerRegistryUtil.getWorkflowHandler(className);

long classPK = GetterUtil.getLong((String)workflowContext.get(WorkflowConstants.CONTEXT_ENTRY_CLASS_PK));

AssetRenderer assetRenderer = workflowHandler.getAssetRenderer(classPK);

String assetTitle = assetRenderer.getAssetObject().getTitle();

workflowContext.put("assetTitle", assetTitle);
ヒント

上記のコードは、アセットに getTitle メソッド (例: JournalArticle) がある場合にのみ機能します。

ワークフロー定義でアクセス用のサービスコンテキスト属性を設定する

カスタムのJavaコードで、ワークフロー定義に情報を渡す必要がありますが、workflowContextがない場合があります。 たとえば、ブログエントリを追加するコードを記述している場合は、 BlogsEntryLocalService#addEntry メソッドのいずれかを呼び出すことができます。 workflowContextはこれらのメソッドのパラメータではありませんが、ServiceContextはパラメータです。 サービスコンテキストに新しい属性を追加します。

serviceContext.setAttribute("customAttributeKey", "customAttributeValue");

ワークフロー定義内の属性を取得するには、 ServiceContext を、 workflowContextから取得し、そのキーを使って属性を取得します。

import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.workflow.WorkflowConstants;

ServiceContext serviceContext = (ServiceContext)workflowContext.get(WorkflowConstants.CONTEXT_SERVICE_CONTEXT);

serviceContext.getAttribute("customAttributeKey");
Capability:
Platform
Resource Type:
Official Documentation
Feature:
Workflow
Deployment Approach:
Liferay PaaS
Liferay Self-Hosted