Deploying the application into WebSphere

<< 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 WebSphere

Overview

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

The following instructions applies for both: Deployments in clustered configurations (when using more than 1 WebSphere node), and deployments in standalone setup (standard configuration).

 

 

Prerequisites

Ensure you meet both:

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

Having WebSphere properly configured to work with Bizagi. WebSphere should be in a started mode.

For more information refer to Configuring WebSphere

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

This path and file is referred to when configuring WebSphere.

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.

 

 

Procedure

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

 

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.

 

note_pin

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 WebSphere, make sure that the project template file has the required WebSphere elements:

 

WSPHERE_projecttemplate

 

note_pin

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.

 

Console_isRAC

 

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/JEEConsoleManager.sh 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:

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

 

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\Biz Agi-ear-WebSphere.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-Websphere.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 WebSphere 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).

 

 

note_pin

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

 

Development environment considerations

If you are using WebSphere in your development environment (authoring) instead of using the JBoss instance that comes bundled with Bizagi Studio, there is the option to refresh the application's cache memory to avoid re-generating the application in some scenarios:

 

This option is to use the cleancache command provided by the JEE administration console. This command will refresh information when simple changes are carried out, and strictly no changes have been made to the data model.

For instance, when making minor editions in rules or in forms appearance, you may use this command as described:

cleancache -p [PROJECT_NAME] -host [SERVER] -port [PORT]

 

For its use, consider:

PROJECT_NAME: The project's name. Its definition is required along with the -p parameter.

SERVER: The name of the server (or its IP address) on which we want to refresh the cacheed information. Its definition is required along with the -host parameter.

PORT:  The port number being used by the Application Server. Its definition is required along with the -port parameter.

 

 

3. Installing the Work Portal

The steps required to install Bizagi Work Portal will slightly vary whether your WebSphere is using more than 1 node (set up in a cluster or not).

Follow the steps in either section: Installation when using cluster or Installation for standalone setup, according to your scenario.

 

 

Installation when using cluster

1. Log on to the Administration Console and using the navigation pane go to Applications – Application Types – WebSphere enterprise applications.

 

WSPHERE_deploy00

 

Click Install.

 

note_pin

If this is not the first time you are deploying the application into WebSphere (you are applying changes or new process versions to your Bizagi project), then stop the existing Bizagi-ear application, and uninstall it first:

 

WSPHERE_deploy01

 

 

2. Use the Preparing for the application installation option to locate the Bizagi distribution (the Bizagi-ear-Websphere.ear output) to be installed and then click Next.

 

WebSphereConfigurationToWorkWithBizagi_Image042

 

3. Type the option Fast Path for Selected for installation and click Next.

 

4. Ensure you mark the Deploy Web services checkbox in the Install New Application / Select installation options.

The other configuration may be modified depending on the Application Server's administrator criteria, but you may leave the defaults and click Next.

 

WS_Cluster04

 

 

5. Verify that the All security domains value is assigned for the Display clusters and servers in the following security domain property, from the drop-down list options.

Under the list of Clusters and servers, make sure you include all nodes which make up your cluster, as well as include the Web server which is in charge of load balancing.

Mark the checkboxes for the modules listed in the table, and click on Apply.

 

WS_Cluster01

 

Click Next.

 

 

6. Review the parameters for the configuration of the installation process in the Install New Application / Summary window, and click Finish.

 

7. Once the application is finished installing, click Save to keep the changes on the master configuration.

 

WS_Cluster02

 

8. Select the installed application (Bizagi-ear) and click it.

Click on the Session management option to administrate its session information.

This option is located under Web Module properties.

 

Locate the Additional properties section and click Distributed environment settings. Click on Memory-to-memory replication to configure replication settings for Bizagi's application:

Replication domain: Select your WebSphere cluster.

Replication mode: Select Both client and server.

 

 

WS_Cluster03

 

 

Click Ok.

 

9. While editing the newly created Bizagi-ear application,  to include shared library references.

To do this, click on the application and use the Reference shared libraries button to locate the Shared library mapping option and select httpclient:

 

WSPHERE_sharedlibs

 

Click Ok and apply changes.

 

10. Back in the listed and installed applications, mark the checkbox for Bizagi-ear  and use the Start button to load it (at this point, the Work portal is generated).

 

WebSphereConfigurationToWorkWithBizagi_Image044

 

WebSphereConfigurationToWorkWithBizagi_Image045

 

11. Make sure you propagate all changes into other nodes in your cluster.

To do this, use the Update global Web server plug-in configuration option found under the Environment section.

 

To verify that the Work Portal was installed correctly, enter the following address into any browser (keep in mind that this URL is case sensitive):

http://[Balancer_Server]:[Port]/BizAgi-war/

 

 

 

Installation for standalone setup (standard configuration)

1. Log on to the Administration Console and using the navigation pane go to Applications – Application Types – WebSphere enterprise applications.

 

WSPHERE_deploy00

 

Click Install.

 

note_pin

If this is not the first time you are deploying the application into WebSphere (you are applying changes or new process versions to your Bizagi project), then stop the existing Bizagi-ear application, and uninstall it first:

 

WSPHERE_deploy01

 

2. Use the Preparing for the application installation option to locate the Bizagi distribution (Bizagi-ear-Websphere.ear) to be installed and then click Next.

 

WebSphereConfigurationToWorkWithBizagi_Image042

 

3. Type the option Fast Path for Selected for installation and click Next.

 

4. Ensure you mark the Deploy Web services checkbox in the Install New Application / Select installation options.

The other configuration may be modified depending on the Application Server's administrator criteria, but you may leave the defaults and click Next.

 

WS_Cluster04

 

5. Click Next for the Install New Application / Map modules to servers options.

 

6. Click Next for the Install New Application / Map virtual hosts for Web modules options.

 

7. Review the parameters for the configuration of the installation process in the Install New Application / Summary window, and click Finish.

 

8. Once the application is finished installing, click Save to keep the changes on the master configuration.

 

WebSphereConfigurationToWorkWithBizagi_Image043

 

9. Edit the newly created Bizagi-ear application to include shared library references.

To do this, click on the application and use the Reference shared libraries button to locate the Shared library mapping option and select httpclient:

 

WSPHERE_sharedlibs

 

Click Ok and apply changes.

 

10. Finally, select the installed application and click the Start button to load its components.

 

WebSphereConfigurationToWorkWithBizagi_Image044

 

WebSphereConfigurationToWorkWithBizagi_Image045

 

 

It is recommended that you restart the application once changes are updated.

 

To verify that the Work Portal was installed correctly, enter the following address into any browser (keep in mind that this URL is case sensitive):

http://[Server]:[Port]/BizAgi-war/

 

 

Additional steps

If your project is set up for a Test or Production environment, and it uses Virtualization or Replication, you will need to register in your JEE Application Server, the external data source involved in this integration.

For more information about this, refer to How to configure Replication or Virtualization in a JEE Application Server.

 

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.