« Voltar para 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 Anexos
54778 Visualizações
Média (4 Votos)
A média da avaliação é 3.5 estrelas de 5.
Comentários
Respostas do tópico Autor Data
Here's a velocity example: <actions> ... Kendal Montgomery 11 de Abril de 2011 19:52
thanks kendal, I added that to the wiki article Scott Lee 19 de Abril de 2011 10:55
I've updated the XML config, because the... Lars Meynberg 28 de Julho de 2011 00:28
Sender mail and name in workflowContext isn't... François LE QUEMENER 2 de Agosto de 2011 01:47
It's a little inconvenient that... Jakub Liska 22 de Novembro de 2011 09:28
workflowContext.put(WorkflowConstants.CONTEXT_N... Ivano Carrara 8 de Junho de 2012 10:26
More ... try to read the 6.0.6 javadoc: here:... Ivano Carrara 9 de Junho de 2012 02:37
it would be extremely nice to have a property... Natasa Bulatovic 19 de Julho de 2012 01:43
Hi Guys, I wonder if you guys would know how to... Jing Guo 8 de Novembro de 2012 09:02
Jing, in LR 6.1.1 CE GA2 there is a... Philipp Schwarz 15 de Novembro de 2012 11:37
CORRECTION:... Philipp Schwarz 15 de Novembro de 2012 11:39
Hello All.... I am using liferay version 6.1.1... Pradip A Bhatt 25 de Junho de 2013 05:03
Hi Pradip, you can do this very easily with the... Scott Lee 25 de Junho de 2013 10:01
The above Link... Heri Bender 3 de Junho de 2014 12:46
It's actually still good, but it looks like the... Scott Lee 3 de Junho de 2014 12:57
Funny, all three above links are messed up. All... Heri Bender 3 de Junho de 2014 13:15
This link arrived here messed up again, this... Heri Bender 3 de Junho de 2014 13:19
Ok, I went ahead and added the link to the... Scott Lee 3 de Junho de 2014 14:21
In addition to the above, this code will set... Alex Swain 17 de Março de 2015 01:27

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>
Postado em 11/04/11 19:52.
thanks kendal, I added that to the wiki article
Postado em 19/04/11 10:55 em resposta a Kendal Montgomery.
I've updated the XML config, because the description have to be after name not after execution-type
Postado em 28/07/11 00:28 em resposta a Scott Lee.
Sender mail and name in workflowContext isn't working on Kaleo 6.0.6.1 / Liferay 6.0.11EE
Postado em 02/08/11 01:47 em resposta a 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.
Postado em 22/11/11 09:28 em resposta a 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 ?
Postado em 08/06/12 10:26 em resposta a 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
Postado em 09/06/12 02:37 em resposta a 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.
Postado em 19/07/12 01:43 em resposta a 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?
Postado em 08/11/12 09:02.
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 ...
Postado em 15/11/12 11:37 em resposta a Jing Guo.
CORRECTION: com.liferay.portal.kernel.workflow.WorkflowConstants
Postado em 15/11/12 11:39 em resposta a 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
Postado em 25/06/13 05:03.
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
Postado em 25/06/13 10:01 em resposta a Pradip A Bhatt.
The above Link "http://www.liferay.com/documentation/liferay-portal/6.1/user-guide/-­/ai/creati­ng-process-definitions" is dead.
Postado em 03/06/14 12:46 em resposta a 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
Postado em 03/06/14 12:57 em resposta a 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
Postado em 03/06/14 13:15 em resposta a Scott Lee.
This link arrived here messed up again, this time the "<wbr/>&shy;" is positioned between the "...guide/-/a" and the "i/creating-...."
Postado em 03/06/14 13:19 em resposta a Heri Bender.
Ok, I went ahead and added the link to the bottom of the wiki article under "References", thanks for pointing this out.
Postado em 03/06/14 14:21 em resposta a Heri Bender.
In addition to the above, this code will set the email "from" address and name. Add it to a step before the step which sends the email as a Groovy script:

---------------------------------------------------------------------
impo­rt com.liferay.portal.kernel.workflow.WorkflowInstanceManagerUtil;
import com.liferay.portal.kernel.workflow.WorkflowInstanceManager;
import com.liferay.portal.kernel.workflow.WorkflowInstance;
import com.liferay.portal.service.WorkflowInstanceLinkLocalServiceUtil;
import com.liferay.portal.model.WorkflowInstanceLink;

ServiceContext serviceContext = (ServiceContext) workflowContext.get(WorkflowConstants.CONTEXT_SERVICE_CONTEXT);
//This is in the portal model, not the Workflow package
WorkflowInstanceLink workflowInstanceLink = WorkflowInstanceLinkLocalServiceUtil.getWorkflowInstanceLink(companyId, groupId, className, classPK);
long workflowInstanceId = workflowInstanceLink.getWorkflowInstanceId();

//These classes actually do live in the workflow package
//Workflow instance is 'this' and where the context lives
WorkflowInstanceManager workflowInstanceManager = WorkflowInstanceManagerUtil.getWorkflowInstanceManager();
WorkflowInstance workflowInstance = workflowInstanceManager.getWorkflowInstance(companyId,workflowInstanceId);

//...a­nd the context is where the email from has been set, and will be re-set
workflowContext.put(WorkflowConstants.CONTEXT_NOTIFICATION_SENDER_ADDRESS,­"events@uea.ac.uk");
workflowContext.put(WorkflowConstants.CONTEXT_NOTIFICATION_S­ENDER_NAME,"Website Events Automated Notification");

//..update the instance with the tweaked context
WorkflowInstanceManagerUtil.updateWorkflowContext(companyId, workflowInstanceId, workflowContext);
---------------------------------------------------------------­------

Just means not having to hook classes or change the spring XML. Oh, and you can set different sender addresses for different workflows within your organisation.
Postado em 17/03/15 01:27.