Installing and configuring Red Hat Decision Manager on Red Hat JBoss EAP 7.3

Procedure

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

   java -jar rhdm-installer-7.8.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
   rhdm-installer-7.8.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
   rhdm-installer-7.8.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 Decision 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 more information, see Chapter 2, Red Hat Decision 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, click Next to start the installation. The Installation Overview page lists the components that you will install.
7. When the installation has completed, click Next.
8. When Processing finished appears at the top of the screen, click Next to complete the installation.

9. Optionally, 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 on multiple systems to easily repeat a Red Hat Decision 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. Enter the following command to perform an installation with the XML file:

   java -jar rhdm-installer-7.8.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 rhdm-installer-7.8.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.3 or Red Hat JBoss Web Server 5.3.1

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 Decision 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. Enter the following command to perform an installation with the XML file:

   java -jar rhdm-installer-7.8.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. Extract the rhdm-7.8.0-decision-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/rhdm-7.8.0-decision-central-eap7-deployable/jboss-eap-7.3 directory to EAP_HOME. When prompted, merge or replace files.

   Warning

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

Procedure

1. Extract the rhdm-7.8.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/rhdm-7.8.0-kie-server-ee8/kie-server.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure the names of the Red Hat Decision 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/rhdm-7.8.0-kie-server-ee8/rhdm-7.8.0-kie-server-ee8/SecurityPolicy/ to EAP_HOME/bin. When asked to overwrite files, click Replace.
4. 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 rhdm-7.8.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhdm-7.8.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhdm-7.8.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. 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="rhdmUser"/>
       <property name="org.kie.server.pwd" value="rhdm123!"/>
       <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/decision-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.

   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.

   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 the Business Central EAP_HOME/standalone/configuration/standalone-full.xml file, uncomment the following properties in the <system-properties> section and replace <USERNAME> and <USER_PWD> with the credentials of a user with the kie-server role:

      <property name="org.kie.server.user" value="<USERNAME>"/>
      <property name="org.kie.server.pwd" value="<USER_PWD>"/>

2. In the KIE Server EAP_HOME/standalone/configuration/standalone-full.xml file, uncomment the following properties in the <system-properties> section.

     <property name="org.kie.server.controller.user" value="<CONTROLLER_USER>"/>
     <property name="org.kie.server.controller.pwd" value="<CONTROLLER_PWD>"/>
     <property name="org.kie.server.id" value="<KIE_SERVER_ID>"/>
     <property name="org.kie.server.location" value="http://<HOST>:<PORT>/kie-server/services/rest/server"/>
     <property name="org.kie.server.controller" value="<CONTROLLER_URL>"/>

3. Replace the following values:

   • Replace <CONTROLLER_USER> and <CONTROLLER_PWD> with the credentials of a user with the rest-all role.
   • Replace <KIE_SERVER_ID> with the ID or name of the KIE Server installation, for example, rhdm-7.8.0-kie-server-1.
   • Replace <HOST> with the ID or name of the KIE Server host, for example, localhost or 192.7.8.9.

   • Replace <PORT> with the port of the KIE Server host, for example, 8080.

     Note

     The org.kie.server.location property specifies the location of KIE Server.

   • Replace <CONTROLLER_URL> with the URL of Business Central. KIE Server connects to this URL during startup.

     • If you installed Business Central using the installer or Red Hat JBoss EAP zip installations, <CONTROLLER_URL> has this format:

       http://<HOST>:<PORT>/decision-central/rest/controller

     • If you are running Business Central using the standalone.jar file, <CONTROLLER_URL> has this format:

       http://<HOST>:<PORT>/rest/controller

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: Decision Manager
   • Version: 7.8
2. Download Red Hat Decision Manager 7.8.0 Add Ons (the rhdm-7.8.0-add-ons.zip file).
3. Unzip the rhdm-7.8.0-add-ons.zip file. The rhdm-7.8.0-controller-ee7.zip file is in the unzipped directory.
4. Extract the rhdm-7.8.0-controller-ee7 archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

5. Copy the TEMP_DIR/rhdm-7.8.0-controller-ee7/controller.war directory to EAP_HOME/standalone/deployments/.

   Warning

   Ensure that the names of the headless Decision 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/rhdm-7.8.0-controller-ee7/SecurityPolicy/ directory to EAP_HOME/bin. When asked to overwrite files, select Yes.
7. In the EAP_HOME/standalone/deployments/ directory, create an empty file named controller.war.dodeploy. This file ensures that the headless Decision 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 Decision 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 Decision Manager controller on a separate Red Hat JBoss EAP instance from the Red Hat JBoss EAP instance where you installed the KIE Server, you can start the headless Decision 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 Decision 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 10.1.1, “Creating a headless Decision 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.8.0.redhat-00005</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 dependencies are provided automatically by Business Central.

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

   • For a basic Red Hat Decision 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 Decision 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 Decision 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 Decision Manager installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for Red Hat Decision 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:

   1. Click Red Hat Process Automation Manager 7.8.0 Offliner Content List to download the rhdm-7.8.0-offliner.zip product deliverable file from the Software Downloads page of the Red Hat Customer Portal.
   2. Extract the contents of the rhdm-7.8.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 a repository subdirectory and downloads the necessary artifacts into this subdirectory.

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

2. If you developed services outside 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 correct path to 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.
3. Copy the contents of the repository subdirectory to a directory on the computer on which you deployed Red Hat Decision Manager. This directory becomes the offline Maven mirror repository.
4. Create and configure a settings.xml file for your Red Hat Decision Manager deployment, according to instructions in Section 12.2, “Configuring an external Maven repository for Business Central and KIE Server”.

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

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

   • Under <repositories> add the following sequence:

     <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 sequence:

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

6. Set the kie.maven.offline.force property for Business Central to true. For instructions about setting properties for Business Central, see Section 11.1, “Business Central system properties”.

Procedure

1. Start Red Hat JBoss EAP and open Business Central in a web browser.
2. Copy a SVG format image to the EAP_HOME/standalone/deployments/decision-central.war/img/ directory in your Red Hat Decision Manager installation.
3. In the EAP_HOME/standalone/deployments/decision-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/decision-central.war/banner/ directory in your Red Hat Decision Manager installation.
3. Open the EAP_HOME/standalone/deployments/decision-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. Download the Dashbuilder Runtime WAR file dashbuilder-runtime.war.

2. Move dashbuilder-runtime.war to {WILDFLY_HOME}/standalone/deployments.

   Note

   By default this uses the root web context / and the other security domain, making it protected by default.

3. To create a user with the admin role using the add-user.sh utility, perform the following tasks:

   1. In the terminal, enter the following:

      /wildfly/bin/add-user.sh

   2. Select the type of user you want to add: Application User (application-users.properties).
   3. Enter the username: admin.
   4. Select Update the existing user password and roles.
   5. Enter a password.
   6. To confirm the password, enter yes.
   7. Re-enter the password.
   8. Enter the groups you want the user to belong to: admin.

   9. Enter no

      The admin user is created.