Version upgrade in the JEE edition

<< Click to Display Table of Contents >>

Navigation:  Bizagi Engine > Bizagi system administration > Maintenance and administration > Bizagi versions and upgrades > Upgrading Bizagi > Version upgrade > Minor version upgrade >

Version upgrade in the JEE edition



Bizagi generates new versions periodically.


New versions include great new features and some bug fixing.

It is strongly recommended to upgrade your projects to the newest release, so that you can enjoy all the benefits of Bizagi new features and improvements.

Version upgrade is a simple procedure which is automatically suggested and notified by Bizagi.




Whenever you install a new version, through Bizagi Studio you may open the project to upgrade it in its Development environment.


For test and production environment, there is a different procedure involved.

This section will focus on how to upgrade minor versions in test or production environments of Bizagi projects running in a JEE platform.

For more information about upgrading the Development environment, refer to Version upgrade.



Before you start

It is strongly recommended to prepare and schedule a Bizagi version upgrade.

This means that you should always:


1. Take backups of your Database and of your application.

This means creating a Database backup file, and creating a copy of the deployed application at the JEE Application Server.


2. Always upgrade your Development environment first, then the Test environment, and then the Production environment.

Evaluate if you need a Production-replica environment.


It is recommended to perform unit tests to ensure that existing Processes behave as expected in the Development environment.

Once this is done, upgrading your Test environment and performing user-acceptance tests on this environment should also be carried out.


After verifying that Processes work properly (in both, Development and Test environment) and depending on how critical your Processes are, you may create a Production-replica environment.

In this way, in the Production-replica environment you can perform an upgrade and test your Production environment Processes with live instances.

After ensuring that the Production-replica environment Processes and instances are OK, upgrade your real Production environment.



A Production-replica environment is a Bizagi project which has the Production backup restored into it.

It is not the real Production environment because it would require that Production parameters and other relevant information are modified (for instance, the actual e-mail addresses of users, the SMTP Server or other URLs involved in integration points in the Processes, etc).


3. Plan the Production environment's upgrade to be carried out at non-working hours.

A version upgrade will temporarily stop your services and therefore it should be scheduled accordingly.


4. Have at hand the configuration and deployment files delivered by Bizagi (,, or, according to your JEE Application Server).



What you need to do

To upgrade your version in test or production, carry out the following:

1. Update information in your Bizagi Database.

2. Replace the configuration files and libraries used by Bizagi.

3. Generate the Work portal by the deploying the application into the Application server.



Follow these steps:


1. Update information in your Bizagi Database.

To carry out this step, please contact our support team.


2. Replace the configuration files and libraries used by Bizagi.

This step involves replacing the configuration files provided by Bizagi by those same ones which are newer.

This is done in order to configure your JEE Application Server with  the files included in the,, or distribution files.


You will need to go over the configuration according to your JEE Application Server (WebSphere, Weblogic or JBoss) as described in the step 1:Extract module files used by Bizagi of the corresponding sections.

For WebSphere refer to WebSphere configuration.

For Weblogic refer to Weblogic configuration.

For JBoss refer to JBoss configuration.


Keep in mind that you should do this for all your service nodes (will imply doing this step more than once if you have a cluster setup).



When replacing these configuration files (drivers, and other jar libraries), make sure that you consider the name that is already referenced in your Application Server.

This means that it is recommended to ensure that jars are renamed to ensure they are referred to by their name but without including the specific version.

It is really important to delete the old version libraries, because in the end, you should not have more than 1 version for the same .jar library.


2. Generate the Work portal by the deploying the application into the Application server.

For more information about this step, refer to Deploying the application into a JEE Application Server.