Deploying the application into JBoss

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Bizagi server configuration > Bizagi Engine JEE platform configuration > Deploying into a JEE Application Server >

Deploying the application into JBoss


This section describes how to generate Bizagi Work Portal in JBoss (deploy the application into this JEE Application Server).

Before deploying the generated Bizagi .ear file into the Application Server, it is necessary to execute a pre-deployment procedure, which basically consists in building a module with generated entities information (from the data model), and integrating it to the current Bizagi release.


For JBoss, this procedure is done by using the JEE Console.



Ensure you meet both:

Having already used Bizagi Advanced Deployment to publish Processes from the Development Database into the Test or Production Database.

Having JBoss properly configured to work with Bizagi (its path is referred to as <JBOSS_HOME>). JBoss should be in a started mode.

For more information refer to Configuring JBoss.

Having access to the .ear file delivered as <CONFIGURATION_INPUTS>\Bizagi\Bizagi-ear-JBoss.ear.

This path and file is referred to when configuring JBoss.

Having installed Bizagi JEE Console. This local path is referenced in this guide as <JEECONSOLE_HOME>.






What you need to do

You will need to:

1. Configure the project template XML file.

2. Generate the .EAR file.

3. Install the Work Portal.




The following steps describe in detail how to deploy the application into JBoss.


1. Configure the project template XML file.

In order to generate the final .EAR file, you need to first configure the XML file for your project's environment.

The template file to configure this setting, is delivered within the Bizagi JEE Console, and it is found as <JEECONSOLE_HOME>\ProjectTemplate.xml.


Therefore, make sure you copy this XML template file and paste it to create a new one for your project.



Take into account:

1. That paths are separated by using the slash character ("/").

2. That this XML file should not contain commented lines.

The commented lines are included in the template to provide configuration example.

3. That you rename the XML configuration file so that it is named after your project (as it will be referenced later on through commands in the JEEConsole).


For JBoss, make sure that the project template file has the required JBoss elements:






If you are using a Database cluster, which relies on Oracle RAC (for your Oracle Database), then you will need to make sure that the <isRac> property is set to true, and that your specified connection details consider your RAC.




2. Generating the .EAR file

Once you have set the project template file, run the following command with Bizagi JEE Console:


In a Unix-like OS such as Linux, use:

sh <JEECONSOLE_HOME>/bin/ createproject -f <CONFIG_PATH>


In a Windows OS, use:

<JEECONSOLE_HOME>\bin\JEEConsoleManager.bat createproject -f <CONFIG_PATH>


Consider that <CONFIG_PATH> is the path where the configuration XML file is located.

Notice that this command will create the following directory: <JEECONSOLE_HOME>\projects\[PROJECT_NAME]



Once this command is successful, run the predeploy command with Bizagi JEE Console:


In a Unix-like OS such as Linux, use:



In a Windows OS, use:

<JEECONSOLE_HOME>\bin\JEEConsoleManager.bat predeploy -o <OUTPUT_PATH> -p [PROJECT_NAME] -f <FILE_PATH>


Consider that:

<OUTPUT_PATH> is the optional path to specify where the EAR file will be generated. Do not use -o if this information is not to be included (by default, the output file will be generated as <JEECONSOLE_HOME>\projects\[PROJECT_NAME]\dist\BizAgi-ear-JBoss.ear) .

[PROJECT_NAME] is the project's name as specified in the XML at the <CONFIG_PATH>. Using -p for this parameter is mandatory.

<FILE_PATH> is the optional path where the basic .EAR distribution file is located (which needs to be referenced to generate the final .EAR).

This file is initially delivered within the configuration inputs as <CONFIGURATION_INPUTS>\BizagiBPMJEE\Bizagi-ear-JBoss.ear.

Do not use -f if this information is not to be included (when not specified, the location will be taken from the projectemplate.xml.)

If your JBoss configuration uses more than 1 node (cluster set up), you will need to use -c to specify that the predeploy should run with cluster considerations. Absence of this parameter will indicate that no cluster is involved (standalone set up).


Cluster consideration

When using a cluster setup, you may also want to check that the generated .ear file in each node, contains the following properties.

Such properties must be set for each <persistence-unit> element, in its internal

.\BizAgi-ear-JBoss.ear\BizAgi-ejb.jar\META-INF\persistence.xml  file:


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

           <property name="eclipselink.weaving" value="false" />

         <property name="eclipselink.cache.coordination.jndi.password" value="[Application_User]" />

         <property name="eclipselink.cache.coordination.jndi.user" value="[Administration_User]" />

         <property name="eclipselink.cache.coordination.jms.factory"

         value="java:jboss/exported/jms/EclipseLinkTopicConnectionFactory" />

         <property name="" value="remote://[Host]:4447" />

         <property name="eclipselink.cache.coordination.jms.topic"

         value="java:jboss/exported/jms/EclipseLinkTopic" />

         <property name="eclipselink.cache.coordination.naming-service" value="jndi" />

         <property name="eclipselink.cache.coordination.protocol" value="jms" />




[Application_User]: The application user created when configuring the JBoss cluster.

[Administration_User]: The administration user created when configuring the JBoss cluster.

[Host]: The local server where the .ear will be deployed.



You may find additional information about how to use Bizagi JEE Console at its local Readme-console.txt file.


3. Installing the Work Portal

The following step differs if you have JBoss as a standalone instance or if you have set it up in a cluster.

Refer to the procedure described for each of the two scenarios.


For standalone JBoss installations

JBoss allows Web applications to be installed by simply copying the generated (.EAR) file at the deploy folder of the server.

This deploy folder is: <JBOSS_HOME>/standalone/deployments


Therefore, copy the generated (.EAR) file into this folder.

Note that this can be done while the server is up and running (in hot), or if the server is stopped.

However, it is recommended that you restart the application once changes are updated.



Finally, to access the Web application (and verify its proper installation), type the following address into your browser (keep in mind that this URL is case sensitive):




It is possible to edit the file run.conf in order to modify the memory parameters for the server.

This is specially useful in case the server shows a memory restriction error executing the steps previously mentioned (by default, the JBoss configuration may be set to use little amount of memory).


To do so, edit the file <JBOSS_HOME>\bin\run.conf.bat (for a Windows OS); or the <JBOSS_HOME>\bin\run.conf file (for a Unix-like OS such as Linux).


Editing this file means:

Editing these parameters in a Unix-like OS:

–Xms1024m –Xmx1024m -XX:MaxPermSize=1024m

under the line # Specify options to pass to the Java VM.


Including this line in a Windows OS:

set "JAVA_OPTS=-Xms1024m -Xmx1024m -XX:MaxPermSize=1024m"

after the line rem # JVM memory allocation pool parameters - modify as appropriate.





Other options

When using a JBoss platform for your Bizagi processes, you may use optional commands to stop or start JBoss' service.

To stop the service, use:

<JEECONSOLE_HOME>\bin\JEEConsoleManager.bat stopappserver -p [PROJECT_NAME]


To start the service, use:

<JEECONSOLE_HOME>\bin\JEEConsoleManager.bat startappserver -p [PROJECT_NAME]



Additional steps

You may also set up Bizagi ODS in order to improve the performance and availability of your Bizagi server.

For more information, refer to Configuring Bizagi ODS for Process Analytics.