JBoss.orgCommunity Documentation
This guide will assist you in installing and running a demo setup of the various components of the jBPM project. If you have any feedback on how to improve this guide, if you encounter problems, or if you want to help out, do not hesitate to contact the jBPM community as described in the "What to do if I encounter problems or have questions?" section.
This script assumes you have Java JDK 1.5+ (set as JAVA_HOME), and Ant 1.7+ installed. If you don't, use the following links to download and install them:
First of all, you need to download the installer. There are two versions, a full installer (which already contains a lot of the dependencies that are necessary during the installation) and a minimal installer (which only contains the installer and will download all dependencies). In general, it is probably best to download the full installer: jBPM-{version}-installer-full.zip
You can also find the latest snapshot release here (only minimal installer) here:
https://hudson.jboss.org/jenkins/job/jBPM/lastSuccessfulBuild/artifact/jbpm-distribution/target/
The easiest way to get started is to simply run the installation script to install the demo setup. Simply go into the install folder and run:
ant install.demo
This will:
Guvnor (from version 5.4) requires JBoss EAP 5 to run properly, this only applies if installation is ran in AS5 configuration mode.
This could take a while (REALLY, not kidding, we are downloading an application server and Eclipse installation, even if you downloaded the full installer). The script however always shows which file it is downloading (you could for example check whether it is still downloading by checking the whether the size of the file in question in the jbpm-installer/lib folder is still increasing). If you want to avoid downloading specific components (because you will not be using them or you already have them installed somewhere else), check below for running only specific parts of the demo or directing the installer to an already installed component.
To limit the amount of data that needs to be downloaded, we have disabled the download of the Eclipse BIRT plugin for reporting by default. If you want to try out reporting as well in the jBPM console, make sure to put the jBPM.birt.download property in the build.properties file to true before running the installer.
Once the demo setup has finished, you can start playing with the various components by starting the demo setup:
ant start.demo
This will:
Once everything is started, you can start playing with the Eclipse tooling, Guvnor repository and jBPM console, as explained in the next three sections.
If you do not wish to use Eclipse in the demo setup, you can use the alternative commands:
ant install.demo.noeclipse ant start.demo.noeclipse
The following screencast gives an overview of how to run a simple demo process in Eclipse. It shows you:
Figure 3.1.
Do the following:
You could also create a new project using the jBPM project wizard. This sample project contains a simple HelloWorld BPMN2 process and an associated Java file to start the process. Simply select "File - New - jBPM Project" (if you cannot see that (because you're not in the jBPM perspective) you can do "File - New ... - Project ..." and under the "jBPM" category, select "jBPM project" and click "Next"). Give the project a name and click "Finish". You should see a new project containing a "sample.bpmn" process and a "com.sample.ProcessMain" Java class and a "com.sample.ProcessTest" JUnit test class. You can open the BPMN2 process by double-clicking it. To execute the process, right-click on ProcessMain.java and select "Run As - Java Application". You should see a "Hello World" statement in the output console. To execute the test, right-click on ProcessTest.java and select "Run As - JUnit Test". You should also see a "Hello World" statement in the output console, and the JUnit test completion in the JUnit view.
Open up the process management console:
http://localhost:8080/jbpm-console
Log in, using krisv / krisv as username / password. The following screencast gives an overview of how to manage your process instances. It shows you:
Figure 3.2.
The Guvnor repository can be used as a process repository to store business processes. It also offers a web-based interface to manage your processes. This includes a web-based editor for viewing and editing processes.
Open up Drools Guvnor:
http://localhost:8080/drools-guvnor
Log in (if necessary), using any non-empty username / password (we disabled authentication for demo purposes). The following screencast gives an overview of how to manage your repository. It shows you:
Figure 3.3.
If you want to know more, we recommend you take a look at the rest of the Drools Guvnor documentation.
Once you're done playing:
ant stop.demo
and simply close all the rest.
At the moment, this quickstart does not work with JBoss AS 5. However, an update to the quickstart (and installer) is forthcoming which will fix that (and make it work with JBoss AS 5). [01/2012]
In this quickstart, we are going to:
modify the persistence settings for the process engine
modify the persistence settings for the task server
test the startup with our new settings!
You will need a local instance of a database, in this case MySQL in order to complete this quickstart
First though, let's look at the persistence setup that jBPM uses. In the demo, and in general, there are three types of persistent entities used by jBPM:
“persistent entities” in this context, are java classes that represent information in the database.
For reasons that I'll explain later on in this quickstart, the demo uses two different persistent units:
With other jBPM installations, there's no reason not to use only one persistent unit if you want to.
The first persistence unit needs to use JTA, which is why we also need to define a seperate datasource for that persistence unit as well.
In the MySQL database that I use in this quickstart, I've created two users:
If you end up using different names for your user/schemas, please make a note of where we insert "jbpm5" and "task" in the configuation files.
If you want to try this quickstart with another database, I've included a section at the end of this quickstart that describes what you may need to modify.
The following 4 files define the persistence settings for the jbpm-installer demo:
Do the following:
db/persistence.xml
:
This is the JPA persistence file that defines the persistence settings used by jBPM for both the process engine information and the logging/BAM information. The installer ant script moves this file to the expanded gwt console server war before the server is started.
In this file, you will have to change the name of the hibernate dialect used for your database.
The original line is:
<property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect"/>
In the case of a MySql database, you need to change it to:
<property name="hibernate.dialect" value="org.hibernate.dialect.MySQLDialect"/>
For those of you who decided to use another database, a list of the available hibernate dialect classes can be found here.
task-service/resources/META-INF/persistence.xml
:
The task service (that the installer starts) uses the JPA Persistence settings described in this file.
The original file contains the following lines:
<properties> <property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect"/> <property name="hibernate.connection.driver_class" value="org.h2.Driver"/> <property name="hibernate.connection.url" value="jdbc:h2:tcp://localhost/runtime/task" /> <property name="hibernate.connection.username" value="sa"/> <property name="hibernate.connection.password" value="sasa"/>
Please change these lines so that they look like this:
<properties> <property name="hibernate.dialect" value="org.hibernate.dialect.MySQLDialect"/> <property name="hibernate.connection.driver_class" value="com.mysql.jdbc.Driver"/> <property name="hibernate.connection.url" value="jdbc:mysql://localhost:3306/task" /> <property name="hibernate.connection.username" value="task"/> <property name="hibernate.connection.password" value="task"/>
db/jBPM-ds.xml
:
This step is only neccessary if you're using JBoss AS 5.
This file is the configuration for the (JTA) datasource used by the jBoss AS 5 instance for the process engine persistence. The installer ant script moves this file to the jboss server deploy directory.
The original file contains the following lines:
<datasources> <local-tx-datasource> <jndi-name>jboss/datasources/jbpmDS</jndi-name> <connection-url>jdbc:h2:tcp://localhost/runtime/jbpm-demo</connection-url> <driver-class>org.h2.jdbcx.JdbcDataSource</driver-class> <user-name>sa</user-name> <password></password> </local-tx-datasource> </datasources>
Please change these to the following:
<datasources> <local-tx-datasource> <jndi-name>jboss/datasources/jbpmDS</jndi-name> <connection-url>jdbc:mysql://localhost:3306/jbpm5</connection-url> <driver-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</driver-class> <user-name>jbpm5</user-name> <password>jbpm5</password> </local-tx-datasource> </datasources>
standalone.xml
:
This step is only neccessary if you're using AS 7.
This file is the configuration for the standalone JBoss AS 7 server. When the
installer starts the demo (using jBoss AS 7), it moves this file to the standalone/configuration
directory in the jboss server directory
We need to change the datasource configuration in standalone.xml
so that the (JTA) datasource for the jBPM process engine and logging/BAM points to
our MySQL database
The original file contains the following lines:
<subsystem xmlns="urn:jboss:domain:datasources:1.0"> <datasources> <datasource jndi-name="java:jboss/datasources/jbpmDS" enabled="true" use-java-context="true" pool-name="H2DS"> <connection-url>jdbc:h2:tcp://localhost/runtime/jbpm-demo</connection-url> <driver>h2</driver> <pool></pool> <security> <user-name>sa</user-name> <password></password> </security> </datasource> <drivers> <driver name="h2" module="com.h2database.h2"> <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class> </driver> </drivers> </datasources> </subsystem>
Change the lines to the following:
<subsystem xmlns="urn:jboss:domain:datasources:1.0"> <datasources> <datasource jndi-name="java:jboss/datasources/jbpmDS" pool-name="H2DS" enabled="true" use-java-context="true"> <connection-url>jdbc:mysql://localhost:3306/jbpm5</connection-url> <driver>mysql</driver> <pool></pool> <security> <user-name>jbpm5</user-name> <password>jbpm5</password> </security> </datasource> <drivers> <driver name="mysql" module="com.mysql"> <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class> </driver> </drivers> </datasources> </subsystem>
Start the demo
We've modified all the neccessary files at this point, all that's left to do is run the demo.
Of course, this would be a good time to start your database up as well!
If you haven't installed the demo yet, do that first:
ant install.demo.db
If you have already installed and run the demo, it can't hurt to reinstall the demo:
ant clean.demo; ant install.demo.db
After you've done that, you can finally start the demo using the following command:
ant start.demo.db
If you're done with the demo, you can stop it using this command:
ant stop.demo.db
The stop.demo
ant task will also work, although it might throw some exceptions.
Problems?
If you this isn't working for you, please try the following:
If you decide to use a different database with this demo, you need to remember the following when going through the steps above:
db/drivers
directory. If you're using JBoss AS 5,
the installer ant script will make sure that your downloaded driver is installed
in the server. If you're using JBoss AS 7, see the next step.standalone/deployments
directory.
db.driver.jar.name
property in build.xml
to the name of the downloaded jdbc driver jar you placed in db/drivers
.
For example:
<property name="db.driver.jar.name" value="postgresql-8.4-701.jdbc3.jar" />
<driver>
information in
the <datasource>
section of standalone.xml
so
that it refers to the name of your driver module (see next step). For example:
<driver>postgresql</driver>
standalone.xml
is the
<drivers>
section of the
<datasources>
(note the plural: drivers,
datasources). We need to do the following with this file:
<drivers> <driver name="postgresql" module="org.postgresql"> <xa-datasource-class>org.postgresql.xa.PGXADataSource</xa-datasource-class> </driver> </drivers>
db.driver.module.prefix
property
in build.xml
to the same “value” you used for the module name
in standalone.xml
. In the example above, I used
“org.postgresql
” which means that I should then use
org/postgresql
for the db.driver.module.prefix
property. For example:
<property name="db.driver.module.prefix" value="org/postgresql" />
db/driver_jar_module.xml
file. We need to
db.driver.module.prefix
property above<module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java.jar"/> </resources>Change those lines to look like this, for example:
<module xmlns="urn:jboss:module:1.0" name="org.postgresql"> <resources> <resource-root path="postgresql-8.4-701.jdbc3.jar"/> </resources>
You can always contact the jBPM community for assistance.
Email: jbpm-dev@lists.jboss.org
IRC: #jbpm at irc.codehaus.org
Some common issues are explained below.
Q: What if the installer complains it cannot download component X?
A: Are you connected to the internet? Do you have a firewall turned on? Do you require a proxy? It might be possible that one of the locations we're downloading the components from is temporarly offline. Try downloading the components manually (possibly from alternate locations) and put them in the jbpm-installer/lib folder.
Q: What if the installer complains it cannot extract / unzip a certain jar/war/zip?
A: If your download failed while downloading a component, it is possible that the installer is trying to use an incomplete file. Try deleting the component in question from the jbpm-installer/lib folder and reinstall, so it will be downloaded again.
Q: What if I have been changing my installation (and it no longer works) and I want to start over again with a clean installation?
A: You can use ant clean.demo to remove all the installed components, so you end up with a fresh installation again.
Q: I sometimes see exceptions when trying to stop or restart certain services, what should I do?
A: If you see errors during shutdown, are you sure the services were still running? If you see exceptions during restart, are you sure the service you started earlier was successfully shutdown? Maybe try killing the services manually if necessary.
Q: Something seems to be going wrong when running Eclipse but I have no idea what. What can I do?
A: Always check the consoles for output like error messages or stack traces. You can also check the Eclipse Error Log for exceptions. Try adding an audit logger to your session to figure out what's happening at runtime, or try debugging your application.
Q: Something seems to be going wrong when running the a web-based application like the jbpm-console, Guvnor and the Designer. What can I do?
A: You can check the server log for possible exceptions: jbpm-installer/jboss-as-{version}/standalone/log/server.log (for JBoss AS7) or jbpm-installer/jboss-as-{version}/server/default/log/server.log (for earlier versions).
For all other questions, try contacting the jBPM community as described in the Getting Started chapter.