« Back to Workflow

Workflow Definition

To get started in creating your own workflow definitions, read our portal administration guide here:

Liferay Portal 6.0 - Administration Guide - Workflow with Kaleo

You can view sample workflow definitions in the kaleo-web plugin.

State #

Task - Action (Notifications) #

Email Notifications #

For email notifications, you can specify three template-languages: "text", "velocity" or "freemarker".

You can specify the subject of the email

Email Templates (Text) #

<actions>
	<notification>
		<name>Review Notification</name>
		<description>Email Subject Here</description>
		<execution-type>onAssignment</execution-type>
		<template>Email Body Here.</template>
		<template-language>text</template-language>
		<notification-type>email</notification-type>
	</notification>
</actions>

Email Templates (Velocity & Freemarker) #

You can also generate dynamic emails in your workflow using values in the serviceContext.

Let's say you want to add email notifications in your workflow with dynamic content for the Blogs portlet. First, you will need to stuff any dynamic values that you want in the ServiceContext. Then you will need to read them from your Workflow Definition. Lastly, link the the Resource (eg: BlogsEntry, Wiki Page) to your Workflow Definition so that Resource is now using the Workflow Definition.

1) Add Values Into ServiceContext #

In your BlogsEntryLocalServiceImpl.java, you will find the following code:

WorkflowHandlerRegistryUtil.startWorkflowInstance(
	user.getCompanyId(), groupId, userId, ..., serviceContext);

If you want have dynamic values in your email, you can stuff values into your service/workflow context before calling WorkflowHandlerRegistryUtil.startWorkflowInstance(...., serviceContext):

// You can specify the sender in the workflow context (default sender: "'Liferay Portal Workflow Notifications [no-reply@liferay.com]'")

HashMap<String, Object> workflowContext = new HashMap<String, Object>();

workflowContext.put(
	WorkflowConstants.CONTEXT_NOTIFICATION_SENDER_ADDRESS,
	"no-reply@yourdomain.com");
workflowContext.put(
	WorkflowConstants.CONTEXT_NOTIFICATION_SENDER_NAME,
	"Automated Notification Mailer");

serviceContext.setAttribute("workflowContext", workflowContext);

// You can add additional values which can be used when generating the body of your notification email

HashMap<String, Object> context = new HashMap<String, Object>();

context.put("value1", "[set in XLocalServiceImpl.java]");
context.put("value2", "[set in XLocalServiceImpl.java]");

// Language Keys

HashMap<String, String> language = new HashMap<String, String>();

language.put("langKey1", LanguageUtil.get(Locale.US, "lang-key-1"));
language.put("langKey2", LanguageUtil.get(Locale.US, "lang-key-2"));

context.put("language", language);

serviceContext.setAttribute("context", context);

// Start Workflow

WorkflowHandlerRegistryUtil.startWorkflowInstance(
	user.getCompanyId(), groupId, userId, ..., serviceContext);
2) Read values from the Workflow Definition #

In your Workflow Definition, you can read the values you just added by using velocity or freemarker.

Velocity Example:

<actions>
	<notification>
		<name>Creator Modification Notification</name>
		<description>Email Subject Here</description>
		<execution-type>onAssignment</execution-type>
		<template>
			<![CDATA[
			#set($context = $serviceContext.getAttribute("context"))
			#set($language = $serviceContext.getAttribute("language"))

			<div>${language.langKey1}</div>
			<div>${context.value1}</div>
			]]>
		</template>
		<template-language>velocity</template-language>
		<notification-type>email</notification-type>
	</notification>
</actions>

Freemarker Example:

<actions>
	<notification>
		<name>Creator Modification Notification</name>
		<description>Email Subject Here</description>
		<execution-type>onAssignment</execution-type>
		<template>
                  <![CDATA[
				<#assign context = serviceContext.getAttribute("context")>
				<#assign language = context.language>

				<div>${language.langKey1}</div>
				<div>${context.value1}</div>
			]]>
		</template>
		<template-language>freemarker</template-language>
		<notification-type>email</notification-type>
	</notification>
</actions>
3) Link the the Resource to your Workflow Definition #

Control Panel -> Workflow Configuration -> Link/Assign the respective Resource and Workflow Definition.

Task - Assignment #

Task - Transition #

References #

  1. http://www.liferay.com/community/forums/-/message_boards/message/7897645
  2. https://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-/ai/creating-process-definitions
0 Attachments
30581 Views
Average (4 Votes)
The average rating is 3.5 stars out of 5.
Comments
Threaded Replies Author Date
Here's a velocity example: <actions> ... Kendal Montgomery April 11, 2011 7:52 PM
thanks kendal, I added that to the wiki article Scott Lee April 19, 2011 10:55 AM
I've updated the XML config, because the... Lars Meynberg July 28, 2011 12:28 AM
Sender mail and name in workflowContext isn't... François LE QUEMENER August 2, 2011 1:47 AM
It's a little inconvenient that... Jakub Liska November 22, 2011 9:28 AM
workflowContext.put(WorkflowConstants.CONTEXT_N... Ivano Carrara June 8, 2012 10:26 AM
More ... try to read the 6.0.6 javadoc: here:... Ivano Carrara June 9, 2012 2:37 AM
it would be extremely nice to have a property... Natasa Bulatovic July 19, 2012 1:43 AM
Hi Guys, I wonder if you guys would know how to... Jing Guo November 8, 2012 9:02 AM
Jing, in LR 6.1.1 CE GA2 there is a... Philipp Schwarz November 15, 2012 11:37 AM
CORRECTION:... Philipp Schwarz November 15, 2012 11:39 AM
Hello All.... I am using liferay version 6.1.1... Pradip A Bhatt June 25, 2013 5:03 AM
Hi Pradip, you can do this very easily with the... Scott Lee June 25, 2013 10:01 AM
The above Link... Heri Bender June 3, 2014 12:46 PM
It's actually still good, but it looks like the... Scott Lee June 3, 2014 12:57 PM
Funny, all three above links are messed up. All... Heri Bender June 3, 2014 1:15 PM
This link arrived here messed up again, this... Heri Bender June 3, 2014 1:19 PM
Ok, I went ahead and added the link to the... Scott Lee June 3, 2014 2:21 PM

Here's a velocity example:

<actions>
<notification>
<name>Creator Modification Notification</name>
<execution-type>onAssignment</execution-type>
<descripti­on>Email Subject Here</description>
<template>
<![CDATA[
#set($context = $serviceContext.getAttribute("context"))
#set($language = $serviceContext.getAttribute("language"))

<div>${language.langKey1}</di­v>
<div>${context.value1}</div>
]]>
</template>
<template-lang­uage>velocity</template-language>
<notification-type>email</notification-type>­
</notification>
</actions>
Posted on 4/11/11 7:52 PM.
thanks kendal, I added that to the wiki article
Posted on 4/19/11 10:55 AM in reply to Kendal Montgomery.
I've updated the XML config, because the description have to be after name not after execution-type
Posted on 7/28/11 12:28 AM in reply to Scott Lee.
Sender mail and name in workflowContext isn't working on Kaleo 6.0.6.1 / Liferay 6.0.11EE
Posted on 8/2/11 1:47 AM in reply to Lars Meynberg.
It's a little inconvenient that DLAppHelperLocalServiceImpl.addFileEntry() method doesn't let you pass your custom workFlow context. It always created a new one no matter what.
Posted on 11/22/11 9:28 AM in reply to François LE QUEMENER.
workflowContext.put(WorkflowConstants.CONTEXT_NOTIFICATION_SENDER_ADDRESS, "no-reply@yourdomain.com");
workflowContext.put(WorkflowConstants.CONTEXT_NOTI­FICATION_SENDER_NAME, "Automated Notification Mailer");

The above lines cause errors... the above constants are not defined in 6.0.6

Any comments ?
Posted on 6/8/12 10:26 AM in reply to Jakub Liska.
More ... try to read the 6.0.6 javadoc: here: liferay-portal-doc-6.0.6/javadocs/com/liferay/portal/kernel/workflow/WorkflowCon­stants.html

Of course, if you follow this wiki's article you get the error: CONTEXT_NOTIFICATION_SENDER_ADDRESS cannot be resolved or is not a field
Posted on 6/9/12 2:37 AM in reply to Ivano Carrara.
it would be extremely nice to have a property that can be set-up like in portal-ext.properties or in portlet.properties for kaleo.
Posted on 7/19/12 1:43 AM in reply to Ivano Carrara.
Hi Guys, I wonder if you guys would know how to define a custom notification email subject. I've tested on it, seems only email content could use variables in it. It would be nice to have feature. So any ideas?
Posted on 11/8/12 9:02 AM.
Jing,

in LR 6.1.1 CE GA2 there is a CONTEXT_NOTIFICATION_SUBJECT member defined in com.portal.kernel.workflow.WorkflowConstants class so I gues you would be able to store custom subjects even without extending / implementing your own constants.

However I would'nt know how to read the value from the definition.xml which seems to me like witchcraft anyways ...
Posted on 11/15/12 11:37 AM in reply to Jing Guo.
CORRECTION: com.liferay.portal.kernel.workflow.WorkflowConstants
Posted on 11/15/12 11:39 AM in reply to Philipp Schwarz.
Hello All....

I am using liferay version 6.1.1 CA GA2. I installed and used Kaleo workflow in liferay.
Kaleo provides just accept - reject states.

Now my requirement is like that i have to provide three state
1) Accept
2) Reject
3) Revise or Resubmit

So.. What i have to do??
Many friends suggests me to use JBPM.. I am very new in liferay.. I have no idea that what is JBPM.. but yes... if some one can direct me properly then i can do further.


Please Help me regarding this..
Thankssssssssssss in Advanceeeeeeeeeeee,,,,,,,,,,,

Pradip Bhatt
Posted on 6/25/13 5:03 AM.
Hi Pradip, you can do this very easily with the Kaleo workflow. In fact, all you need to do is 1) add a "Rejected State" to the sample "single-approver-definition.xml" which you can find inside the Kaleo portlet and 2) Add a transition to that new Rejected State.

Here is a very helpful reference for writing Kaleo workflow definitions:
http://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-­/ai/creating-process-definitions
Posted on 6/25/13 10:01 AM in reply to Pradip A Bhatt.
The above Link "http://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-­/ai/creati­ng-process-definitions" is dead.
Posted on 6/3/14 12:46 PM in reply to Scott Lee.
It's actually still good, but it looks like the URL encoding might have gotten messed up, try this: https://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-/ai/creatin­g-process-definitions
Posted on 6/3/14 12:57 PM in reply to Heri Bender.
Funny, all three above links are messed up. All have somewhere a "<wbr/>&shy;" in the html source code, but all at different locations. You see this if you copy it and paste it in a text editor (or a browser's address field), where it is rendered as a "-". Who enters this "<wbr/>&shy;"? I try to paste here another - hopefully correct - version, directly copied from text editor:
http://www.liferay.com/de/documentation/liferay-portal/6.1/user-guide/-/a­i/creating-process-definitions
Posted on 6/3/14 1:15 PM in reply to Scott Lee.
This link arrived here messed up again, this time the "<wbr/>&shy;" is positioned between the "...guide/-/a" and the "i/creating-...."
Posted on 6/3/14 1:19 PM in reply to Heri Bender.
Ok, I went ahead and added the link to the bottom of the wiki article under "References", thanks for pointing this out.
Posted on 6/3/14 2:21 PM in reply to Heri Bender.