ワークフロー通知テンプレート変数
Liferay 7.3+
一部の変数は、ワークフローの通知コンテキストに自動挿入されます。 これらは、ワークフローの通知テンプレートで使用すると便利です。
通常、Freemarkerでは、変数を明示的に宣言する必要があります。
<#assign variableName = "Variable Name" />
インジェクトされた変数はすでに宣言されており、テンプレート内で直接使用することができます。
${variableName}
これらの変数を使用するには、ワークフローの通知コンテキストで利用可能な変数を知っておく必要があります。 利用できる変数は、ワークフロー定義の詳細やワークフロー内のアセットに応じて変化します。 ここで紹介する方法は、特定のコンテキストに合わせて変数のリストを取得する方法を示していますので、推測で行う必要はありません。
ワークフロー通知テンプレート変数の確認
DEBUGレベルの ロギング を TemplentNotificationMessageGenerator クラスで有効にして、ワークフローの通知コンテキストで利用可能な変数を表示します。
-
［コントロールパネル］ → ［設定］ → ［サーバ管理］へ移動します。
-
［ログレベル］タブをクリックします。
-
この設定でログレベルを追加します。
- ロガー名 ：
com.liferay.portal.workflow.kaleo.runtime.internal.notification.TemplateNotificationMessageGenerator - ログレベル ：
DEBUG
- ロガー名 ：
-
アセット(ブログのエントリなど）に対して、ワークフロー定義(唯一の承認者定義など）を有効にします。
-
テストエントリを送信すると、ログメッセージが表示され、ワークフローで使用可能な通知テンプレートの変数が表示されます。
例えば、唯一の承認者のワークフローでは、アセットの初回提出時にこれらの変数が表示されます。
2020-03-30 14:21:42.089 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] saxReaderUtil (class com.sun.proxy.$Proxy447)
2020-03-30 14:21:42.097 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] getterUtil (class com.liferay.portal.kernel.util.GetterUtil_IW)
2020-03-30 14:21:42.098 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] portalPermission (class com.liferay.portal.service.permission.PortalPermissionImpl)
2020-03-30 14:21:42.098 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] entryClassPK (class java.lang.String)
2020-03-30 14:21:42.098 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] layoutPermission (class com.liferay.portal.service.permission.LayoutPermissionImpl)
2020-03-30 14:21:42.098 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] expandoTableLocalService (class com.sun.proxy.$Proxy43)
2020-03-30 14:21:42.098 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] localeUtil (class com.liferay.portal.kernel.util.LocaleUtil)
2020-03-30 14:21:42.099 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] groupId (class java.lang.String)
2020-03-30 14:21:42.099 DEBUG [liferay/kaleo_graph_walker-2][TemplateNotificationMessageGenerator:94] portalUtil (class com.liferay.portal.util.PortalImpl)
...
上の出力のスニペットを見ると、 saxReaderUtil、getterUtil, portalPermission、entryClassPK、layoutPermission、expandoTableLocalService、localeUtil、groupId、portalUtilは、これらのメッセージがログに出力される原因となったコンテキストで利用可能です。
ワークフロー通知テンプレート変数の使用
コンテクストに注入される通知変数は、主に2つのタイプに分類されます。
- 値 変数は、単一の値を提供します。 変数が単一の値を提供する場合、その値を通知に表示するために使用することができます。また、通知メッセージに表示される他の有用な情報を取得する操作のパラメータとして渡すこともできます。
例： 唯一の承認者の定義では、FreeMarkerのテンプレートでこの通知を提供しています。
${userName} sent you a ${entryType} for review in the workflow.
userNameとentryTypeが値を提供しているので、通知は次のように表示されます。
Joe Bloggsさんから、ワークフローで確認するためのブログのエントリが送られてきました。
また、値型変数の内容を確認することもできます。 唯一の承認者の定義には、この通知テンプレートも含まれています。
Your submission was reviewed<#if taskComments?has_content> and the reviewer applied the following ${taskComments}</#if>.
レビュアがタスクコメントを提供した場合は、そのコメントが表示されます。 そうでない場合は、通知の送付先には以下が表示されます。
あなたの提出物はレビューされました
- オペレーション 変数はLiferay DXPのJavaクラスを公開しているので、通知テンプレートでその操作にアクセスすることができます。 これらの変数については、クラスの Javadoc を熟知するか、 ソースコード を見て、その動作を理解する必要があります。
例： このFreeMarkerは、デフォルトのロケールを使用して、特定のパターン(月/日/年、時間：分）で現在の日付を取得します。
${dateUtil.getCurrentDate("MM/dd/yyyy, HH:mm", localeUtil.getDefault())}`
ワークフロー通知テンプレートの変数について
これらは、ブログエントリの唯一の承認者の定義を有効にして、新しいエントリーを公開用に送信したときに記録される変数です。
| 変数名 | 値 | 操作 | 説明またはリンク |
|---|---|---|---|
${saxReaderUtil} | ✔ | SaxReaderUtil | |
${getterUtil} | ✔ | GetterUtil | |
${portalPermission} | ✔ | PortalPermission | |
${entryClassPK} | ✔ | エントリークラスのプライマリーキー | |
${layoutPermission} | ✔ | LayoutPermission | |
| 1$1 | ✔ | ExpandoTableLocalService | |
${localeUtil} | ✔ | LocaleUtil | |
${groupId} | ✔ | グループのID | |
${portalUtil} | ✔ | PortalUtil | |
${validator} | ✔ | Validator | |
${dateUtil} | ✔ | DateUtil | |
${serviceLocator} | ✔ | ServiceLocator | |
${serviceContext} | ✔ | ServiceContext | |
${jsonFactoryUtil} | ✔ | JSONFactoryUtil | |
${stringUtil} | ✔ | StringUtil | |
${freeMarkerPortletPreferences} | ✔ | TemplatePortletPreferences | |
${dateFormats} | ✔ | FastDateFormatFactory | |
${dateFormatFactory} | ✔ | DateFormatFactory | |
${userPortraitURL} | ✔ | ブログのエントリーにのみ適用され、ユーザーのポートレートのURLを返します。 | |
${portal} | ✔ | Portal | |
${commonPermission} | ✔ | CommonPermission | |
${userURL} | ✔ | ブログエントリーにのみ適用され、ログインしたユーザーのプロフィールページのURLを返します。参照： UserImpl#getDisplayURL . | |
${expandoValueLocalService} | ✔ | ExpandoValueLocalService | |
${entryType} | ✔ | ワークフローのエントリのタイプ（例：Blogs Entry） | |
${organizationPermission} | ✔ | OrganizationPermission | |
${passwordPolicyPermission} | ✔ | PasswordPolicyPermission | |
${expandoColumnLocalService} | ✔ | ExpandoColumnLocalService | |
${taskComments} | ✔ | レビュアが残したコメント（ある場合） | |
${staticFieldGetter} | ✔ | StaticFieldGetter | |
${htmlUtil} | ✔ | HtmlUtil | |
${languageUtil} | ✔ | LanguageUtil | |
${enumUtil} | ✔ | [アクセス列挙型]の beansWrapper.getEnumModels();の結果を返します(https://freemarker.apache.org/docs/pgui_misc_beanwrapper.html#jdk_15_enums) | |
${windowStateFactory} | ✔ | WindowStateFactory | |
${companyId} | ✔ | ポータルのCompany/Virtual InstanceのIDです | |
${unicodeFormatter} | ✔ | UnicodeFormatter | |
${propsUtil} | ✔ | PropsUtil | |
${browserSniffer} | ✔ | BrowserSniffer | |
${portletProviderAction} | ✔ | PortletProvider#Action 呼び出しの結果を返します | |
${taskName} | ✔ | 通知が入っているタスクの名前 | |
${httpUtil} | ✔ | HttpUtil | |
${portletURLFactory} | ✔ | PortletURLFactory | |
${imageToken} | ✔ | WebServerServletToken.getToken(long imageId) ; からの画像トークンは、非推奨になり、削除されます | |
${groupPermission} | ✔ | GroupPermission | |
${timeZoneUtil} | ✔ | TimeZoneUtil | |
${unicodeLanguageUtil} | ✔ | UnicodeLanguageUtil | |
${expandoRowLocalService} | ✔ | ExpandoRowLocalService | |
${auditRouterUtil} | ✔ | AuditRouterUtil | |
${kaleoTaskInstanceToken} | ✔ | ワークフロースクリプトに関してはドキュメントを参照してください | |
${accountPermission} | ✔ | AccountPermission | |
${httpUtilUnsafe} | ✔ | ${httpUtil}のような、 Http のインスタンスは、ローカルネットワークにアクセスするために使用することができます | |
${workflowTaskAssignees} | ✔ | ワークフロースクリプトに関してはドキュメントを参照してください | |
${random} | ✔ | A Java utility for generating Random numbers;を生成するためのJavaユーティリティは、非推奨で将来削除予定です | |
${rolePermission} | ✔ | RolePermission | |
${portletPermission} | ✔ | PortletPermission | |
${paramUtil} | ✔ | ParamUtil | |
${locationPermission} | ✔ | OrganizationPermissionUtil.getOrganizationPermission()の結果を返します | |
${calendarFactory} | ✔ | CalendarFactory | |
${webServerToken} | ✔ | WebServerServletToken.getToken(long imageId) からの画像トークン | |
${sessionClicks} | ✔ | SessionClicks | |
${userPermission} | ✔ | UserPermission | |
${entryClassName} | ✔ | ||
${userGroupPermission} | ✔ | UserGroupPermission | |
${arrayUtil} | ✔ | ArrayUtil | |
${userName} | ✔ | ワークフローに最後に介入したユーザーのユーザー名 | |
${userId} | ✔ | ワークフローに最後に介入したユーザーのユーザーID。 ロジックを理解するには、Workflow Scripting の記事を参照してください。 | |
${prefsPropsUtil} | ✔ | PrefsPropsUtil | |
${url} | ✔ | ページに表示される特定のコンテンツタイプのURL（例：ブログのエントリー、掲示板のメッセージ、およびWikiページ | |
${kaleoInstanceToken} | ✔ | ワークフロースクリプティングの記事をご覧ください。 | |
${utilLocator} | ✔ | UtilLocator | |
${objectUtil} | ✔ | new LiferayObjectConstructor()を返します | |
${urlCodec} | ✔ | URLCodec | |
${portletModeFactory} | ✔ | PortletModeFactory | |
${imageToolUtil} | ✔ | ImageToolUtil | |
${auditMessageFactoryUtil} | ✔ | AuditMessageFactoryUtil | |
${staticUtil} | ✔ | [Accessing static methods]のbeansWrapper.getStaticModels();の結果を返します (https://freemarker.apache.org/docs/pgui_misc_beanwrapper.html#autoid_60) |