Procedure

1. In a terminal window, navigate to the directory where you downloaded the installer JAR file and enter the following command:

   java -jar rhpam-installer-7.10.0.jar

   Note

   When running the installer on Windows, you may be prompted to provide administrator credentials during the installation. To prevent this requirement, add the izpack.mode=privileged option to the installation command:

   java -Dizpack.mode=privileged -jar
   rhpam-installer-7.10.0.jar

   Furthermore, when running the installer on a 32-bit Java virtual machine, you might encounter memory limitations. To prevent this issue, run this command:

   java -XX:MaxHeapSize=4g -jar
   rhpam-installer-7.10.0.jar

   The graphical installer displays a splash screen and a license agreement page.

2. Click I accept the terms of this license agreement and click Next.
3. Specify the Red Hat JBoss EAP 7.3 server home where you want to install Red Hat Process Automation Manager and click Next.

4. Select the components that you want to install and click Next.

   Note

   You can install Business Central and KIE Server on the same server. However, you should install Business Central and KIE Server on different servers in production environments. To do this, run the installer twice.

5. Create a user and click Next. By default, if you install both Business Central and KIE Server in the same container the new user is given the admin, kie-server, and rest-all roles. If you install only KIE Server, the user is given the kie-server role. To select another role, deselect admin. For information about roles, see Chapter 11, Red Hat Process Automation Manager roles and users.

   Note

   Make sure that the specified user name is not the same as an existing user, role, or group. For example, do not create a user with the user name admin.

   The password must have at least eight characters and must contain at least one number and one non-alphanumeric character, but not & (ampersand).

   Make a note of the user name and password. You will need them to access Business Central and KIE Server.

6. On the Installation Overview page, review the components that you will install and click Next to start the installation.
7. When the installation has completed, click Next.

8. If KIE Server is installed, the Configure Runtime step appears under Component Installation. On the Configure Runtime Environment page, choose to perform the default installation or perform an advanced configuration.

   If you choose Perform advanced configuration, you can choose to configure database settings or customize certain KIE Server options.

9. If you selected Customize database settings, on the JDBC Drive Configuration page specify a data source JDBC driver vendor, select one or more driver JAR files, and click Next.

   A data source is an object that enables a Java Database Connectivity (JDBC) client, such as an application server, to establish a connection with a database. Applications look up the data source on the Java Naming and Directory Interface (JNDI) tree or in the local application context and request a database connection to retrieve data. You must configure data sources for KIE Server to ensure correct data exchange between the servers and the designated database.

10. If you selected Customize KIE Server properties, on the KIE Server Properties Configuration page change any of the following properties:

    • Change the value of KIE Server ID to change the name of the KIE Server property.
    • Change the value of Controller URL to change the URL of the headless Process Automation Manager controller.
    • Deselect any KIE Server functions that you want to disable.
11. Click Next to configure the runtime environment.
12. When Processing finished appears at the top of the screen, click Next to complete the installation.

13. Optional: Click Generate Installation Script and Properties File to save the installation data in XML files, and then click Done.

    The installer generates two files. The auto.xml file automates future installations and the auto.xml.variables file stores user passwords and other sensitive variables. Use the auto.xml file to repeat the Red Hat Process Automation Manager installation on multiple systems with the same type of server and the same configuration as the original installation. If necessary, update the installpath parameter in the auto.xml file. To perform an installation using the XML file, enter the following command:

    java -jar rhpam-installer-7.10.0.jar <path-to-auto.xml-file>

Procedure

1. In a terminal window, navigate to the directory where you downloaded the installer file and enter the following command:

   java -jar rhpam-installer-7.10.0.jar -console

   The command-line interactive process will start and display the End-User License Agreement.

   press 1 to continue, 2 to quit, 3 to redisplay.

2. Read the license agreement, enter 1, and press Enter to continue:

   Specify the home directory of one of the following servers:  Red Hat JBoss EAP 7 or Red Hat JBoss Web Server 5. For more information, see https://access.redhat.com/articles/3405381[Red Hat Process Automation Manager 7 Supported Configurations].

3. Enter the parent directory of an existing Red Hat JBoss EAP 7.3 installation.

   The installer will verify the location of the installation at the location provided. Enter 1 to confirm and continue.

   Note

   You can install Business Central and KIE Server on the same server. However, you should install Business Central and KIE Server on different servers in production environments.

4. Follow the instructions in the installer to complete the installation.

   Note

   When you create the user name and password, make sure that the specified user name does not conflict with any known title of a role or a group. For example, if there is a role called admin, you should not create a user with the user name admin.

   The password must have at least eight characters and must contain at least one number and one non-alphanumeric character (not including the character &).

   Make a note of the user name and password. You will need them to access Business Central and KIE Server.

5. When the installation has completed, you will see this message:

   Would you like to generate an automatic installation script and properties file?

6. Enter y to create XML files that contain the installation data, or n to complete the installation. If you enter y, you are prompted to specify a path for the XML files.

7. Enter a path or press the Enter key to accept the suggested path.

   The installer generates two files. The auto.xml file automates future installations and the auto.xml.variables file stores user passwords and other sensitive variables. Use the auto.xml file on multiple systems to easily repeat a Red Hat Process Automation Manager installation on the same type of server with the same configuration as the original installation. If necessary, update the installpath parameter in the auto.xml file. To perform an installation using the XML file, enter the following command:

   java -jar rhpam-installer-7.10.0.jar <path-to-auto.xml-file>

8. If you installed only Business Central, repeat these steps to install KIE Server on a separate server.

Procedure

1. On the first computer, run the installer in interactive mode or CLI mode. See one of the following sections for more information:

   • Section 13.1, “Using the installer in interactive mode”
   • Section 13.2, “Using the installer in CLI mode”
2. On the Component Selection page, clear the KIE Server box.
3. Complete the Business Central installation.
4. On the second computer, run the installer in interactive mode or CLI mode.
5. On the Component Selection page, clear the Business Central box.
6. On the Configure Runtime Environment page, select Perform Advanced Configuration.
7. Select Customize KIE Server properties and click Next.

8. Enter the controller URL for Business Central and configure additional properties for KIE Server. The controller URL has the following form where <HOST:PORT> is the address of Business Central on the second computer:

   <HOST:PORT>/business-central/rest/controller

9. Complete the installation.
10. To verify that the Process Automation Manager controller is now integrated with Business Central, go to the Execution Servers page in Business Central and confirm that the KIE Server that you configured appears under REMOTE SERVERS.

Procedure

1. Extract the rhpam-7.10.0-business-central-eap7-deployable.zip file to a temporary directory. In the following examples this directory is called TEMP_DIR.

2. Copy the contents of the TEMP_DIR/rhpam-7.10.0-business-central-eap7-deployable/jboss-eap-7.3 directory to EAP_HOME. When prompted, merge or replace files.

   Warning

   Ensure that the names of the Red Hat Process Automation Manager deployments that you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

Procedure

1. Extract the rhpam-7.10.0-kie-server-ee8.zip archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

2. Copy the TEMP_DIR/rhpam-7.10.0-kie-server-ee8/kie-server.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure the names of the Red Hat Process Automation Manager deployments you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

3. Copy the contents of the TEMP_DIR/rhpam-7.10.0-kie-server-ee8/rhpam-7.10.0-kie-server-ee8/SecurityPolicy/ to EAP_HOME/bin.
4. When prompted to overwrite files, click Replace.
5. In the EAP_HOME/standalone/deployments/ directory, create an empty file named kie-server.war.dodeploy. This file ensures that KIE Server is automatically deployed when the server starts.

Procedure

1. Complete the following steps to prepare your database:

   1. Extract rhpam-7.10.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.10.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.10.0-migration-tool/ddl-scripts directory. This directory contains DDL scripts for several database types.

   4. Import the DDL script for your database type into the database that you want to use.

      The following example creates jBPM database structures in PostreSQL

      psql jbpm < /ddl-scripts/postgresql/postgresql-jbpm-schema.sql

      Note

      If you are using PostgreSQL or Oracle in conjunction with Spring Boot, you must import the respective Spring Boot DDL script, for example /ddl-scripts/oracle/oracle-springboot-jbpm-schema.sql or /ddl-scripts/postgresql/postgresql-springboot-jbpm-schema.sql.

      Note

      The PostgreSQL DDL scripts create the PostgreSQL schema with auto-incrementing integer value (OID) columns for entity attributes annotated with @LOB. To use other binary column types such as BYTEA instead of OID, you must create the PostgreSQL schema with the postgresql-bytea-jbpm-schema.sql script and set the Red Hat Process Automation Manager org.kie.persistence.postgresql.useBytea=true flag. Red Hat Process Automation Manager does not provide a migration tool to change from an OID-based to a BYTEA-based schema.

2. Open EAP_HOME/standalone/configuration/standalone-full.xml in a text editor and locate the <system-properties> tag.

3. Add the following properties to the <system-properties> tag where <DATASOURCE> is the JNDI name of your data source and <HIBERNATE_DIALECT> is the hibernate dialect for your database.

   Note

   The default value of the org.kie.server.persistence.ds property is java:jboss/datasources/ExampleDS. The default value of the org.kie.server.persistence.dialect property is org.hibernate.dialect.H2Dialect.

   <property name="org.kie.server.persistence.ds" value="<DATASOURCE>"/>
   <property name="org.kie.server.persistence.dialect" value="<HIBERNATE_DIALECT>"/>

   The following example shows how to configure a datasource for the PostgreSQL hibernate dialect:

   <system-properties>
       <property name="org.kie.server.repo" value="${jboss.server.data.dir}"/>
       <property name="org.kie.example" value="true"/>
       <property name="org.jbpm.designer.perspective" value="full"/>
       <property name="designerdataobjects" value="false"/>
       <property name="org.kie.server.user" value="rhpamUser"/>
       <property name="org.kie.server.pwd" value="rhpam123!"/>
       <property name="org.kie.server.location" value="http://localhost:8080/kie-server/services/rest/server"/>
       <property name="org.kie.server.controller" value="http://localhost:8080/business-central/rest/controller"/>
       <property name="org.kie.server.controller.user" value="kieserver"/>
       <property name="org.kie.server.controller.pwd" value="kieserver1!"/>
       <property name="org.kie.server.id" value="local-server-123"/>
   
       <!-- Data source properties. -->
       <property name="org.kie.server.persistence.ds" value="java:jboss/datasources/KieServerDS"/>
       <property name="org.kie.server.persistence.dialect" value="org.hibernate.dialect.PostgreSQLDialect"/>
   </system-properties>

Procedure

1. In a terminal application, navigate to the EAP_HOME/bin directory.

2. Create a user with the admin, rest-all, and kie-server roles that you will use to log in to Business Central.

   Note

   Users with the admin role are Business Central administrators. Users with rest-all role can access Business Central REST capabilities. Users with the kie-server role can access KIE Server (KIE Server) REST capabilities. The kie-server role is mandatory for users to have access to Manage and Track views in Business Central.

   In the following command, replace <USERNAME> and <PASSWORD> with the user name and password of your choice:

   $ ./add-user.sh -a --user <USERNAME> --password <PASSWORD> --role admin,rest-all,kie-server

   Note

   Make sure that the specified user name is not the same as an existing user, role, or group. For example, do not create a user with the user name admin.

   The password must have at least eight characters and must contain at least one number and one non-alphanumeric character, but not & (ampersand).

3. Create a user with the kie-server role that you will use to log in to KIE Server.

   $ ./add-user.sh -a --user <USERNAME> --password <PASSWORD> --role kie-server

4. Make a note of your user names and passwords.

   Note

   If you installed Business Central and KIE Server in the same server instance, you can create a single user that has both of these roles:

   $ ./add-user.sh -a --user <USERNAME>  --password <PASSWORD> --role admin,rest-all,kie-server

   You should install Business Central and KIE Server on different servers in production environments.

Procedure

1. In your Red Hat Process Automation Manager installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for Red Hat Process Automation Manager, go to $EAP_HOME/standalone/configuration/standalone-full.xml.

2. Open the standalone-full.xml file and under the <system-properties> tag, set the following JVM properties:

   Table 14.1. JVM Properties for the KIE Server instance

   Property	Value	Note
   org.kie.server.id	default-kie-server	The KIE Server ID.
   org.kie.server.controller	http://localhost:8080/business-central/rest/controller	The location of Business Central. The URL for connecting to the API of Business Central.
   org.kie.server.controller.user	controllerUser	The user name with the role rest-all who can log in to the Business Central.
   org.kie.server.controller.pwd	controllerUser1234;	The password of the user who can log in to the Business Central.
   org.kie.server.location	http://localhost:8080/kie-server/services/rest/server	The location of the KIE Server. The URL for connecting to the API of KIE Server.

   Table 14.2. JVM Properties for the Business Central instance

   Property	Value	Note
   org.kie.server.user	controllerUser	The user name with the role kie-server.
   org.kie.server.pwd	controllerUser1234;	The password of the user.

   The following example shows how to configure a KIE Server instance:

   <property name="org.kie.server.id" value="default-kie-server"/>
   <property name="org.kie.server.controller" value="http://localhost:8080/business-central/rest/controller"/>
   <property name="org.kie.server.controller.user" value="controllerUser"/>
   <property name="org.kie.server.controller.pwd" value="controllerUser1234;"/>
   <property name="org.kie.server.location" value="http://localhost:8080/kie-server/services/rest/server"/>

   The following example shows how to configure a for Business Central instance:

   <property name="org.kie.server.user" value="controllerUser"/>
   <property name="org.kie.server.pwd" value="controllerUser1234;"/>

3. To verify that KIE Server starts successfully, send a GET request to http://SERVER:PORT/kie-server/services/rest/server/ when KIE Server is running. For more information about running Red Hat Process Automation Manager on KIE Server, see Running Red Hat Process Automation Manager.

   After successful authentication, you receive an XML response similar to the following example:

   <response type="SUCCESS" msg="Kie Server info">
       <kie-server-info>
           <capabilities>KieServer</capabilities>
           <capabilities>BRM</capabilities>
           <capabilities>BPM</capabilities>
           <capabilities>CaseMgmt</capabilities>
           <capabilities>BPM-UI</capabilities>
           <capabilities>BRP</capabilities>
           <capabilities>DMN</capabilities>
           <capabilities>Swagger</capabilities>
           <location>http://localhost:8230/kie-server/services/rest/server</location>
           <messages>
               <content>Server KieServerInfo{serverId='first-kie-server', version='7.5.1.Final-redhat-1', location='http://localhost:8230/kie-server/services/rest/server', capabilities=[KieServer, BRM, BPM, CaseMgmt, BPM-UI, BRP, DMN, Swagger]}started successfully at Mon Feb 05 15:44:35 AEST 2018</content>
               <severity>INFO</severity>
               <timestamp>2018-02-05T15:44:35.355+10:00</timestamp>
           </messages>
           <name>first-kie-server</name>
           <id>first-kie-server</id>
           <version>7.5.1.Final-redhat-1</version>
       </kie-server-info>
   </response>

4. Verify successful registration:

   1. Log in to Business Central.

   2. Click Menu → Deploy → Execution Servers.

      If registration is successful, you will see the registered server ID.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add Ons (the rhpam-7.10.0-add-ons.zip file).
3. Extract the rhpam-7.10.0-add-ons.zip file. The rhpam-7.10.0-controller-ee7.zip file is in the extracted directory.
4. Extract the rhpam-7.10.0-controller-ee7 archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

5. Copy the TEMP_DIR/rhpam-7.10.0-controller-ee7/controller.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure that the names of the headless Process Automation Manager controller deployments you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

6. Copy the contents of the TEMP_DIR/rhpam-7.10.0-controller-ee7/SecurityPolicy/ directory to EAP_HOME/bin.
7. When prompted to overwrite files, select Yes.
8. In the EAP_HOME/standalone/deployments/ directory, create an empty file named controller.war.dodeploy. This file ensures that the headless Process Automation Manager controller is automatically deployed when the server starts.

Procedure

1. In a terminal application, navigate to EAP_HOME/bin.

2. If you installed the headless Process Automation Manager controller on the same Red Hat JBoss EAP instance as the Red Hat JBoss EAP instance where you installed the KIE Server, enter one of the following commands:

   • On Linux or UNIX-based systems:

     $ ./standalone.sh -c standalone-full.xml

   • On Windows:

     standalone.bat -c standalone-full.xml

3. If you installed the headless Process Automation Manager controller on a separate Red Hat JBoss EAP instance from the Red Hat JBoss EAP instance where you installed the KIE Server, start the headless Process Automation Manager controller with the standalone.sh script:

   Note

   In this case, ensure that you made all required configuration changes to the standalone.xml file.

   • On Linux or UNIX-based systems:

     $ ./standalone.sh

   • On Windows:

     standalone.bat

4. To verify that the headless Process Automation Manager controller is working on Red Hat JBoss EAP, enter the following command where <CONTROLLER> and <CONTROLLER_PWD> is the user name and password combination that you created in Section 19.1.1, “Creating a headless Process Automation Manager controller user”. The output of this command provides information about the KIE Server instance.

   curl -X GET "http://<HOST>:<PORT>/controller/rest/controller/management/servers" -H  "accept: application/xml" -u '<CONTROLLER>:<CONTROLLER_PWD>'

Procedure

1. Declare the Red Hat Business Automation BOM in the pom.xml file:

   <dependencyManagement>
    <dependencies>
     <dependency>
      <groupId>com.redhat.ba</groupId>
      <artifactId>ba-platform-bom</artifactId>
      <version>7.10.0.redhat-00004</version>
      <type>pom</type>
      <scope>import</scope>
     </dependency>
    </dependencies>
   </dependencyManagement>
   <dependencies>
   <!-- Your dependencies -->
   </dependencies>

2. Declare dependencies required for your project in the <dependencies> tag. After you import the product BOM into your project, the versions of the user-facing product dependencies are defined so you do not need to specify the <version> sub-element of these <dependency> elements. However, you must use the <dependency> element to declare dependencies which you want to use in your project.

3. For standalone projects that are not authored in Business Central, specify all dependencies required for your projects. In projects that you author in Business Central, the basic decision engine and process engine dependencies are provided automatically by Business Central.

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies, depending on the features that you want to use:

     Embedded process engine dependencies

     <!-- Public KIE API -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <!-- Core dependencies for process engine -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow-builder</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-bpmn2</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-runtime-manager</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-persistence-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-query-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-audit</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <!-- Dependency needed for default WorkItemHandler implementations. -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-workitems-core</artifactId>
     </dependency>
     
     <!-- Logging dependency. You can use any logging framework compatible with slf4j. -->
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>${logback.version}</version>
     </dependency>

   • For a Red Hat Process Automation Manager project that uses CDI, you typically declare the following dependencies:

     CDI-enabled process engine dependencies

     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-services-cdi</artifactId>
     </dependency>

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies:

     Embedded decision engine dependencies

     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-compiler</artifactId>
     </dependency>
     
     <!-- Dependency for persistence support. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-persistence-jpa</artifactId>
     </dependency>
     
     <!-- Dependencies for decision tables, templates, and scorecards.
     For other assets, declare org.drools:business-central-models-* dependencies. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-decisiontables</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-templates</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-scorecards</artifactId>
     </dependency>
     
     <!-- Dependency for loading KJARs from a Maven repository using KieScanner. -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-ci</artifactId>
     </dependency>

   • To use the KIE Server, declare the following dependencies:

     Client application KIE Server dependencies

     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-client</artifactId>
     </dependency>

   • To create a remote client for Red Hat Process Automation Manager, declare the following dependency:

     Client dependency

     <dependency>
       <groupId>org.uberfire</groupId>
       <artifactId>uberfire-rest-client</artifactId>
     </dependency>

   • When creating a JAR file that includes assets, such as rules and process definitions, specify the packaging type for your Maven project as kjar and use org.kie:kie-maven-plugin to process the kjar packaging type located under the <project> element. In the following example, ${kie.version} is the Maven library version listed in What is the mapping between Red Hat Process Automation Manager and the Maven library version?:

     <packaging>kjar</packaging>
     <build>
      <plugins>
       <plugin>
        <groupId>org.kie</groupId>
        <artifactId>kie-maven-plugin</artifactId>
        <version>${kie.version}</version>
        <extensions>true</extensions>
       </plugin>
      </plugins>
     </build>

Procedure

1. Create a Maven settings.xml file with connection and access details for your external repository. For details about the settings.xml file, see the Maven Settings Reference.
2. Save the file in a known location, for example, /opt/custom-config/settings.xml.
3. In your Red Hat Process Automation Manager installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for Red Hat Process Automation Manager, go to $EAP_HOME/standalone/configuration/standalone-full.xml.

4. Open standalone-full.xml and under the <system-properties> tag, set the kie.maven.settings.custom property to the full path name of the settings.xml file.

   For example:

   <property name="kie.maven.settings.custom" value="/opt/custom-config/settings.xml"/>

5. Start or restart Business Central and KIE Server.

Procedure

1. On the computer that has an outgoing connection to the public Internet, complete the following steps:

2. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Red Hat Process Automation Manager

   • Version: 7.10

     1. Download and extract the Red Hat Process Automation Manager 7.10.0 Offliner Content List (rhpam-7.10.0-offliner.zip) product deliverable file.
     2. Extract the contents of the rhpam-7.10.0-offliner.zip file into any directory.

     3. Change to the directory and enter the following command:

        ./offline-repo-builder.sh offliner.txt

        This command creates the repository subdirectory and downloads the necessary artifacts into this subdirectory. This is the mirror repository.

        If a message reports that some downloads have failed, run the same command again. If downloads fail again, contact Red Hat support.

3. If you developed services outside of Business Central and they have additional dependencies, add the dependencies to the mirror repository. If you developed the services as Maven projects, you can use the following steps to prepare these dependencies automatically. Complete the steps on the computer that has an outgoing connection to the public Internet.

   1. Create a backup of the local Maven cache directory (~/.m2/repository) and then clear the directory.
   2. Build the source of your projects using the mvn clean install command.

   3. For every project, enter the following command to ensure that Maven downloads all runtime dependencies for all the artifacts generated by the project:

      mvn -e -DskipTests dependency:go-offline -f /path/to/project/pom.xml --batch-mode -Djava.net.preferIPv4Stack=true

      Replace /path/to/project/pom.xml with the path of the pom.xml file of the project.

   4. Copy the contents of the local Maven cache directory (~/.m2/repository) to the repository subdirectory that was created.
4. Copy the contents of the repository subdirectory to a directory on the computer on which you deployed Red Hat Process Automation Manager. This directory becomes the offline Maven mirror repository.
5. Create and configure a settings.xml file for your Red Hat Process Automation Manager deployment as described in Section 21.2, “Configuring an external Maven repository for Business Central and KIE Server”.

6. Make the following changes in the settings.xml file:

   • Under the <profile> tag, if a <repositories> or <pluginRepositores> tag is missing, add the missing tags.

   • Under <repositories> add the following content:

     <repository>
       <id>offline-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.

   • Under <pluginRepositories> add the following content:

     <repository>
       <id>offline-plugin-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.

7. Set the kie.maven.offline.force property for Business Central to true. For instructions about setting properties for Business Central, see Installing and configuring Red Hat Process Automation Manager on Red Hat JBoss EAP 7.3.

Procedure

1. Start Red Hat JBoss EAP and open Business Central in a web browser.
2. Copy an SVG format image to the EAP_HOME/standalone/deployments/business-central.war/img/ directory in your Red Hat Process Automation Manager installation.
3. In the EAP_HOME/standalone/deployments/business-central.war/img/ directory, either move or rename the existing redhat_logo.png file.
4. Rename your PNG file redhat_logo.png.
5. To change the project logo that appears above the User name and Password fields, replace the default image BC_Logo.png with a new SVG file.
6. Force a full reload of the login page, bypassing the cache, to view the changes. For example, in most Linux and Windows web browsers, press Ctrl+F5.

Procedure

1. Start Red Hat JBoss EAP, open Business Central in a web browser, and log in with your user credentials.
2. Copy your new application header image in the SVG format to the EAP_HOME/standalone/deployments/business-central.war/banner/ directory in your Red Hat Process Automation Manager installation.
3. Open the EAP_HOME/standalone/deployments/business-central.war/banner/banner.html file in a text editor.

4. Replace logo.png in the <img> tag with the file name of your new image:admin-and-config/

   <img src="banner/logo.png"/>

5. Force a full reload of the login page, bypassing the cache, to view the changes. For example, in most Linux and Windows web browsers, press Ctrl+F5.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add Ons (rhpam-7.10.0-add-ons.zip) and extract the ZIP file.
3. Navigate to the directory that contains the extracted files and extract the rhpam-7.10.0-dashbuilder-runtime.zip file.
4. Copy the contents of the dashbuilder-runtime.zip file that you extracted into the <EAP_HOME>/standalone/deployments folder.

5. In the Red Hat JBoss EAP home directory, enter the following command to create a user with the admin role and specify a password. In the following example, replace <USER_NAME> and <PASSWORD> with the user name and password of your choice.

   $<EAP_HOME>/bin/add-user.sh -a -e -u <USER_NAME> -p <PASSWORD> -g admin

6. In a terminal application, navigate to EAP_HOME/bin.

7. Enter the following command to start Red Hat JBoss EAP:

   • On Linux or UNIX-based systems:

     $ ./standalone.sh -c standalone-full.xml

   • On Windows:

     standalone.bat -c standalone-full.xml

8. In a web browser, open the URL http://localhost:8080.
9. Log in using the credentials of the user that you created for Dashbuilder Runtime.
10. When promted, upload a dashboard that you exported from Business Central. Dashbuilder Runtime uses that dashboard until it is restarted.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Data Grid
   • Version: 7.3
2. Download and extract the Red Hat JBoss Data Grid 7.3.0 Server (jboss-datagrid-7.3.0-1-server.zip) installation file to the preferred location on your system. In the following examples, the extracted directory is referred to as JDG_HOME.
3. Update Red Hat Data Grid to the latest version. For more information, see Red Hat Data Grid Red Hat Data Grid User Guide.

4. To run Red Hat Data Grid, navigate to JDG_HOME/bin and enter the following command:

   $ ./standalone.sh -c clustered.xml -b <HOST>

   Replace <HOST> with the IP address or host name of the server where you installed Red Hat Data Grid.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: AMQ Broker
   • Version: 7.8.0
2. Click Download next to Red Hat AMQ Broker 7.8.0 (amq-broker-7.8.0-bin.zip).
3. Extract the amq-broker-7.8.0-bin.zip file.
4. Change directory to amq-broker-7.8.0-bin/amq-broker-7.8.0/bin.

5. Enter the following command to create the broker and broker user:

   ./artemis create --host <HOST> --user <AMQ_USER> --password <AMQ_PASSWORD> --require-login <BROKER_NAME>

   In this example, replace the following placeholders:

   • <HOST> is the IP address or host name of the server where you installed AMQ Broker.
   • <AMQ_USER> and <AMQ_PASSWORD> is a user name and password combination of your choice.
   • <BROKER_NAME> is a name for the broker that you are creating.

6. To run AMQ Broker, navigate to the amq-broker-7.8.0-bin/amq-broker-7.8.0/bin directory and enter the following command:

   <BROKER_NAME>/bin/artemis run

Procedure

1. Configure a server to export NFS version 4 shares. For instructions about exporting NFS shares on Red Hat Enterprise Linux, see Exporting NFS shares in Managing file systems. For more information about creating the NFS server, see How to configure NFS in RHEL 7.
2. On the server, open the /etc/exports file in a text editor.

3. Add the following line to the /etc/exports file where <HOST_LIST> is a space-separated list of IP addresses and options of hosts that are authorized to connect to the server:

   /opt/kie/data <HOST_LIST>

   For example:

   /opt/kie/data 192.268.1.0/24(rw,sync) 192.268.1.1/24(no_root_squash)

   This creates an /opt/kie/data share with the rw,sync,no_root_squash minimum options that are required for NFS.

   Note

   You can use a different share name instead of /opt/kie/data. If you do, you must use the different name when configuring all nodes that run Business Central.

Procedure

1. Download Red Hat JBoss EAP 7.3 on each node of the cluster:

   1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

      • Product: Enterprise Application Platform
      • Version: 7.3
   2. Click Download next to Red Hat JBoss Enterprise Application Platform 7.3.0. (JBEAP-7.3.0/jboss-eap-7.3.0.zip).
2. Extract the jboss-eap-7.3.0.zip file. In the following steps, EAP_HOME is the jboss-eap-7.3/jboss-eap-7.3 directory.
3. Download and apply the latest Red Hat JBoss EAP patch, if available.

4. Download Red Hat Process Automation Manager on each node of the cluster:

   1. Navigate to the Software Downloads page in the Red Hat Customer Portal, and select the product and version from the drop-down options:

      • Product: Process Automation Manager
      • Version: 7.10
   2. Download Red Hat Process Automation Manager 7.10.0 Business Central Deployable for Red Hat JBoss EAP 7 (rhpam-7.10.0-business-central-eap7-deployable.zip).
5. Extract the rhpam-7.10.0-business-central-eap7-deployable.zip file to a temporary directory. In the following commands this directory is called TEMP_DIR.
6. Copy the contents of TEMP_DIR/rhpam-7.10.0-business-central-eap7-deployable/jboss-eap-7.3 to EAP_HOME.
7. Download and apply the latest Red Hat Process Automation Manager patch, if available.
8. Configure Red Hat Single Sign-On for your high availability environment. For more information, see Integrating Red Hat Process Automation Manager with Red Hat Single Sign-On and the Red Hat Single Sign-On Server Administration Guide.

Procedure

1. To mount the directory shared over NFS as /data, enter the following commands as the root user:

   mkdir /data
   mount <NFS_SERVER_IP>:<DATA_SHARE> /data

   Replace <NFS_SERVER_IP> with the IP address or hostname of the NFS server system. Replace <DATA_SHARE> with the share name that you configured (for example, /opt/kie/data).

2. Create a kie-wb-playground directory in the /data NFS directory:

   mkdir /kie-wb-playground

3. Create a kie-wb-playground directory in the EAP_HOME/bin directory and mount the directory:

   mount -o rw,sync,actimeo=1 <NFS_SERVER_IP>:<DATA_SHARE>/kie-wb-playground kie-wb-playground

4. Open the EAP_HOME/standalone/configuration/standalone-full.xml file in a text editor.

5. Edit or add the properties under the <system-properties> element and replace the following placeholders:

   • <AMQ_USER> and <AMQ_PASSWORD> are the credentials that you defined when creating the AMQ Broker.
   • <AMQ_BROKER_IP_ADDRESS> is the IP address of the AMQ Broker.

   • <DATA_GRID_NODE_IP> is the IP address where Red Hat Data Grid is installed.

     <system-properties>
       <property name="appformer-jms-connection-mode" value="REMOTE"/>
       <property name="appformer-jms-username" value="<AMQ_USER>"/>
       <property name="appformer-jms-password" value="<AMQ_USER_PASSWORD>"/>
       <property name="appformer-jms-url"
          value="tcp://<AMQ_BROKER_IP_ADDRESS>:61616?ha=true&amp;retryInterval=1000&amp;retryIntervalMultiplier=1.0&amp;reconnectAttempts=-1"/>
       <property name="org.appformer.ext.metadata.infinispan.port"
          value="11222"/>
       <property name="org.appformer.ext.metadata.infinispan.host"
          value="<DATA_GRID_NODE_IP>"/>
       <property name="org.appformer.ext.metadata.infinispan.realm"
          value="ApplicationRealm"/>
       <property name="org.appformer.ext.metadata.infinispan.cluster"
          value="kie-cluster"/>
       <property name="org.appformer.ext.metadata.index"
          value="infinispan"/>
       <property name="org.uberfire.nio.git.dir"
          value="/data"/>
       <property name="es.set.netty.runtime.available.processors"
          value="false"/>
     </system-properties>

6. Optional: If the Red Hat Data Grid deployment requires authentication, edit or add the properties under the <system-properties> element and replace the following placeholders:

   • <SERVER_NAME> is the server name specified in your Red Hat Data Grid server configuration.

   • <SASL_QOP> is the combination of auth, auth-int and auth-conf values for your Red Hat Data Grid server configuration.

     <property name="org.appformer.ext.metadata.infinispan.server.name"
        value="<SERVER_NAME>"/>
     <property name="org.appformer.ext.metadata.infinispan.sasl.qop"
        value="<SASL_QOP>"/>
     <property name="org.appformer.ext.metadata.infinispan.username"
        value=""/>
     <property name="org.appformer.ext.metadata.infinispan.password"
        value=""/>

7. Save the standalone-full.xml file.

8. To start the cluster, navigate to EAP_HOME/bin and enter the following command:

   $ ./standalone.sh -c standalone-full.xml -b <HOST>

   Replace <HOST> with the IP address or host name of the server where you installed Red Hat Process Automation Manager.

Procedure

1. Test the network speed:

   1. In the command terminal of each server node, install iPerf3:

      $ dnf install iperf3

   2. In the command terminal of the NFS server node (server node 3), start iPerf3 in server mode:

      $ iperf3 -s

   3. In the command terminal of each Business Central server node, enter the following command to start iPerf3 in client mode with the NFS server node set as the host:

      $ iperf3 -c <NFS_SERVER_IP>
      +
      In this example, replace `<NFS_SERVER_IP>` with the IP address of the NFS server.

   4. Compare the results from each server node with the following example of minimum values:

      iperf3 -c 172.31.47.103
      Connecting to host 172.31.47.103, port 5201
      [  5] local 172.31.39.4 port 44820 connected to 172.31.47.103 port 5201
      [ ID] Interval           Transfer     Bitrate         Retr  Cwnd
      [  5]   0.00-1.00   sec   143 MBytes  1.20 Gbits/sec    0    419 KBytes
      [  5]   1.00-2.00   sec   111 MBytes   928 Mbits/sec    6    848 KBytes
      [  5]   2.00-3.00   sec  53.8 MBytes   451 Mbits/sec    0   1.08 MBytes
      [  5]   3.00-4.00   sec  52.5 MBytes   440 Mbits/sec    1   1022 KBytes
      [  5]   4.00-5.00   sec  53.8 MBytes   451 Mbits/sec    1    935 KBytes
      [  5]   5.00-6.00   sec  53.8 MBytes   451 Mbits/sec    1    848 KBytes
      [  5]   6.00-7.00   sec  52.5 MBytes   440 Mbits/sec    0   1.08 MBytes
      [  5]   7.00-8.00   sec  53.8 MBytes   451 Mbits/sec    1   1.01 MBytes
      [  5]   8.00-9.00   sec  53.8 MBytes   451 Mbits/sec    1    953 KBytes
      [  5]   9.00-10.00  sec  52.5 MBytes   440 Mbits/sec    1    856 KBytes
      - - - - - - - - - - - - - - - - - - - - - - - - -
      [ ID] Interval           Transfer     Bitrate         Retr
      [  5]   0.00-10.00  sec   680 MBytes   570 Mbits/sec   12             sender
      [  5]   0.00-10.04  sec   677 MBytes   566 Mbits/sec                  receiver
      
      iperf Done.

2. Verify the NFS information:

   1. In the command terminal of each Business Central server node, mount the NFS node:

      $ mount -o actimeo=1 <NFS_SERVER_IP>:/opt/nfs/kie /opt/kie/niogit

   2. In the command terminal of each mounted node, enter nfsiostat:

      $ nfsiostat

   3. Compare the results from each server node with the following example of minimum values:

      nfsiostat
      ops/s	rpc bklog
      6.415	0.000
      
      read:
      ops/s	kB/s	kB/op	retrans	avg RTT (ms)	avg exe (ms)	avg queue (ms)	errors
      0.031	0.045	1.452	0 (0.0%)	0.129		0.166		0.019		0 (0.0%)
      
      write:
      ops/s	kB/s	kB/op	retrans	avg RTT (ms)	avg exe (ms)	avg queue (ms)	errors
      0.517	0.467	0.903	0 (0.0%)	1.235		1.269		0.01 8		0 (0.0%)

3. Verify that the disk is an SSD:

   1. In the command terminal of the NFS server, enter df -h to identify the disk as shown in the following example:

      $ df -h
      Filesystem               Size  Used Avail Use% Mounted on
      devtmpfs                 3.8G     0  3.8G   0% /dev
      tmpfs                    3.9G     0  3.9G   0% /dev/shm
      tmpfs                    3.9G   33M  3.8G   1% /run
      tmpfs                    3.9G     0  3.9G   0% /sys/fs/cgroup
      /dev/xvda2                25G  3.2G   22G  13% /
      tmpfs                    781M     0  781M   0% /run/user/1000
      172.31.47.103:/root/nfs   25G  2.1G   23G   9% /root/nfs

   2. Enter lsblk -d to verify that the disk is an SSD:

      $ lsblk -d

   3. Enter hdparm -Tt to test the disk:

      $ hdparm -Tt /dev/xvda2

   4. Compare the results from each server node with the following example of minimum values:

      $ hdparm -Tt /dev/xvda2
      
      /dev/xvda2:
       Timing cached reads:   18670 MB in  1.99 seconds = 9389.01 MB/sec
       Timing buffered disk reads: 216 MB in  3.03 seconds =  71.40 MB/sec

Procedure

1. In a web browser, enter <node-IP-address>:8080/business-central. Replace <node-IP-address> with the IP address of a particular node.
2. Enter the admin user credentials that you created during installation. The Business Central home page appears.
3. Select Menu → Design → Projects.
4. Open the MySpace space.
5. Click Try Samples → Mortgages → OK. The Assets window appears.
6. Click Add Asset → Data Object.
7. Enter MyDataObject in the Data Object field and click OK.
8. Click Spaces → MySpace → Mortgages and confirm that MyDataObject is in the list of assets.

9. Enter the following URL in a web browser, where <node_IP_address> is the address of a different node of the cluster:

   http://<node_IP_address>:8080/business-central

10. Enter the same credentials that you used to log in to Business Central on the first node, where you created the MyDataObject asset.
11. Select Menu→ Design → Projects.
12. Open the MySpace space.
13. Select the Mortgages project.
14. Verify that MyDataObject is in the asset list.
15. Delete the Mortgages project.

Procedure

1. Download Red Hat JBoss EAP 7.3 on each node of the cluster:

   1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required) and select the product and version from the drop-down options:

      • Product: Enterprise Application Platform
      • Version: 7.3
   2. Click Download next to Red Hat JBoss Enterprise Application Platform 7.3.0. (jboss-eap-7.3.0.zip).
2. Extract the jboss-eap-7.3.0.zip file. The jboss-eap-7.3/jboss-eap-7.3 directory is referred to as EAP_HOME.
3. Download and apply the latest Red Hat JBoss EAP patch, if available.

4. Download KIE Server:

   1. Navigate to the Software Downloads page in the Red Hat Customer Portal and select the product and version from the drop-down options:

      • Product: Process Automation Manager
      • Version: 7.10
   2. Download Red Hat Process Automation Manager 7.10.0 KIE Server for All Supported EE8 Containers (rhpam-7.10.0-kie-server-ee8.zip).
5. Extract the rhpam-7.10.0-kie-server-ee8.zip archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

6. Copy the TEMP_DIR/rhpam-7.10.0-kie-server-ee8/rhpam-7.10.0-kie-server-ee8/kie-server.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure the names of the Red Hat Process Automation Manager deployments you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

7. Copy the contents of the TEMP_DIR/rhpam-7.10.0-kie-server-ee8/rhpam-7.10.0-kie-server-ee8/SecurityPolicy/ to EAP_HOME/bin.
8. When prompted to overwrite files, click Replace.
9. In the EAP_HOME/standalone/deployments/ directory, create an empty file named kie-server.war.dodeploy. This file ensures that KIE Server is automatically deployed when the server starts.
10. Download and apply the latest Red Hat Process Automation Manager patch, if available.
11. Navigate to the EAP_HOME/bin directory.

12. Create a user with the kie-server role that you will use to log in to KIE Server.

    $ ./add-user.sh -a --user <USERNAME> --password <PASSWORD> --role kie-server

13. Make a note of your user names and passwords.

Procedure

1. Install the JDBC driver on all Red Hat JBoss EAP instances that are part of this cluster. For more information, see the "JDBC Drivers" section of the Red Hat JBoss EAP 7.3 Configuration Guide.
2. Open the EAP_HOME/standalone/configuration/standalone-full.xml file in a text editor.

3. Edit the data-stores property and the timer-service thread-pool-name above it:

   • The datasource-jndi-name is the JNDI name of the database specified at the beginning of this procedure.
   • You can enter any name for the value of the partition property. However, a node will only see timers from other nodes that have the same partition name. Grouping nodes into partitions by assigning partition names enables you to break a large cluster up into several smaller clusters. Doing this improves performance. For example, instead of having a cluster of 100 nodes, where all 100 nodes are trying to execute and refresh the same timers, you can create 20 clusters of 5 nodes by giving every group of 5 a different partition name.
   • Replace the default-data-store attribute value with ejb_timer_ds.

   • Set the value of refresh-interval in milliseconds to specify how often the EJB timer connects to the database to synchronize and load tasks to be processed.

     <timer-service thread-pool-name="default" default-data-store="ejb_timer_ds">
     <data-stores>
         <database-data-store name="ejb_timer_ds" datasource-jndi-name="java:jboss/datasources/ejb_timer" database="postgresql" partition="ejb_timer_part" refresh-interval="30000"/>
     </data-stores>
     </timer-service>

     The following table lists the supported databases and the corresponding database attribute value:

     Table 30.1. Supported databases

     Database	Attribute value
     Hyper SQL (for demonstration purposes only, not supported)	hsql
     PostgreSQL	postgresql
     Oracle	oracle
     IBM DB2	db2
     Microsoft SQL Server	mssql
     MySQL and MariaDB	mysql

4. Add the KIE Server and EJB timer data sources to the standalone-full.xml file. In these examples, <DATABASE> is the name of the database, <SERVER_NAME> is the host name of the JNDI database, and <USER_NAME> and <USER_PWD> are the credentials for that database.

   • Add the data source to allow KIE Server to connect to the database, for example:

     <xa-datasource jndi-name="java:/jboss/datasources/rhpam" pool-name="rhpam-RHPAM" use-java-context="true" enabled="true">
       <xa-datasource-property name="DatabaseName"><DATABASE></xa-datasource-property>
       <xa-datasource-property name="PortNumber">5432</xa-datasource-property>
       <xa-datasource-property name="ServerName"><SERVER_NAME></xa-datasource-property>
       <driver>postgresql</driver>
       <security>
         <user-name><USER_NAME></user-name>
         <password><USER_PWD></password>
     </security>
     </xa-datasource>

   • Add the data source to enable the EJB timer, for example:

     <xa-datasource jndi-name="java:jboss/datasources/ejb_timer" pool-name="ejb_timer" use-java-context="true" enabled="true">
         <xa-datasource-property name="DatabaseName"><DATABASE></xa-datasource-property>
         <xa-datasource-property name="PortNumber">5432</xa-datasource-property>
         <xa-datasource-property name="ServerName"><SERVER_NAME></xa-datasource-property>
         <driver>postgresql</driver>
         <transaction-isolation>TRANSACTION_READ_COMMITTED</transaction-isolation>
         <security>
             <user-name><USER_NAME></user-name>
             <password><USER_PWD></password>
         </security>
     </xa-datasource>

     Warning

     You must use two different databases for KIE Server runtime data and EJB timer data.

5. Add the following properties to the <system-properties> element and replace the following placeholders:

   • <JNDI_NAME> is the JNDI name of your data source. For Red Hat Process Automation Manager, this is java:/jboss/datasources/rhpam.

   • <DIALECT> is the hibernate dialect for your database.

     The following dialects are supported:

     • DB2: org.hibernate.dialect.DB2Dialect
     • MSSQL: org.hibernate.dialect.SQLServer2012Dialect
     • MySQL: org.hibernate.dialect.MySQL5InnoDBDialect
     • MariaDB: org.hibernate.dialect.MySQL5InnoDBDialect
     • Oracle: org.hibernate.dialect.Oracle10gDialect
     • PostgreSQL: org.hibernate.dialect.PostgreSQL82Dialect

     • PostgreSQL plus: org.hibernate.dialect.PostgresPlusDialect

       <system-properties>
         <property name="org.kie.server.persistence.ds" value="<JNDI_NAME>"/>
         <property name="org.kie.server.persistence.dialect" value="<DIALECT>"/>
         <property name="org.jbpm.ejb.timer.tx" value="true"/>
       </system-properties>

6. Save the standalone-full.xml file.

7. To start the cluster, navigate to EAP_HOME/bin and enter one of the following commands:

   • On Linux or UNIX-based systems:

     $ ./standalone.sh -c standalone-full.xml

   • On Windows:

     standalone.bat -c standalone-full.xml

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add Ons (the rhpam-7.10.0-add-ons.zip file).
3. Extract the rhpam-7.10.0-add-ons.zip file. The rhpam-7.10.0-controller-ee7.zip file is in the extracted directory.
4. Extract the rhpam-7.10.0-controller-ee7 archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

5. Copy the TEMP_DIR/rhpam-7.10.0-controller-ee7/controller.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure that the names of the headless Process Automation Manager controller deployments you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

6. Copy the contents of the TEMP_DIR/rhpam-7.10.0-controller-ee7/SecurityPolicy/ directory to EAP_HOME/bin.
7. When prompted to overwrite files, click Yes.
8. In the EAP_HOME/standalone/deployments/ directory, create an empty file named controller.war.dodeploy. This file ensures that the headless Process Automation Manager controller is automatically deployed when the server starts.
9. Open the EAP_HOME/standalone/configuration/standalone.xml file in a text editor.

10. Add the following properties to the <system-properties> element and replace <NFS_STORAGE> with the absolute path to the NFS storage where the template configuration is stored:

    <system-properties>
      <property name="org.kie.server.controller.templatefile.watcher.enabled" value="true"/>
      <property name="org.kie.server.controller.templatefile" value="<NFS_STORAGE>"/>
    </system-properties>

    Template files contain default configurations for specific deployment scenarios.

    If the value of the org.kie.server.controller.templatefile.watcher.enabled property is set to true, a separate thread is started to watch for modifications of the template file. The default interval for these checks is 30000 milliseconds and can be further controlled by the org.kie.server.controller.templatefile.watcher.interval system property. If the value of this property is set to false, changes to the template file are detected only when the server restarts.

11. To start the headless Process Automation Manager controller, navigate to EAP_HOME/bin and enter the following command:

    • On Linux or UNIX-based systems:

      $ ./standalone.sh

    • On Windows:

      standalone.bat

Procedure

1. Prepare the environment:

   1. Verify that the following extensions are present in the standalone.xml file and add them if necessary:

      <extension module="org.jboss.as.clustering.infinispan"/>
      <extension module="org.jboss.as.clustering.jgroups"/>

   2. In the standalone.xml file, locate the <subsystem xmlns="urn:jboss:domain:infinispan:9.0"> subsystem and create a cached container entry named jbpm that includes a cache named nodes and a cache named jobs as shown in the following example:

      <cache-container name="jbpm">
        <transport lock-timeout="60000"/>
        <replicated-cache name="nodes">
            <transaction mode="BATCH"/>
        </replicated-cache>
        <replicated-cache name="jobs">
            <transaction mode="BATCH"/>
        </replicated-cache>
      </cache-container>

   3. Add the jgroups subsystem for the replicated and distributed caches:

      <subsystem xmlns="urn:jboss:domain:jgroups:7.0">
          <channels default="ee">
              <channel name="ee" stack="udp" cluster="ejb"/>
          </channels>
          <stacks>
              <stack name="udp">
                  <transport type="UDP" socket-binding="jgroups-udp"/>
                  <protocol type="PING"/>
                  <protocol type="MERGE3"/>
                  <socket-protocol type="FD_SOCK" socket-binding="jgroups-udp-fd"/>
                  <protocol type="FD_ALL"/>
                  <protocol type="VERIFY_SUSPECT"/>
                  <protocol type="pbcast.NAKACK2"/>
                  <protocol type="UNICAST3"/>
                  <protocol type="pbcast.STABLE"/>
                  <protocol type="pbcast.GMS"/>
                  <protocol type="UFC"/>
                  <protocol type="MFC"/>
                  <protocol type="FRAG3"/>
                </stack>
                <stack name="tcp">
                  <transport type="TCP" socket-binding="jgroups-tcp"/>
                  <socket-protocol type="MPING" socket-binding="jgroups-mping"/>
                  <protocol type="MERGE3"/>
                  <socket-protocol type="FD_SOCK" socket-binding="jgroups-tcp-fd"/>
                  <protocol type="FD_ALL"/>
                  <protocol type="VERIFY_SUSPECT"/>
                  <protocol type="pbcast.NAKACK2"/>
                  <protocol type="UNICAST3"/>
                  <protocol type="pbcast.STABLE"/>
                  <protocol type="pbcast.GMS"/>
                  <protocol type="MFC"/>
                  <protocol type="FRAG3"/>
                </stack>
            </stacks>
          </subsystem>

   4. Configure the following interface:

      <interface name="private">
          <inet-address value="${jboss.bind.address.private:127.0.0.1}"/>
      </interface>

   5. Configure the following socket:

      <socket-binding name="jgroups-mping" interface="private" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45700"/>
      
        <socket-binding name="jgroups-tcp" interface="private" port="7600"/>
        <socket-binding name="jgroups-tcp-fd" interface="private" port="57600"/>
        <socket-binding name="jgroups-udp" interface="private" port="55200" multicast-address="${jboss.default.multicast.address:230.0.0.4}" multicast-port="45688"/>
        <socket-binding name="jgroups-udp-fd" interface="private" port="54200"/>

2. Add the Infinispan extension to KIE Server:

   1. Open the kie-server.war/WEB-INF/jboss-deployment-structure.xml file in a text editor and add the following dependencies to the file:

          <module name="org.infinispan" services="export"/>
          <module name="org.jgroups" />

   2. Download the JAR file.

      1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

         • Product: Process Automation Manager
         • Version: 7.10
      2. Download Red Hat Process Automation Manager 7.10.0 Maven Repository (rhpam-7.10.0-maven-repository.zip) and extract the ZIP file.
      3. Navigate to the directory containing the extracted files and copy the maven-repository/org/kie/server/kie-server-services-jbpm-cluster/7.48.0.Final-redhat-00004/kie-server-services-jbpm-cluster-7.48.0.Final-redhat-00004.jar file to the kie-server.war/WEB-INF/lib directory.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add-Ons.
3. Extract the downloaded rhpam-7.10.0-add-ons.zip file to a temporary directory. The rhpam-7.10.0-smart-router.jar file is in the extracted rhpam-7.10.0-add-ons directory.
4. Copy the rhpam-7.10.0-smart-router.jar file to the location where you will run the file.

5. Enter the following command to start Smart Router:

   java
   -Dorg.kie.server.router.host=<ROUTER_HOST>
   -Dorg.kie.server.router.port=<ROUTER_PORT>
   -Dorg.kie.server.controller=<CONTROLLER_URL>
   -Dorg.kie.server.controller.user=<CONTROLLER_USER>
   -Dorg.kie.server.controller.pwd=<CONTROLLER_PWD>
   -Dorg.kie.server.router.config.watcher.enabled=true
   -Dorg.kie.server.router.repo=<NFS_STORAGE>
   -jar rhpam-7.9.0-smart-router.jar

   The properties in the preceding command have the following default values:

   org.kie.server.router.host=localhost
   org.kie.server.router.port=9000
   org.kie.server.controller= N/A
   org.kie.server.controller.user=kieserver
   org.kie.server.controller.pwd=kieserver1!
   org.kie.server.router.repo= <CURRENT_WORKING_DIR>
   org.kie.server.router.config.watcher.enabled=false

   org.kie.server.controller is the URL of the server controller, for example:

   org.kie.server.controller=http://<HOST>:<PORT>/controller/rest/controller

   org.kie.server.router.config.watcher.enabled is an optional settings to enable the watcher service system property.

6. On every KIE Server instance that must connect to the Smart Router, set the org.kie.server.router system property to the Smart Router URL.

7. To access Smart Router from the client side, use the Smart Router URL instead of the KIE Server URL, for example:

   KieServicesConfiguration config = KieServicesFactory.newRestConfiguration("http://smartrouter.example.com:9000", "USERNAME", "PASSWORD");

   In this example, smartrouter.example.com is the Smart Router URL, and USERNAME and PASSWORD are the log in credentials for the Smart Router configuration.

8. To create a new container in an umanaged KIE Server so that you can fill it with example data, send the following HTTP request:

   $ curl -v -X POST -H 'Content-type: application/xml' -H 'X-KIE-Content-Type: xstream' -d @create-container.xml -u ${KIE_CRED} http://${KIE-SERVER-HOST}:${KIE-SERVER-PORT}/kie-server/services/rest/server/config/

9. Review the contents the create-container.xml file:

   <script>
     <create-container>
       <container container-id="example:timer-test:1.1">
         <release-id>
           <group-id>example</group-id>
           <artifact-id>timer-test</artifact-id>
           <version>1.1</version>
         </release-id>
         <config-items>
           <itemName>RuntimeStrategy</itemName>
           <itemValue>PER_PROCESS_INSTANCE</itemValue>
           <itemType></itemType>
         </config-items>
       </container>
     </create-container>
   </script>

   A message about the deployed container is displayed in the Smart Router console. For example:

   INFO: Added http://localhost:8180/kie-server/services/rest/server as server location for container example:timer-test:1.1

10. To display a list of containers, enter the following command:

    $ curl http://localhost:9000/mgmt/list

    The list of containers is displayed:

    {
      "containerInfo": [{
        "alias": "timer-test",
        "containerId": "example:timer-test:1.1",
        "releaseId": "example:timer-test:1.1"
      }],
      "containers": [
        {"example:timer-test:1.1": ["http://localhost:8180/kie-server/services/rest/server"]},
        {"timer-test": ["http://localhost:8180/kie-server/services/rest/server"]}
      ],
      "servers": [
        {"kieserver2": []},
        {"kieserver1": ["http://localhost:8180/kie-server/services/rest/server"]}
      ]
    }

11. To initiate a process using the Smart Router URL, enter the following command:

    $ curl -s -X POST -H 'Content-type: application/json' -H 'X-KIE-Content-Type: json' -d '{"timerDuration":"9s"}' -u kieserver:kieserver1! http://localhost:9000/containers/example:timer-test:1.1/processes/timer-test.TimerProcess/instances

Procedure

1. In a terminal window, navigate to the directory where you downloaded the installer JAR file and enter the following command:

   java -jar rhpam-installer-7.10.0.jar

   Note

   When running the installer on Windows, you may be prompted to provide administrator credentials during the installation. To prevent this requirement, add the izpack.mode=privileged option to the installation command:

   java -Dizpack.mode=privileged -jar
   rhpam-installer-7.10.0.jar

   Furthermore, when running the installer on a 32-bit Java virtual machine, you might encounter memory limitations. To prevent this issue, run this command:

   java -XX:MaxHeapSize=4g -jar
   rhpam-installer-7.10.0.jar

   The graphical installer displays a splash screen and a license agreement page.

2. Click I accept the terms of this license agreement and click Next.
3. Specify the Red Hat JBoss Web Server 5.4.0 server home where you want to install Red Hat Process Automation Manager and click Next.

4. Select the components that you want to install and click Next.

   You cannot install Business Central on Red Hat JBoss Web Server. You can only install it on Red Hat JBoss EAP. However, you can install KIE Server and the headless Process Automation Manager controller on Red Hat JBoss Web Server. The headless Process Automation Manager controller is used to manage KIE Server. Install the headless Process Automation Manager controller if you plan to manage multiple KIE Server instances.

5. Create a user and click Next. By default, if you install both Business Central and KIE Server in the same container the new user is given the admin, kie-server, and rest-all roles. If you install only KIE Server, the user is given the kie-server role. The kie-server role is required to access KIE Server REST capabilities.

   Note

   Make sure that the specified user name is not the same as an existing user, role, or group. For example, do not create a user with the user name admin.

   The password must have at least eight characters and must contain at least one number and one non-alphanumeric character, but not & (ampersand).

   Make a note of the user name and password. You will need them to access Business Central and KIE Server.

6. On the Installation Overview page, review the components that you will install and click Next to start the installation.
7. When the installation has completed, click Next.

8. If KIE Server is installed, the Configure Runtime step appears under Component Installation. On the Configure Runtime Environment page, choose to perform the default installation or perform an advanced configuration.

   If you choose Perform advanced configuration, you can choose to configure database settings or customize certain KIE Server options.

9. If you selected Customize database settings, on the JDBC Drive Configuration page specify a data source JDBC driver vendor, select one or more driver JAR files, and click Next.

   A data source is an object that enables a Java Database Connectivity (JDBC) client, such as an application server, to establish a connection with a database. Applications look up the data source on the Java Naming and Directory Interface (JNDI) tree or in the local application context and request a database connection to retrieve data. You must configure data sources for KIE Server to ensure correct data exchange between the servers and the designated database.

10. If you selected Customize KIE Server properties, on the KIE Server Properties Configuration page change any of the following properties:

    • Change the value of KIE Server ID to change the name of the KIE Server property.
    • Deselect any KIE Server functions that you want to disable.
11. Click Next to configure the runtime environment.
12. When Processing finished appears at the top of the screen, click Next to complete the installation.

13. Optional: Click Generate Installation Script and Properties File to save the installation data in XML files, and then click Done.

    The installer generates two files. The auto.xml file automates future installations and the auto.xml.variables file stores user passwords and other sensitive variables. Use the auto.xml file to repeat the Red Hat Process Automation Manager installation on multiple systems with the same type of server and the same configuration as the original installation. If necessary, update the installpath parameter in the auto.xml file. To perform an installation using the XML file, enter the following command:

    java -jar rhpam-installer-7.10.0.jar <path-to-auto.xml-file>

Procedure

1. In a terminal window, navigate to the directory where you downloaded the installer file and enter the following command:

   java -jar rhpam-installer-7.10.0.jar -console

   The command-line interactive process will start and display the End-User License Agreement.

   press 1 to continue, 2 to quit, 3 to redisplay.

2. Read the license agreement, enter 1, and press Enter to continue:

   Specify the home directory of one of the following servers:  Red Hat JBoss EAP 7 or Red Hat JBoss Web Server 5. For more information, see https://access.redhat.com/articles/3405381[Red Hat Process Automation Manager 7 Supported Configurations].

3. Enter the parent directory of an existing Red Hat JBoss Web Server 5.4.0 installation.

   The installer will verify the location of the installation at the location provided. Enter 1 to confirm and continue.

4. Follow the instructions in the installer to complete the installation.

   Note

   When you create the user name and password, make sure that the specified user name does not conflict with any known title of a role or a group. For example, if there is a role called admin, you should not create a user with the user name admin.

   The password must have at least eight characters and must contain at least one number and one non-alphanumeric character (not including the character &).

   Make a note of the user name and password. You will need them to access Business Central and KIE Server.

5. When the installation has completed, you will see this message:

   Would you like to generate an automatic installation script and properties file?

6. Enter y to create XML files that contain the installation data, or n to complete the installation. If you enter y, you are prompted to specify a path for the XML files.

7. Enter a path or press the Enter key to accept the suggested path.

   The installer generates two files. The auto.xml file automates future installations and the auto.xml.variables file stores user passwords and other sensitive variables. Use the auto.xml file on multiple systems to easily repeat a Red Hat Process Automation Manager installation on the same type of server with the same configuration as the original installation. If necessary, update the installpath parameter in the auto.xml file. To perform an installation using the XML file, enter the following command:

   java -jar rhpam-installer-7.10.0.jar <path-to-auto.xml-file>

8. If you installed only KIE Server, repeat these steps to install the headless Process Automation Manager controller on a separate server.

Procedure

1. Extract the rhpam-7.10.0-add-ons.zip file.

2. From the extracted rhpam-7.10.0-add-ons.zip file, extract the following files:

   • rhpam-7.10.0-kie-server-jws.zip
   • rhpam-7.10.0-process-engine.zip

   In the following instructions, the directory that contains the extracted rhpam-7.10.0-kie-server-jws.zip file is called JWS_TEMP_DIR and the directory that contains the extracted rhpam-7.10.0-process-engine.zip file is called ENGINE_TEMP_DIR.

3. Copy the JWS_TEMP_DIR/rhpam-7.10.0-kie-server-jws/kie-server.war directory to the JWS_HOME/tomcat/webapps directory.

   Note

   Ensure the names of the Red Hat Process Automation Manager deployments you copy do not conflict with your existing deployments in the Red Hat JBoss Web Server instance.

4. Remove the .war extensions from the kie-server.war folder.
5. Move the kie-tomcat-integration-7.48.0.Final-redhat-00004.jar file from the ENGINE_TEMP_DIR directory to the JWS_HOME/tomcat/lib directory.
6. Move the jboss-jacc-api-<VERSION>.jar, slf4j-api-<VERSION>.jar, and slf4j-jdk14-<VERSION>.jar files from the ENGINE_TEMP_DIR/lib directory to the JWS_HOME/tomcat/lib directory, where <VERSION> is the version artifact file name, in the lib directory.

7. Add the following line to the <host> element in the JWS_HOME/tomcat/conf/server.xml file after the last Valve definition:

   <Valve className="org.kie.integration.tomcat.JACCValve" />

8. Open the JWS_HOME/tomcat/conf/tomcat-users.xml file in a text editor.

9. Add users and roles to the JWS_HOME/tomcat/conf/tomcat-users.xml file. In the following example, <ROLE_NAME> is a role supported by Red Hat Process Automation Manager. <USER_NAME> and <USER_PWD> are the user name and password of your choice:

   <role rolename="<ROLE_NAME>"/>
   <user username="<USER_NAME>" password="<USER_PWD>" roles="<ROLE_NAME>"/>

   If a user has more than one role, as shown in the following example, separate the roles with a comma:

   <role rolename="admin"/>
   <role rolename="kie-server"/>
   <user username="rhpamUser" password="user1234" roles="admin,kie-server"/>

10. Complete one of the following steps in the JWS_HOME/tomcat/bin directory:

    • On Linux or UNIX, create the setenv.sh file with the following content:

      CATALINA_OPTS="-Xmx1024m -Dorg.jboss.logging.provider=jdk"

    • On Windows, add the following content to the setenv.bat file:

      set CATALINA_OPTS=-Xmx1024m -Dorg.jboss.logging.provider=jdk

Procedure

1. Complete the following steps to prepare your database:

   1. Extract rhpam-7.10.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.10.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.10.0-migration-tool/ddl-scripts directory. This directory contains DDL scripts for several database types.

   4. Import the DDL script for your database type into the database that you want to use, for example:

      psql jbpm < /ddl-scripts/postgresql/postgresql-jbpm-schema.sql

      Note

      If you are using PostgreSQL or Oracle in conjunction with Spring Boot, you must import the respective Spring Boot DDL script, for example /ddl-scripts/oracle/oracle-springboot-jbpm-schema.sql or /ddl-scripts/postgresql/postgresql-springboot-jbpm-schema.sql.

2. Extract the rhpam-7.10.0-maven-repository.zip offline Maven repository file.

3. Copy the following libraries from the extracted offline Maven repository to the JWS_HOME/tomcat/lib folder where VERSION is the version of that library:

   org/jboss/spec/javax/transaction/jboss-transaction-api_1.2_spec/{VERSION}/jboss-transaction-api_1.2_spec-{VERSION}.jar
   org/jboss/integration/narayana-tomcat/{VERSION}/narayana-tomcat-{VERSION}.jar
   org/jboss/narayana/jta/narayana-jta/{VERSION}/narayana-jta-{VERSION}.jar
   org/jboss/jboss-transaction-spi/{VERSION}/jboss-transaction-spi-{VERSION}.jar

4. Copy your database JDBC driver to the JWS_HOME/tomcat/lib folder.

5. Configure the pooling XA data source in the JWS_HOME/tomcat/conf/context.xml file:

   Note

   Some of the properties in the following examples might not apply to your database server. Check the documentation for your JDBC driver to determine which properties to set.

   1. Configure an XA data source without pooling capabilities. This XA data source is used to create new connections to the target database. In the following example, the XA datasource is xads and the variables are defined in Table 37.1, “XA data source variables”:

      <?xml version="1.0" encoding="UTF-8"?>
      <Context>
      <Resource
      auth="Container"
      databaseName="${datasource.dbName}"
      description="XA Data Source"
      factory="org.apache.tomcat.jdbc.naming.GenericNamingResourcesFactory" loginTimeout="0"
      name="xads"
      uniqueName="xads"
      portNumber="${datasource.port}"
      serverName="${datasource.hostname}"
      testOnBorrow="false"
      type="${datasource.class}"
      url="${datasource.url}"
      URL="${datasource.url}"
      user="${datasource.username}"
      password="${datasource.password}"
      driverType="4"
      schema="${datasource.schema}"
      />
      </Context>

      Table 37.1. XA data source variables

      Variable	Description
      <datasource.dbName>	The name of the database.
      <datasource.port>	The port number of the database.
      <datasource.hostname>	The name of the database host.
      <datasource.class>	XADataSource class of JDBC driver.
      <datasource.url>	The JDBC database connection URL. With some databases, the URL property is url and with other databases (for example H2 databases) this property is URL.
      <datasource.username>	User name for the database connection.
      <datasource.password>	Password for the database connection.
      <datasource.schema>	The database schema.

   2. Configure a pooling data source that relies on the XA data source for creating new connections. In this example, the data source is poolingXaDs, <datasource.username> is the user name for the database connection, and <datasource.password> is the password for the database connection:

      <?xml version="1.0" encoding="UTF-8"?>
      <Context>
      <Resource
      name="poolingXaDs"
      uniqueName="poolingXaDs"
      auth="Container"
      description="Pooling XA Data Source" factory="org.jboss.narayana.tomcat.jta.TransactionalDataSourceFactory" testOnBorrow="true"
      transactionManager="TransactionManager" transactionSynchronizationRegistry="TransactionSynchronizationRegistry" type="javax.sql.XADataSource"
      username="${datasource.username}"
      password="${datasource.password}"
      xaDataSource="xads"
      />
      </Context>

      The data source is now available under the java:comp/env/poolingXaDs JNDI name and passes it to the KIE Server through the org.kie.server.persistence.ds system property as described in the next steps.

      Note

      The pooling data source configuration relies on additional resources that have been previously configured in context.xml file in kie-server application, specifically TransactionManager and TransactionSynchronizationRegistry.

6. Configure KIE Server to use the data source:

   1. Open one of the following scripts in a text editor:

      Note

      The setenv.sh or setenv.bat script should already exist. However, if it does not, create it.

      • For Linux or Unix:

        JWS_HOME/tomcat/bin/setenv.sh

      • For Windows:

        JWS_HOME/tomcat/bin/setenv.bat

   2. Add the following properties to CATALINA_OPS where <hibernate.dialect> is the Hibernate dialect for your database:

      CATALINA_OPTS="-Xmx1024m
      -Dorg.jboss.logging.provider=jdk
      -Dorg.kie.server.persistence.ds=java:comp/env/poolingXaDs
      -Dorg.kie.server.persistence.tm=JBossTS
      -Dorg.kie.server.persistence.dialect=${<hibernate.dialect>}"

Procedure

1. Generate a Maven project. A pom.xml file is automatically generated when you create a Maven project.

2. Edit the pom.xml file to add more dependencies and new repositories.

   Maven downloads all of the JAR files and the dependent JAR files from the Maven repository when you compile and package your project.

Procedure

1. In the settings.xml file, declare the repositories that your Red Hat Process Automation Manager projects use. Usually, this is either the online Red Hat Process Automation Manager Maven repository or the Red Hat Process Automation Manager Maven repository that you download from the Red Hat Customer Portal and any repositories for custom artifacts that you want to use.

2. Ensure that Business Central or KIE Server is configured to use the settings.xml file. For example, specify the kie.maven.settings.custom=<SETTINGS_FILE_PATH> property where <SETTINGS_FILE_PATH> is the path to the settings.xml file.

   On Red Hat JBoss Web Server, for KIE Server add -Dkie.maven.settings.custom=<SETTINGS_FILE_PATH> to the CATALINA_OPTS section of the setenv.sh (Linux) or setenv.bat (Windows) file. For standalone Business Central, enter the following command:

   java -jar rhpam-7.10.0-business-central-standalone.jar -s application-config.yaml -Dkie.maven.settings.custom=<SETTINGS_FILE_PATH>

Procedure

1. Declare the Red Hat Business Automation BOM in the pom.xml file:

   <dependencyManagement>
    <dependencies>
     <dependency>
      <groupId>com.redhat.ba</groupId>
      <artifactId>ba-platform-bom</artifactId>
      <version>7.10.0.redhat-00004</version>
      <type>pom</type>
      <scope>import</scope>
     </dependency>
    </dependencies>
   </dependencyManagement>
   <dependencies>
   <!-- Your dependencies -->
   </dependencies>

2. Declare dependencies required for your project in the <dependencies> tag. After you import the product BOM into your project, the versions of the user-facing product dependencies are defined so you do not need to specify the <version> sub-element of these <dependency> elements. However, you must use the <dependency> element to declare dependencies which you want to use in your project.

3. For standalone projects that are not authored in Business Central, specify all dependencies required for your projects. In projects that you author in Business Central, the basic decision engine and process engine dependencies are provided automatically by Business Central.

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies, depending on the features that you want to use:

     Embedded process engine dependencies

     <!-- Public KIE API -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <!-- Core dependencies for process engine -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-flow-builder</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-bpmn2</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-runtime-manager</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-persistence-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-query-jpa</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-audit</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <!-- Dependency needed for default WorkItemHandler implementations. -->
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-workitems-core</artifactId>
     </dependency>
     
     <!-- Logging dependency. You can use any logging framework compatible with slf4j. -->
     <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
       <version>${logback.version}</version>
     </dependency>

   • For a Red Hat Process Automation Manager project that uses CDI, you typically declare the following dependencies:

     CDI-enabled process engine dependencies

     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-api</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-kie-services</artifactId>
     </dependency>
     
     <dependency>
       <groupId>org.jbpm</groupId>
       <artifactId>jbpm-services-cdi</artifactId>
     </dependency>

   • For a basic Red Hat Process Automation Manager project, declare the following dependencies:

     Embedded decision engine dependencies

     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-compiler</artifactId>
     </dependency>
     
     <!-- Dependency for persistence support. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-persistence-jpa</artifactId>
     </dependency>
     
     <!-- Dependencies for decision tables, templates, and scorecards.
     For other assets, declare org.drools:business-central-models-* dependencies. -->
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-decisiontables</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-templates</artifactId>
     </dependency>
     <dependency>
       <groupId>org.drools</groupId>
       <artifactId>drools-scorecards</artifactId>
     </dependency>
     
     <!-- Dependency for loading KJARs from a Maven repository using KieScanner. -->
     <dependency>
       <groupId>org.kie</groupId>
       <artifactId>kie-ci</artifactId>
     </dependency>

   • To use the KIE Server, declare the following dependencies:

     Client application KIE Server dependencies

     <dependency>
       <groupId>org.kie.server</groupId>
       <artifactId>kie-server-client</artifactId>
     </dependency>

   • To create a remote client for Red Hat Process Automation Manager, declare the following dependency:

     Client dependency

     <dependency>
       <groupId>org.uberfire</groupId>
       <artifactId>uberfire-rest-client</artifactId>
     </dependency>

   • When creating a JAR file that includes assets, such as rules and process definitions, specify the packaging type for your Maven project as kjar and use org.kie:kie-maven-plugin to process the kjar packaging type located under the <project> element. In the following example, ${kie.version} is the Maven library version listed in What is the mapping between Red Hat Process Automation Manager and the Maven library version?:

     <packaging>kjar</packaging>
     <build>
      <plugins>
       <plugin>
        <groupId>org.kie</groupId>
        <artifactId>kie-maven-plugin</artifactId>
        <version>${kie.version}</version>
        <extensions>true</extensions>
       </plugin>
      </plugins>
     </build>

Procedure

1. On the computer that has an outgoing connection to the public Internet, complete the following steps:

2. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Red Hat Process Automation Manager

   • Version: 7.10

     1. Download and extract the Red Hat Process Automation Manager 7.10.0 Offliner Content List (rhpam-7.10.0-offliner.zip) product deliverable file.
     2. Extract the contents of the rhpam-7.10.0-offliner.zip file into any directory.

     3. Change to the directory and enter the following command:

        ./offline-repo-builder.sh offliner.txt

        This command creates the repository subdirectory and downloads the necessary artifacts into this subdirectory. This is the mirror repository.

        If a message reports that some downloads have failed, run the same command again. If downloads fail again, contact Red Hat support.

3. If you developed services outside of Business Central and they have additional dependencies, add the dependencies to the mirror repository. If you developed the services as Maven projects, you can use the following steps to prepare these dependencies automatically. Complete the steps on the computer that has an outgoing connection to the public Internet.

   1. Create a backup of the local Maven cache directory (~/.m2/repository) and then clear the directory.
   2. Build the source of your projects using the mvn clean install command.

   3. For every project, enter the following command to ensure that Maven downloads all runtime dependencies for all the artifacts generated by the project:

      mvn -e -DskipTests dependency:go-offline -f /path/to/project/pom.xml --batch-mode -Djava.net.preferIPv4Stack=true

      Replace /path/to/project/pom.xml with the path of the pom.xml file of the project.

   4. Copy the contents of the local Maven cache directory (~/.m2/repository) to the repository subdirectory that was created.
4. Copy the contents of the repository subdirectory to a directory on the computer on which you deployed Red Hat Process Automation Manager. This directory becomes the offline Maven mirror repository.
5. Create and configure a settings.xml file for your Red Hat Process Automation Manager deployment as described in Section 42.2, “Modifying the Maven settings file”.

6. Make the following changes in the settings.xml file:

   • Under the <profile> tag, if a <repositories> or <pluginRepositores> tag is missing, add the missing tags.

   • Under <repositories> add the following content:

     <repository>
       <id>offline-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.

   • Under <pluginRepositories> add the following content:

     <repository>
       <id>offline-plugin-repository</id>
       <url>file:///path/to/repo</url>
       <releases>
         <enabled>true</enabled>
       </releases>
       <snapshots>
         <enabled>false</enabled>
       </snapshots>
     </repository>

     Replace /path/to/repo with the full path to the local Maven mirror repository directory.

Procedure

1. In the WebSphere Integrated Solutions Console, click Security → Global Security and ensure that the option Enable Application Security is selected. This may already be selected and overridden at the server level.
2. Click Security Configuration Wizard and click Next.
3. Select the repository that contains the user information. For example, select Federated repositories for local configurations.
4. Click Next
5. Enter the Primary administrative user name and Password.
6. Click Next and then click Finish.

7. Click Save in the Messages window to save your changes to the primary configuration.

   Figure 48.1. Save security changes

   

8. In your command terminal, navigate to the IBM WebSphere Application Server /bin directory location that you specified during installation, and run the following commands to stop and restart IBM WebSphere to apply the security changes:

   sudo ./stopServer.sh <SERVER_NAME>

   sudo ./startServer.sh <SERVER_NAME>

   Replace <SERVER_NAME> with the IBM WebSphere Application Server name defined in Servers → Server Types → IBM WebSphere Application Servers of the WebSphere Integrated Solutions Console.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add-Ons.

3. Complete the following steps to prepare your database:

   1. Extract rhpam-7.10.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.10.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.10.0-migration-tool/ddl-scripts directory. This directory contains DDL scripts for several database types.

   4. Import the DDL script for your database type into the database that you want to use, for example:

      psql jbpm < /ddl-scripts/postgresql/postgresql-jbpm-schema.sql

      Note

      If you are using PostgreSQL or Oracle in conjunction with Spring Boot, you must import the respective Spring Boot DDL script, for example /ddl-scripts/oracle/oracle-springboot-jbpm-schema.sql or /ddl-scripts/postgresql/postgresql-springboot-jbpm-schema.sql.

4. In the WebSphere Integrated Solutions Console, navigate to Resources → JDBC → Data sources.
5. Select the scope at which applications can use the data source. You can choose a cell, node, cluster, or server.
6. Click New to open the Create a data source wizard.

7. Enter a unique name in the Data source name field and a Java Naming and Directory Interface (JNDI) name in the JNDI name field. The application server uses the JNDI name to bind resource references for an application to this data source.

   Do not assign duplicate JNDI names across different resource types, such as data sources versus J2C connection factories or JMS connection factories.

   Do not assign duplicate JNDI names for multiple resources of the same type in the same scope.

8. Click Next and choose Select an existing JDBC provider if the provider has been created, or choose Create new JDBC provider to define details for a new provider. (Creating the JDBC provider before this point is recommended, as a prerequisite to adding data sources.)
9. On the Enter database specific properties for the data source panel, click Use this data source in container managed persistence (CMP) if container managed persistence (CMP) enterprise beans must access this data source. Then fill in any other database-specific properties.

10. Optional: Configure the security aliases for the data source. You can select None for any of the authentication methods, or choose one of the following types:

    • Component-managed authentication alias: Specifies an authentication alias to use when the component resource reference res-auth value is Application. To define a new alias, navigate to Related Items → J2EE Connector Architecture (J2C) authentication data entries. A component-managed alias represents a combination of ID and password that is specified in an application for data source authentication. Therefore, the alias that you set on the data source must be identical to the alias in the application code.
    • Mapping-configuration alias: Used only in the absence of a login configuration on the component resource reference. The specification of a login configuration and the associated properties on the component resource reference is the preferred way to define the authentication strategy when the res-auth value is set to Container. If you specify the DefaultPrincipalMapping login configuration, the associated property is a JAAS - J2C authentication data entry alias.
    • Container-managed authentication alias: Used only in the absence of a login configuration on the component resource reference. The specification of a login configuration and the associated properties on the component resource reference determines the container-managed authentication strategy when the res-auth value is set to Container.

11. Click Next, review the information for the data source, and click Finish to save the configuration and exit the wizard.

    The Data sources panel displays your new configuration in a table along with any other data sources that are configured for the same scope.

Procedure

1. In the WebSphere Integrated Solutions Console, navigate to Servers → Server Types → IBM WebSphere Application Servers.
2. In the list of application servers, choose the server on which you are going to deploy KIE Server.

3. Under the Server Infrastructure, click Java and Process Management → Process Definition.

   Figure 48.2. WebSphere configuration page

   

4. Under Additional Properties, click Java Virtual Machine.

   Figure 48.3. Process definition configuration page

   

   This opens the configuration properties for the JVM that is used to start IBM WebSphere.

5. Set both the Initial heap size and Maximum heap size to 2048 and click Apply to increase the Java Virtual Machine (JVM) memory size. KIE Server has been tested with these values. If you do not increase the JVM memory size, IBM WebSphere Application Server freezes or causes deployment errors when deploying KIE Server.
6. Under Additional Properties, click Custom Properties.

7. Click New → Custom JVM Properties and add the following properties to IBM WebSphere:

   Table 48.4. System properties for KIE Server

   Name	Value	Description
   kie.server.jms.queues.response	jms/KIE.SERVER.RESPONSE	The JNDI name of JMS queue for responses used by KIE Server.
   org.kie.server.domain	WSLogin	JAAS LoginContext domain used to authenticate users when using JMS.
   org.kie.server.persistence.ds	jdbc/jbpm	Data source JNDI name for KIE Server.
   org.kie.server.persistence.tm	org.hibernate.engine.transaction.jta.platform.internal.WebSphereJtaPlatform	Transaction manager platform for setting Hibernate properties.
   org.kie.server.persistence.dialect	Example: org.hibernate.dialect.H2Dialect	Specifies the Hibernate dialect to be used. Set according to data source.
   org.kie.executor.jms.queue	jms/KIE.SERVER.EXECUTOR	Job executor JMS queue for KIE Server.
   org.kie.executor.jms.cf	jms/cf/KIE.SERVER.EXECUTOR	Job executor JMS connection factory for KIE Server.
   org.kie.server.router	Example: http://localhost:9000	(Optional) Specifies one or more URLs for one or more KIE Server routers (Smart Routers) that the application server is a part of in a clustered KIE Server environment.
   org.jboss.logging.provider	jdk	This property is only required where a CA SiteMinder TAI (SMTAI) is installed in the environment. Using this property forces Hibernate to use JDK instead of log4j for logging within Dashbuilder. CA SiteMinder TAI (SMTAI) contains an old version of log4j, which causes conflicts.

8. Click Save to save the changes to the primary configuration.

Procedure

1. In the WebSphere Integrated Solutions Console, click Users and Groups → Manage Groups.
2. In the Manage Groups screen, click Create.
3. In the Create a Group screen, enter kie-server in the Group name box, then click Create.
4. To create a user to add to the kie-server group, click Users and Groups → Manage Users.
5. In the Create a User screen, complete the required information.
6. Click Group Membership.
7. In the Group Membership screen, click kie-server, move it to Mapped To, and click Close.
8. On the Create a User screen click Create.

Procedure

1. In the WebSphere Integrated Solutions Console, navigate to Applications → Application Types → WebSphere Enterprise Applications and select the newly installed kie-server application.
2. Under Detail Properties, click Security Role to User/Group Mapping.
3. Select the kie-server role and click Map Groups to search for the kie-server group.

4. Move the kie-server group from the Available list to the Selected list and click OK.

   This mapping gives users in the IBM WebSphere Application Server kie-server group access to KIE Server.

5. Click Save to complete the mapping.

Procedure

1. Navigate to Applications → Application Types → WebSphere 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 primary configuration.

Procedure

1. To verify that the server is running, complete one of the following tasks:

   • Navigate to the KIE Server URL http://<HOST>:<PORT>/kie-server.

   • Send a GET request to http://<HOST>:<PORT>/kie-server/services/rest/server to check whether the KIE Server REST API responds.

     In these examples, replace the following placeholders:

     • <HOST> is the ID or name of the KIE Server host, for example, localhost or 192.7.8.9.
     • <PORT> is the port number of the KIE Server host, for example, 9060.
2. If KIE Server is not running, stop and restart the IBM WebSphere Application Server instance and try again to access the KIE Server URL or API.

Procedure

1. Navigate to Applications → Application Types → WebSphere 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 primary configuration.

Procedure

1. Specify the following JVM property values on the application server instance where the headless Process Automation Manager controller is installed:

   Table 50.1. Required properties for the headless Process Automation Manager controller

   Name	Requirement
   org.kie.server.user	A user with the kie-server role
   org.kie.server.pwd	The password for the user specified in the org.kie.server.user property

2. Specify the following JVM property values on the application server instance where KIE Server is installed:

   Table 50.2. Required properties for KIE Server when headless Process Automation Manager controller is installed

   Name	Requirement
   org.kie.server.controller.user	A user with the kie-server role
   org.kie.server.controller.pwd	The password for the user specified for the org.kie.server.controller.user property
   org.kie.server.id	The ID or name of the KIE Server installation, such as rhdm700-decision-server-1
   org.kie.server.location	The URL of the KIE Server, http://<HOST>:<PORT>/kie-server/services/rest/server
   org.kie.server.controller	The URL of the headless Process Automation Manager controller, http://<HOST>:<PORT>/controller/rest/controller

   <HOST> is the ID or name of the KIE Server host, for example, localhost or 192.7.8.9.

   <PORT> is the port number of the KIE Server host, for example, 7001.

Procedure

1. In the WebSphere Integrated Solutions Console, create the kie-server group and a user for that group, as described in Creating the KIE Server group and role.
2. Navigate to Applications → Application Types → WebSphere Enterprise Applications and select the newly installed headless Process Automation Manager controller.
3. Under Detail Properties, click Security Role to User/Group Mapping.
4. Select the kie-server role and click Map Groups to search for the kie-server group.

5. Move the kie-server group from the Available list to the Selected list and click OK.

   This mapping gives the previously created administrator user access to Process Automation Manager.

6. Click Save to complete the mapping.

Procedure

1. In the WebLogic Administration Console, click Security Realms.
2. Choose your desired security realm or click New to create a new security realm.
3. Navigate to Users and Groups → Groups → New and create the kie-server group.
4. Navigate to Users → New and create a new user.

5. Enter a user, such as server-user, and a password for this new user and click OK.

   Important

   Make sure that the selected user name does not conflict with any known title of a role or a group. For example, if there is a role called kie-server, then do not create a user with the user name kie-server.

6. Click the newly created user, then return to the Groups tab.
7. Use the selection tool to move the kie-server group from the Available field to the Chosen field, and click Save.

Procedure

1. Navigate to the Software Downloads page in the Red Hat Customer Portal (login required), and select the product and version from the drop-down options:

   • Product: Process Automation Manager
   • Version: 7.10
2. Download Red Hat Process Automation Manager 7.10.0 Add-Ons.

3. Complete the following steps to prepare your database:

   1. Extract rhpam-7.10.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.10.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.10.0-migration-tool/ddl-scripts directory. This directory contains DDL scripts for several database types.

   4. Import the DDL script for your database type into the database that you want to use, for example:

      psql jbpm < /ddl-scripts/postgresql/postgresql-jbpm-schema.sql

      Note

      If you are using PostgreSQL or Oracle in conjunction with Spring Boot, you must import the respective Spring Boot DDL script, for example /ddl-scripts/oracle/oracle-springboot-jbpm-schema.sql or /ddl-scripts/postgresql/postgresql-springboot-jbpm-schema.sql.

4. In the WebLogic Administration Console, navigate to Change Center → Lock & Edit.
5. Under Domain Structure, click Services → Data Sources.
6. On the Summary of Data Sources page, click New → Generic Data Source.

7. On the JDBC Data Sources Properties page, enter or select the following information:

   • Name: Enter a name for this JDBC data source. This name is used in the configuration file (config.xml) and throughout the Administration Console whenever referring to this data source.
   • JNDI Name: Enter the JNDI path to where this JDBC data source will be bound. Applications look up the data source on the JNDI tree by this name when reserving a connection.
   • Database Type: Select the DBMS of the database that you want to connect to. If your DBMS is not listed, select Other.
8. Click Next to continue.
9. Select the Database Driver that you want to use to connect to the database. The list includes common JDBC drivers for the selected DBMS and any other JDBC drivers that have been installed previously.

10. On the Transaction Options page, leave the Supports Global Transactions option selected and choose from the available transaction options. You can also clear this check box to disable (ignore) global transactions in this data source. In most cases, you should leave the option selected for optimal data efficiency.

    • Two-Phase Commit: Select this option to enable standard XA processing. This option is only available when you select an XA JDBC driver to make database connections.
    • Logging Last Resource: Select this option to enable a non-XA JDBC connection to participate in global transactions using the Logging Last Resource (LLR) transaction optimization. This option is recommended in place of Emulate Two-Phase Commit. This option is only available when you select a non-XA JDBC driver to make database connections.
    • Emulate Two-Phase Commit: Select this option to enable a non-XA JDBC connection to emulate participation in distributed transactions using JTA. Select this option only if your application can tolerate heuristic conditions. This option is only available when you select a non-XA JDBC driver to make database connections.
    • One-Phase Commit: Select this option to enable the non-XA connection to participate in a global transaction as the only transaction participant. This option is only available when you select a non-XA JDBC driver to make database connections.
11. Click Next to continue.

12. On the Connection Properties page, enter values for the following properties:

    • Service Name: Specify the service name of the database to which you want to connect. This must be the same for each data source if more than one is provided. This field is available only if you selected one of the available service-instance connections drivers for Oracle Real Application Clusters (RAC).
    • Database Name: Enter the name of the database that you want to connect to. Exact database name requirements vary by JDBC driver and by DBMS.
    • Host Name: Enter the DNS name or IP address of the server that hosts the database. If you are creating an Oracle GridLink service-instance connection, this must be the same for each data source if more than one is provided.
    • Port: Enter the port on which the database server listens for connection requests.
    • Database User Name: Enter the database user account name that you want to use for each connection in the data source.
    • Password/Confirm Password: Enter the password for the database user account.
    • oracle.jdbc.DRCPConnectionClass: Optionally, enter the Database Resident Connection Pooling (DCRP) connection class if required by your environment.
13. Click Next to continue.

14. On the Test Database Connection page, review the connection parameters and click Test Configuration.

    Oracle WebLogic Server attempts to create a connection from the Administration Server to the database. Results from the connection test are displayed at the top of the page. If the test is unsuccessful, correct any configuration errors and retry the test.

15. Click Next to continue or to skip this step if the JDBC driver you selected is not installed on the Administration Server.
16. On the Select Targets page, select the servers or clusters on which you want to deploy the data source and click Finish.
17. Return to the main menu of the WebLogic Administration Console and select Change Center → Activate Changes.