Creating a project in the JEE platform

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi Projects > Creating a new project >

Creating a project in the JEE platform




Bizagi offers the possibility to create a project to run in a JEE platform (by using JBoss as the Application server hosting the Work portal).


Keep in mind that once you create a project under a given platform (JEE or .NET), you will not be able to switch the application platform to run that project.

In other words, projects created to run in a .NET platform are not to be executed in a JEE platform, and vice versa.


Before you begin

To create a Bizagi project that runs in a JEE platform, you will need Bizagi JEE Plug-in.

If you do not have this plug-in already stored in your machine, you will need internet access to download it from as described in the following steps.


Bizagi JEE Plug-in details

Bizagi JEE Plug-in is available through 2 distributable files:

For 64-bit systems, the plug-in you download is named as a zip file, containing the matching Bizagi Studio version and its bits support.

For example, for version 10.5:

For 32-bit systems, the plug-in you download is named as a zip file, containing the matching Bizagi Studio version and its bits support.

For example, for version 10.5:


The Bizagi JEE Plug-in includes:

A JVM for your 32 or 64-bit system. It will install a JAVA SE JDK 7.

This means that you don't need to have a previously installed JDK or to configure a JAVA_HOME variable.

Bizagi will automatically use its installed JDK and disregard other JAVA_HOME configuration you may have in your machine.

A JBoss EAP 6.4 instance. It will be automatically installed so that Bizagi Studio directly uses this server to publish your processes.

An auxiliary tool used by Bizagi Studio to carry out administrative tasks in a JEE environment, which is called the JEE Console.



To create a JEE project, you will need to configure the Bizagi JEE Plug-in through a wizard which needs explicitly Internet Explorer 8 or higher installed.

This wizard uses IE libraries and therefore, older versions of Internet Explorer are not supported.



Creating the project

Follow these steps:


1. Use the New project option in Bizagi.

You may click directly in the New shortcut, right when Bizagi Studio is opened:






Keep in mind that in order to create a project, your account needs to belong to both to the local Bizagi and the Administrators group (where Bizagi Studio is installed).





If your account does not have such rights, you will be prompted to enter authorized credentials:




2. Enter details of your project.

Make sure you name your project and define its location.

To create a Bizagi project running in a JEE platform, you will need to specifically select JEE as the runtime platform:




Click Next.


3. Install Bizagi JEE Plug-in.

When creating a JEE project for the first time, Bizagi will present the following steps to install Bizagi JEE Plug-in.



Bizagi will detect if the plug-in is already installed. In such cases, this step will not be necessary.




Use the Download now button to download and save the plug-in into your local machine.

You may also use the button to the right, in order to get the URL to download the plug-in (this is useful if you are to download this plug-in from another machine).



When using the Download button, Bizagi will automatically detect if you need the 32-bit or 64-bit compliant plug-in.

Therefore when not using this option (e.g, if you share the plug-in with other team colleagues, or use a direct URL to obtain it), make sure you install the 32-bit or 64-bit plug-in accordingly to your system architecture.


Once you have installed the plug-in, use the Browse button to configure in Bizagi Studio where you have the plug-in:




Notice you may directly browse for the .zip file and reference it, or you may also reference the path of the plug-in if you have previously uncompressed it.

Click Next.


4. Configure JBoss.

If this is your first time creating a Bizagi project to run in a JEE platform, Bizagi will present the following steps to guide you towards the configuration of the bundled JBoss server provided by Bizagi JEE Plug-in.



Bizagi will detect if the plug-in is already installed. In such cases, this step will not be necessary.


Enter a port number to configure where JBoss will start its services.

If you are uncertain about this setting, you may choose to leave the suggested default port (8080).




Click Next.

Bizagi will configure the plug-in. This may take a minute or two.





6. Enter the database server details.

If you chose the Advanced configuration, make sure you specify where you want your processes repository to be.

Notice that the database can be stored on the local computer or a remote server.


If you used the quick start options, you may use the SQL Server database that Bizagi Studio installs.

This database is detected automatically, so you would only need to input the default connection credentials which are:

Login name: sa

Password: BizagiBPM123





If you use the SQL Server database that Bizagi Studio installs (or a local instance), make sure you have at least 300 MB of free disk space in your C:\ hard drive.

Otherwise, when using a SQL Server database server (in a remote machine) make sure you have at least 300 MB of free disk space in that server.


If you want to use a different SQL Server database, specify the following information: 

Server: The name of the Database Server containing the SQL Server instance.

Database: The name of your project. Bizagi will create a database with this name. 

Login name: A login account to access the SQL Server instance

Password: The password for the specified Login name.

Unicode support: Make sure this checkbox is ticked to allow your database to support unicode characters.


If you use an Oracle database, make sure you select Oracle and enter the connection's details by considering:

Connection details include the information of Oracle's service (databaseServer:port/serviceName), along with the password for the BizagiAdmon user (as configured when verifying prerequisites for Oracle).

The new project is presented with a database name (to be a new Oracle user), and it will prompt for the password and its confirmation.


Click Next.

Bizagi will proceed with the project's creation.

Once the project has been created, Bizagi Studio will automatically open it, for you to get started automating your processes.



Keep in mind the following considerations about Bizagi JEE Plug-in:


Bizagi JEE Plug-in has a specific version number which should match the version of Bizagi Studio.

If you have more than 1 Bizagi project in your Bizagi Studio, all running in the JEE platform, it is recommended to keep them up upgraded to date to a same Bizagi version when possible.


When this is not possible, then keep in mind that the Bizagi JEE Plug-in will be saved and required per each version used by your projects, meaning that projects in different versions will have each their corresponding Bizagi JEE Plug-in.

The above implies that your JEE projects will be stored inside of a path considering the version of this plug-in (for example, at C:\BizagiJEE\\BizagiConsoleManagerJEE\...).



Uninstalling the Plug-in

In case you wish to uninstall Bizagi JEE Plug-in, all you need to do is delete this plug-in folder's.

You may continue working with Bizagi Studio, with the bundled .NET platform when you do so.

If you also wish to uninstall Bizagi Studio, then in addition to first deleting the plug-in's folder, you may also use the uninstall options for Bizagi Studio available from the control panel.