Chapter 4. Install

Now that the basic configuration is done and IBM WebSphere Application Server is set to deploy Red Hat JBoss BPM Suite, you can upload the WAR deployables that were extracted earlier.

As noted previously, the Red Hat JBoss BPM Suite ZIP file for IBM WebSphere Application Server contains the deployable WAR files for Business Central, Intelligent Process Server, and Dashbuilder.

4.1. Installing Business Central

Business Central is uploaded as a web archive and can then be accessed at http://TARGET_SERVER:PORT/business-central. Start the deployment by installing the Business Central WAR as a WebSphere application.

  1. In the main menu, go to ApplicationsApplication TypesWebSphere Enterprise Applications.

    This will show you all the existing applications in the system and allow you to install a new one.

  2. Click Install to start the installation process.
  3. Upload the Business Central WAR file (business-central.war) from the local file system. See Section 2.2, “Extracting Red Hat JBoss BPM Suite for IBM WebSphere Application Server” for more information.

    Figure 4.1. Preparing for Application Installation Wizard

    install bc
  4. Click Next. This process may take some time.

    Important

    You may encounter an error message similar to the following:

    The EAR file could be corrupt and/or incomplete. Make sure that the application is at a compatible Java(TM) Platform, Enterprise Edition (Java EE) level for the current version of WebSphere(R) Application Server.
    java.lang.NullPointerException

    In that case, run ulimit -n in the command line. If the result is 1024, increase the number of open file descriptors. The recommended value is 100 000.

  5. Select the Fast Path radio button and click Next.
  6. Change the Application Name to business-central in the Select Installation Options step and click Next.

    Figure 4.2. Selecting Installation Options

    install bc2
  7. In the Map Modules to Servers step, map the Business Central modules to servers according to your requirements.

    Figure 4.3. Mapping Modules to Servers

    install bc3
  8. Next, for each bean, select the Activation Specification radio button and enter the JMS Activation JNDI names created earlier into the Target Resource JNDI Name field:

    • For KieSessionRequesMessageBean, enter jms/activation/KIE.SESSION.
    • For TaskServiceRequesMessageBean, enter jms/activation/KIE.TASK.
    • For JMSAuditProcessor, enter jms/activation/KIE.AUDIT.
    • For JmsAvailableJobsExecutor, enter jms/activation/KIE.EXECUTOR.
    • For JMSSignalReceiver, enter jms/activation/KIE.SIGNAL.
  9. In the next step, where you have to map resource references to actual resources, you will be asked to fill the Target Resource JNDI Name field for two beans: KieSessionRequesMessageBean and TaskServiceRequesMessageBean. Enter the JNDI name for the KIE.RESPONSE.ALL connection factory that you created earlier: jms/conn/KIE.RESPONSE.ALL.

    Figure 4.4. Mapping Resource References to Resources

    install bc4
  10. In the Map Virtual Hosts for Web Modules step, leave the default values and click Next.
  11. In the next step, set the context root to business-central.
  12. In the Metadata for Modules step, leave the default values and click Next.
  13. In the Summary page, click Finish to install Business Central. This process can take a while. Save the changes to the master configuration at the end of this process.

You will be returned to the WebSphere Enterprise Applications page where business-central will be listed as a new application. However, it will be stopped at this stage. Before you start the application, you need to map groups to roles, configure class loading, and enable the Bouncy Castle Crypto API.

Mapping Groups to Roles
  1. Click on the business-central application to open the application configuration page.
  2. Click Security Role to User/Group Mapping under the Detail Properties heading on the left.
  3. Select the admin role and click Map Groups…​ at the top.
  4. Search for the admin group (or just click the Search button) and move it from the Available list to the Selected list. Click OK.

    This mapping gives the previously created administrator user access to the Business Central application.

    Figure 4.5. Mapping Groups

    mapping groups
  5. Follow the same procedure for the analyst role as well and save the configuration.

If you have other groups or users that should have access to Business Central, use the same steps to map them to the admin or analyst roles, or any other roles that you have, such as developer, manager, or user.

Note

If you are also installing the Intelligent Process Server, give this user access to the kie-server role. Additionally, map appropriate REST API roles if you are going to use the REST API. For further information about API roles, see chapter Remote API of Red Hat JBoss BPM Suite Development Guide.

Class-Loading Configuration

Ensure correct class-loading configuration by following the steps below.

  1. In the main menu, go to ApplicationsApplication TypesWebSphere Enterprise Applications.
  2. Click business-central.
  3. Click Class Loading and Update Detection under the Detail Properties heading on the left.
  4. Check the following options:

    • Class Loader Order: Classes loaded with local class loader first (parent last)
    • WAR Class Loader Policy: Single class loader for application

    Figure 4.6. Configuring Class Loading

    class loading
  5. Click OK, save the changes to the master configuration and restart the IBM WebSphere Application Server.
Enabling Bouncy Castle Crypto API

To enable Git SSH repository cloning and kie-config-cli from within Business Central, the Bouncy Castle Crypto API must be set up. Enable the API by following the steps below.

  1. Set the org.apache.sshd.registerBouncyCastle property to true and org.uberfire.domain property to WSLogin. See Section 3.7, “Adding Custom JVM Properties” for detailed instructions on how to set custom properties.
  2. Set up the Bouncy Castle API as a shared library referenced from Business Central using the appropriate version of Bouncy Castle:

    1. In the main menu on the left, navigate to EnvironmentShared Libraries, select the appropriate scope and click New…​ to create a new library.
    2. Give this library a name and set the class path to the Bouncy Castle library (bcprov-jdk16-1.46.jar). Click OK and save the configuration.

      Note

      For more information about the bcprov-jdk16-1.46.jar package, see the Maven Repository — Bouncy Castle Provider page.

    3. Go to ApplicationsApplication TypesWebSphere Enterprise Applications and click business-central.
    4. Click Shared Library References under the References heading on the left, select the web module, click on Reference Shared Libraries and move the Bouncy Castle library created in the previous step from the Available to the Selected list.

      Figure 4.7. Mapping Shared Libraries

      shared libraries
    5. Click OK and save the configuration.

You have now successfully installed Business Central on IBM WebSphere Application Server.

To start the application, go back to ApplicationsApplication TypesWebSphere Enterprise Applications page and select the business-central checkbox before clicking Start.

To access the application, navigate to http://TARGET_SERVER:PORT/business-central in your web browser.

4.2. Installing Dashbuilder

Dashbuilder for IBM WebSphere Application Server is distributed as a deployable WAR file (dashbuilder.war) as a part of the Red Hat JBoss BPM Suite download.

Note

Before installing Dashbuilder, set up a data source for Dashbuilder by following the steps outlined in Section 3.5, “Setting up Data Source”.

Dashbuilder needs an access to the same database schema as Business Central. In the first step of creating a data source, specify the data source JNDI name as jdbc/jbpm.

  1. In the main menu of the IBM Integrated Solutions Console, go to ApplicationsApplication TypesWebSphere Enterprise Applications and click Install.
  2. Upload the Dashbuilder WAR file (dashbuilder.war) from the local file system and click Next. This process may take some time.

    Figure 4.8. Preparing for Application Installation Wizard

    install dash
  3. Select Fast Path radio button and click Next.

    The Install New Application window opens.

  4. In the Select Installation Options step, change the Application Name to dashbuilder and click Next.

    Figure 4.9. Selecting Installation Options

    install dash2
  5. In the Map Modules to Servers step, map the Dashbuilder modules to servers according to your requirements and click Next.

    Figure 4.10. Mapping Modules to Servers

    install dash3
  6. In the Map Resource References to Resources step, set the Target Resource JNDI Name of the dashbuilder module to jdbc/jbpm. Click Next.

    Figure 4.11. Mapping Resource References to Resources

    install dash4
  7. In the Map Virtual Hosts for Web Modules step, leave the default values and click Next.
  8. In the next step, set the context root to /dashbuilder and click Next.

    Figure 4.12. Mapping Context Roots for Web Modules

    install dash5
  9. In the Metadata for Modules step, leave the default values and click Next.
  10. In the Summary page, click Finish to install Dashbuilder. This process may take a while. Save the changes to the master configuration at the end of this process.

You will be returned to the Enterprise Applications page where dashbuilder will be listed as a new application. However, it will be stopped at this stage. Before you start the application, you need to map groups to roles and configure correct class loading.

Mapping Groups to Roles
  1. Click on the dashbuilder application to open the application configuration page.
  2. Click Security Role to User/Group Mapping under the Detail Properties heading on the left.
  3. Select the admin role and click Map Groups…​​ at the top.
  4. Search for the admin group (or just click the Search button) and move it from the Available list to the Selected list. Click OK.

    This mapping gives the previously created administrator user access to the Dashbuilder application.

  5. Follow the same procedure for the analyst, developer, user, and manager roles.
Class-Loading Configuration

Ensure correct class-loading configuration by following the steps below.

  1. In the main menu, go to ApplicationsApplication TypesWebSphere Enterprise Applications.
  2. Click dashbuilder.
  3. Click Class Loading and Update Detection under the Detail Properties heading on the left.
  4. Check the following options:

    • Class Loader Order: Classes loaded with local class loader first (parent last)
    • WAR Class Loader Policy: Single class loader for application

    Figure 4.13. Configuring Class Loading

    class loading dashbuilder
  5. Click OK, save the changes to the master configuration and restart the IBM WebSphere Application Server.

You have now successfully installed Dashbuilder on IBM WebSphere Application Server.

To start the application, go back to ApplicationsApplication TypesWebSphere Enterprise Applications page and select the dashbuilder checkbox before clicking Start.

You can now log in to Dashbuilder at http://TARGET_SERVER:PORT/dashbuilder using the user that you have created in the previous steps.

4.3. Installing Intelligent Process Server

The Intelligent Process Server is distributed as a web application archive file (kie-server.war) and is present in your Red Hat JBoss BPM Suite 6.4.0 Deployable for WebSphere 8.5 download.

Note

It is assumed that you followed the steps described in Section 3.3, “Creating Users and Groups” to create the role kie-server required by the Intelligent Process Server. Similarly, the JMS connection factories, queues, and activation specifications required by the Intelligent Process Server need to be created. If you have not done so, revisit the respective sections in this guide.

  1. In the main menu on the left, go to ApplicationsApplication TypesWebSphere Enterprise Applications.

    This will show you all the existing applications in the system and allow you to install a new one.

  2. Click Install to start the installation process.
  3. Upload the Intelligent Process Server WAR file (kie-server.war) from the local file system.
  4. Select the Fast Path radio button and click Next.

    The Install New Application wizard opens.

  5. Change the Application Name to kie-server in the first step and click Next.
  6. In the next step, map the Intelligent Process Server modules to servers according to your requirements and click Next.
  7. In the Bind Listeners for Message-Driven Beans step, select the Activation Specification radio button for both the beans. Enter jms/activation/KIE.SERVER.EXECUTOR as Target Resource JNDI Name for the KieExecutorMDB bean, and jms/activation/KIE.SERVER.REQUEST for the KieServerMDB bean.
  8. In the next step, map resource references to actual resources. Enter the JNDI name for the KIE.SERVER.REQUEST connection factory that you created earlier: jms/conn/KIE.SERVER.REQUEST.
  9. In the Map Virtual Hosts for Web Modules step, leave the default values and click Next.
  10. In the next screen, set the context root to kie-server.
  11. In the Metadata for Modules step, leave the default values and click Next.
  12. Click Finish to install the Intelligent Process Server. Save the changes to the master configuration at the end of this process.
Class-Loading Configuration

Ensure correct class-loading configuration by following the steps below.

  1. Navigate to ApplicationsApplication TypesWebSphere Enterprise Applications and click kie-server.
  2. Click Class Loading and Update Detection under the Detail Properties heading on the left.
  3. In the properties, change Class Loader Order to Classes loaded with local class loader first (parent last) and WAR Class Loader Policy to Single class loader for application.
  4. Save the changes to the master configuration.
Mapping Groups to Roles

If you have already mapped the kie-server role to a user or a group, you can ignore this procedure. Otherwise, do the following:

  1. Go back to the main configuration page for the newly installed kie-server application (ApplicationsApplication TypesWebSphere Enterprise Applications). Click Security Role to User/Group Mapping under the Detail Properties heading on the left.
  2. Select the kie-server role, click Map Groups…​ and search for the kie-server group in the next screen (or just click the Search button).
  3. Move it from the Available list to the Selected list. Click OK.

This mapping gives the previously created administrator user access to the Intelligent Process Server.

You can now save the changes and start the kie-server application.

Check whether the Intelligent Process Server REST API works by sending a GET request at http://TARGET_SERVER:PORT/kie-server/services/rest/server.