Skip navigation

Here is an exmple that shows how to deploy 'HelloProcess' exmaple ( using JBPM5 console.


How to install and run this example in an appserver (e.g. JBoss or Tomcat)?




1.) This example has one ftl file (HelloTask.ftl) for the human task following the pattern {TaskName}.ftl


2.) Create the image of the bpmn file using 'Export image (PNG)' option.

ScreenHunter_11 Feb. 27 17.31.gif

3.) Create a jar, e.g, 'HelloProcess.jar' file for all the artifacts (HelloProcess.ftl, Hello.ftl and Hello.png).

Alternately these artifacts can also be debloyed in Guvnor as shown in



4.) Copy the HelloProcess.jar to server's CLASSPATH. For example, it can be one of the options as shown below:


Copy the jar file into gwt-console-server war file  ( ..gwt-console-server\WEB-INF\lib)

or Copy the jar file into appserver's lib direcory (JBOSS_HOME\server\default\lib for JBOSS or TOMCAT_HOME\lib for TOMCAT)



5.) Copy the HelloProcess.bpmn file  to the directory where the other bpmn files are located

(specified using the parameter


6.) Start the appserver and login to http://localhttp://localhttp://localhttp://localhost:8080/jbpm-console


You can see the process after starting it.

ScreenHunter_12 Feb. 27 17.36.gif

ScreenHunter_13 Feb. 27 17.36.gif


You can click on the 'Personal Tasks' and approve this task.


ScreenHunter_14 Feb. 27 17.36.gif

Here is an example that shows the required steps to create a HelloWorld example with jBPM5 plug-in in Eclipse.

First install jBPM5 plugin using the steps ( or using the install script  (



A simple example ( is considered here to show the features of jBPM5 eclipse plug-in.

'Hello Task' is created as follows. Attached files (HelloProcess.bpmn, HelloTask.ftl and Hello.ftl) can be imported into the HelloProcess project created in




ScreenHunter_06 Feb. 27 13.24.gif


The user form for the task 'HelloTask' is created using the pattern {TaskName}.ftl as shown below.

ScreenHunter_07 Feb. 27 13.24.gif


The '' is created to read the 'HelloProcess.bpmn' file as shown below (also find the complete file as an attachement below):




public class HelloProcessTest {




public static final void main(String[] args) {
  try {



EntityManagerFactory emf = Persistence.createEntityManagerFactory("org.jbpm.task");
         TaskService taskService  = new TaskService(emf, SystemEventListenerFactory.getSystemEventListener());
          * Add the required users
         TaskServiceSession taskSession = taskService.createSession();  
         taskSession.addUser(new User("Administrator"));
         taskSession.addUser(new User("krisv"));
         /* Start Mina server for HT*/
         MinaTaskServer server = new MinaTaskServer(taskService);
         Thread thread = new Thread(server);
         System.out.println("Server started ...");
         /*Create the knowledge base for HelloProcss.bpmn */
         KnowledgeBase kbase = readKnowledgeBase();
   StatefulKnowledgeSession ksession = createSession(kbase);
   KnowledgeRuntimeLogger logger = KnowledgeRuntimeLoggerFactory.newThreadedFileLogger(ksession, "testlog", 1000);
   ksession.getWorkItemManager().registerWorkItemHandler("Human Task", new WSHumanTaskHandler());


   System.out.println(" started the humantask");






Select the 'Human Task View' using Window->ShowView->Drools Task->Human Task View. Start the program '' and look for  the tasks using the userID 'krisv'. 'Hello Task' can then be selected to perform tasks such as 'Start', 'Complete' etc.

ScreenHunter_08 Feb. 27 14.50.gif

Here are the manual steps to install jBPM5 plug-in and run a sample example in Eclipse.This install is done automatically after running jBPM5 installer ( Following procedure, however, might be useful if you want to understand (or having problems completing the install) the main install steps provided in the automated install script for JBPM5.2. The install instructions for the previous release 5.1 can also be found in the attachment


1.) Download Eclipse Helios:


Unzip this into a directory, say JBPM5


2.) Download Drools and JBPM5 plugin, i.e.,



Unzip this plugin to a temp directory, say TEMP\drools-update-site. Copy 'features' and 'plugins' directories from TEMP\drools-update-site into



It is required to have a runtime dependant libraries that a jBPM5 sample can use.


3.) Download the libraries ( ) from and unzip into a directory, say JBPM5\runtime.


4.) Create a new jBPM sample project in Eclipse and use the runtime libraries downloaded in Step 4.


ScreenHunter_05 Feb. 27 09.42.gif



ScreenHunter_01 Feb. 27 09.19.gif

ScreenHunter_02 Feb. 27 09.19.gif



Select 'Configure Workspace Setting' link below and set it to 'JBPM5\runtime' directory created in Step4.





Update for the version 5.4:


Following two links can be used in Steps 2 and 3 for  JBPM 5.4 plugin and the runtime libraries.


jBPM Plugin: : jbpm-5.2.0.Final-bin.zip

1.) Configure the jBPM console with Tomcat ( and configure the datasource against the Oracle database.


a.) Add transaction and Resource information after 'WatchedResource' line in TOMCAT_HOME/conf/context.xml as shown below.





    <Transaction factory="" />


    <Resource name="jdbc/testDS1" auth="Container" type="javax.sql.DataSource"

               maxActive="15" maxIdle="2" maxWait="10000"


               username="username" password="password"

driverClassName=" oracle.jdbc.OracleDriver"





b.) Create '' in TOMCAT_HOME/conf as shown below.






c.) Create '' in TOMCAT_HOME/conf as shown below.${btm.root}/work/btm1.tlog${btm.root}/work/btm2.tlog${btm.root}/conf/


2.) Copy Oracle driver (e.g. oracle- into into TOMCAT_HOME/lib


3.) Modify hibernate.cfg.xml in TOMCAT_HOME\webapps\gwt-console-server\WEB-INF\classes\META-INF to include Oracle connection details.





<!-- Database connection settings -->

        <property name="connection.driver_class">oracle.jdbc.OracleDriver</property>

        <property name="connection.url">jdbc:oracle:thin:@yourhostname:1521:test</property>

        <property name="connection.username">dbuser</property>

        <property name="connection.password">dbpw</property>

        <!-- JDBC connection pool (use the built-in) -->

        <property name="connection.pool_size">1</property>

        <!-- SQL dialect -->

        <property name="dialect">org.hibernate.dialect.Oracle10gDialect</property>




Following two steps requires repackaging the jar files as the default embedded configuration files use  h2. Also, do not use CR1 jar files as a lot of fixes for Oracle were done after CR1 release. Use latest SNAPSHOT jar files.


4.) Download and copy jbpm-human-task-5.0-SNAPSHOT.jar to TOMCAT_HOME/webapps/gwt-console-server/WEB-INF/lib




5.) Download and copy jbpm-bam-5.0-SNAPSHOT.jar to TOMCAT_HOME/webapps/gwt-console-server/WEB-INF/lib


6.) The BAM reports files (process_summary.rptdesign,overall_activity.rptdesign) need to be modified (using Eclispe BIRT plugin) to inlcude Oracle connection details.


7.) Also the Oracle driver needs to be included from BIRT ReportEngine.

Its location is TOMCAT_HOMEbirt\ReportEngine\plugins\\drivers


Step6 is mainly required as the h2 database connection details are included and these should be replace with your Oracle database information.


Also,it should be noted that the design files do not have the latest table information. One of the columns for the table NodeInstanceLog (DATE has been replaced with LOG_DATE) has been changed  (


Attached please find the example reports. You need to provide the hostname and connection details.


You can not open these design files with the latest BIRT plugin as these reports use 2.3.1.

Download the BIRT designer from and modify the report files process_summary.rptdesign,overall_activity.rptdesign in TOMCAT_HOME/BIRT directory.



Note: It is also required to change the database connection details in jbpm-human-task-5.0.0.jar for the human task if this service is started seperately or embedded as a startup servlet (



      <property name="hibernate.dialect" value="org.hibernate.dialect.Oracle10gDialect"/>

      <property name="hibernate.connection.driver_class" value="oracle.jdbc.OracleDriver"/>

      <property name="hibernate.connection.url" value="jdbc:oracle:thin:@yourOraclehostname:port:dbs" />

      <property name="hibernate.connection.username" value="username"/>

      <property name="hibernate.connection.password" value="password"/>

      <property name="hibernate.connection.autocommit" value="false" />

      <property name="hibernate.max_fetch_depth" value="3"/>

      <property name="" value="create" />

      <property name="hibernate.show_sql" value="false" />


This example shows the use of ftl forms that have variables.



Here is a sample use case.


1.) User 1 (krisv) fills in a form that has three variables (Priority, Model Number, Quantity)

2.) User 2 (john) approves another form if the Qunatity is less than 1000.


This example also has a diverge node that uses a variable (isAvailable) to determine if this order can be approved by user2 or

it needs to be sent back to user1. The variable (isAvailable) is set to true if the quantity is less than 1000.




How to install and run this example in an appserver (e.g. JBoss or Tomcat)?



1.) Copy the SampleHumanTaskFormVariables.bpmn file  to the directory where the other bpmn files are located

(specified using the parameter


2.) Copy the sampleHTFormVariables.jar to server's CLASSPATH. For example, it can be one of the options as shown below:


Copy the jar file into gwt-console-server war file  ( ..gwt-console-server\WEB-INF\lib)

or Copy the jar file into appserver's lib direcory (JBOSS_HOME\server\default\lib for JBOSS or TOMCAT_HOME\lib for TOMCAT)


This jar file basically has a couple of ftl forms for the two users (one for 'krisv' and the other for 'john') and an image file.



Here are the main steps to create this sample:


1.) Create the  bpmn file using jBPM5 Eclispe plugin or any BPMN editor such as Oryx or Koens Aers's BPMN ( editor.


2.) Create the required human task forms using ftl templates using the pattern {TaskName}.ftl.


3.) Create the image of the BPMN, e.g, using 'Export image(PNG)' option.



4.) Package all the ftl template files and the image file into a jar file and copy it to the classpath, i.e.,

gwt-console-server's WEB-INF\lib directory. Alternately you can also use Guvnor to load the artifacts.




Here are the main points to note:


1.) The  name of a template for a  task node should be same as the 'TaskName' property of the task node.

For example, 'TaskName' for the task node 'Sample Order Task' is defined as 'ProcessOder'. So the template for this node is 'ProcessOder.ftl'




2.) All the variables are defined for the bpmn file as shown below.


ScreenHunter_01 Feb. 21 22.18.gif


3.) The task node can have the 'Content' parameter set to Map. If a Map is populated with all the required variables, these variables can be accessed from the ftl templates. Note that 'Content' only allows Map at this time, i.e, not multiple variables.

ScreenHunter_02 Feb. 21 22.24.gif


4.) It can be seen from the following diagram that 'Parameter Mapping', (i.e input to the 'Sample Order Task') can be set to the Map from the previous step. It can also be seen that all the output variables can be set using 'Result Mapping'. It should be noted that these variables are returned as individual parameters, i.e., not as a Map.


ScreenHunter_03 Feb. 21 22.27.gif


5.) The ftl templates can be created using various editors (


ScreenHunter_05 Feb. 21 23.00.gif

Filter Blog

By date:
By tag: