Chapter 2. Installing Red Hat Decision Manager

Red Hat JBoss Enterprise Application Platform (Red Hat JBoss EAP) 7.1 is a certified implementation of the Java Enterprise Edition 7 (Java EE 7) full and web profile specifications. Red Hat JBoss EAP provides preconfigured options for features such as high availability, clustering, messaging, and distributed caching. It also enables users to write, deploy, and run applications using the various APIs and services that Red Hat JBoss EAP provides.

Red Hat JBoss Web Server is an enterprise ready web server designed for medium and large applications, based on Tomcat 8. Red Hat JBoss Web Server provides organizations with a single deployment platform for Java Server Pages (JSP) and Java Servlet technologies, PHP, and CGI.

Red Hat Decision Manager consists of Decision Central and Decision Server. You can install Decision Central on a Red Hat JBoss EAP 7.1 server installation. You can install Decision Server on a Red Hat JBoss EAP 7.1 or Red Hat JBoss Web Server installation.

Note

You can also install Decision Server on IBM WebSphere Application Server and Oracle Weblogic Server. For more information, see:

The instructions in this document explain how to install Red Hat Decision Manager on Red Hat JBoss EAP 7.1 and Red Hat JBoss Web Server 3.1 on premise. For information about installing on the Red Hat OpenShift Container Platform, see Deploying Red Hat Decision Manager on Red Hat OpenShift Container Platform.

For information on supported components, see the following documents:

Note

This section describes installing Decision Central and Decision Server on the same server. Red Hat recommends installing Decision Central and Decision Server on different servers in production environments.

2.1. Downloading the Red Hat Decision Manager installation files

Depending on your environment and installation requirements, download a Red Hat Decision Manager distribution.

Procedure

  1. Log in to the Red Hat Customer Portal.
  2. Click DOWNLOADS at the top of the page.
  3. On the Product Downloads page that opens, navigate to the JBOSS INTEGRATION AND AUTOMATION section, and click Red Hat Decision Manager.
  4. On the Software Downloads page, if necessary select BRMS from the Product menuand 7.0 from the Version menu.
  5. Download one of the following product distributions:

    • To use the installer to install Red Hat Decision Manager on Red Hat JBoss EAP 7.1 or Decision Server on Red Hat JBoss Web Server 3.1, download Red Hat Decision Manager 7.0.0 Installer (rhdm-installer-7.0.0.GA.jar).
    • To install Red Hat Decision Manager on Red Hat JBoss EAP 7.1 using the deployable zip files, download:

      • Red Hat Decision Manager 7.0.0 Decision Server for All Supported EE7 Containers (rhdm-7.0.0.GA-kie-server-ee7.zip)
      • Red Hat Decision Manager 7.0.0 Decision Central Deployable for Red Hat JBoss EAP 7 (rhdm-7.0.0.GA-kie-server-ee7.zip)
    • To run Decision Central without needing to deploy it to an application server, download Red Hat Decision Manager 7.0.0 Decision Central Standalone (rhdm-7.0.0.GA-decision-central-standalone.jar)
    • To install Decision Server on Red Hat JBoss Web Server 3.1 using the deployable zip file, download Red Hat Decision Manager 7.0.0 Add Ons (rhdm-7.0.0.GA-add-ons.zip)

Next steps

Go to one of the following sections:

2.2. Using the installer to install Red Hat Decision Manager on Red Hat JBoss EAP or Red Hat JBoss Web Server

This section describes the steps required to install Red Hat Decision Manager using the installer JAR file. The JAR file is an executable file that installs Red Hat Decision Manager in an existing Red Hat JBoss EAP 7.1 or Red Hat JBoss Web Server 3.1 with Tomcat 8 server installation. You can run the installer in standard or command line interface (CLI) mode.

Note

The Red Hat Decision Manager JAR file installer does not support the Red Hat JBoss EAP distribution installed by yum or RPM Package Manager. If you want to install Red Hat Decision Manager in this type of Red Hat JBoss EAP installation, download the Red Hat Decision Manager 7.0 Deployable for Red Hat JBoss EAP 7.1 file and follow the steps described in Section 2.3, “ZIP file installation for Red Hat Decision Manager on Red Hat JBoss EAP”.

Note

Because IBM JDK cannot use keystores generated on other JDKs, it is not possible to install Red Hat Decision Manager into an existing Red Hat JBoss EAP installation running on IBM JDK with a keystore generated on another JDK.

Next steps:

Follow the instructions in one of the following sections:

2.2.1. Installing Red Hat Decision Manager using the installer in interactive mode

The installer for Red Hat Decision Manager is an executable JAR file. You can use it to install Red Hat Decision Manager in an existing Red Hat JBoss EAP 7.1 or Red Hat JBoss Server 3.1 with Tomcat 8 server installation.

Note

For security reasons, you should run the installer as a non-root user.

Prerequisite

  • A backed up Red Hat JBoss EAP 7.1 or higher or Red Hat JBoss Web Server 3.1 with Tomcat 8 or higher server installation
  • Sufficient user permissions to complete the installation

    Note

    If you are installing Decision Server on Red Hat JBoss Web Server 3.1, ensure that you are logged in with a user that has write permission for Tomcat 8.

  • The JAR binary inlcuded in $PATH environment variable. On Red Hat Enterprise Linux, it is included in the java-$JAVA_VERSION-openjdk-devel package.

    Note

    Red Hat Decision Manager is designed to work with UTF-8 encoding. If a different encoding system is used by the underlying JVM, unexpected errors might occur. To ensure UTF-8 is used by the JVM, use the "-Dfile.encoding=UTF-8" system property.

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.0.0.GA.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.0.0.GA.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.0.0.GA.jar
  2. The graphical installer displays a splash screen and a license agreement page.
  3. Click I accept the terms of this license agreement and click Next.
  4. Specify the Red Hat JBoss EAP 7.1 or Red Hat JBoss 3.1 Web Server with Tomcat 8 server home where you want to install Red Hat Decision Manager and click Next.
  5. Select the components that you want to install and click Next.

    You cannot install Decision Central on Red Hat JBoss 3.1 Web Server with Tomcat 8. You can only install it on Red Hat JBoss EAP. However, you can install the Decision Central controller on Red Hat JBoss 3.1 Web Server with Tomcat 8. The controller is used to manage Decision Server. Install it if you plan to manage multiple Decision Server instances.

    Note

    It is possible to install Decision Central and Decision Server on the same server. However, Red Hat recommends installing Decision Central and Decision Server on different servers in production environments. To do this, run the installer twice.

  6. Create the Decision Manager admin user and click Next.

    Note

    Make sure that the selected 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 Decision Central and Decision Server.

  7. On the Component Installation page, click Next to start the installation. The Component Installation page lists the components that you will install.
  8. When the installation has completed, click Next on the Processing Finished page. On the next page,you will see the message Installation has completed successfully.
  9. If desired, click Generate Installation Script and Properties File to save the installation data in an XML file, then click Done. You can use this file to automatically install Red Hat Decision Manager on the same type of server. Note that you must change the installpath parameter in the XML file to specify the path of new server that you want to install Red Hat Decision Manager on. Enter the following command to perform an installation with the XML file:

    java -jar rhdm-installer-7.0.0.GA.jar <path-to-file>

You have successfully installed Red Hat Decision Manager using the installer. On Red Hat JBoss EAP, if you installed only Decision Central, repeat these steps to install Decision Server on a separate server.

To start Red Hat Decision Manager, enter one of the following commands:

  • On Red Hat JBoss EAP 7.1, enter one of the following commands:

    • On Linux or UNIX-based systems:

      $ EAP_HOME/bin/standalone.sh
    • On Windows:

      EAP_HOME\bin\standalone.bat
  • On Red Hat JBoss Web Server 3.1 with Tomcat 8, enter one of the following commands:

    • On Linux or UNIX-based systems:

      JWS_HOME/bin/startup.sh
    • On Windows:

      JWS_HOME\bin\startup.sh

2.2.2. Installing Red Hat Decision Manager using the installer in CLI mode

You can run the installer for Red Hat Decision Manager through the command-line interface (CLI).

Note

For security reasons, you should run the installer as a non-root user.

Prerequisite

  • A backed up Red Hat JBoss EAP 7.1 or higher or Red Hat JBoss Web Server 3.1 with Tomcat 8 or higher server installation
  • Sufficient user permissions to complete the installation

    Note

    If you are installing Decision Server on Red Hat JBoss Web Server 3.1, ensure that you are logged in with a user that has write permission for Tomcat 8.

  • The JAR binary inlcuded in $PATH environment variable. On Red Hat Enterprise Linux, it is included in the java-$JAVA_VERSION-openjdk-devel package.

    Note

    Red Hat Decision Manager is designed to work with UTF-8 encoding. If a different encoding system is used by the underlying JVM, unexpected errors might occur. To ensure UTF-8 is used by the JVM, use the "-Dfile.encoding=UTF-8" system property.

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.0.0.GA.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 then enter 1 and press Enter to continue:

    Specify the home directory of one of the following servers:  Red Hat JBoss EAP 7.1 or Tomcat 8
    [/home/user/RHDM-7.0.0/jboss-eap-7.1]
  3. Enter the parent directory of an existing Red Hat JBoss EAP 7.1 or Red Hat JBoss Web Server 3.1 with Tomcat 8 installation.

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

    Note

    It is possible to install Decision Manager and Decision Server on the same server. However, Red Hat recommends installing Decision Central and Decision 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 Decision Central and Decision 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 an XML file that contains the installation data, or n to complete the installation. If you enter y, you are prompted to specify a path for the XML file.
  7. Enter a path or press the Enter key to accept the suggested path.

You have successfully installed Red Hat Decision Manager. If you installed only Decision Central, repeat these steps to install Decision Server on a separate server.

2.3. ZIP file installation for Red Hat Decision Manager on Red Hat JBoss EAP

The deployable ZIP file installation of Red Hat Decision Manager 7.0 on Red Hat JBoss EAP consists of two ZIP files, one for Decision Central and one for Decision Server.

In a production environment, you should install Decision Central and Decision Server on separate servers.

2.3.1. Installing Decision Central using the deployable zip file

Decision Central is a web console that enables you to perform the following tasks over individual components in a unified web-based environment:

  • Create, manage, and edit your rules and related assets.
  • Manage connected Decision Servers and their containers.

Prerequisites

  • A backed up Red Hat JBoss EAP installation, version 7.1 or higher
  • Sufficient user permissions to complete the installation
  • The following file, downloaded by clicking Download next to Decision Central for EAP 7 on the Product Downloads page of the Red Hat Customer Portal:

    rhdm-7.0.0.GA-decision-central-eap7-deployable.zip

Procedure

  1. Extract the rhdm-7.0.0.GA-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.0.0.GA-decision-central-eap7-deployable/jboss-eap-7.1 directory to EAP_HOME. When asked to overwrite files or merge directories, select Yes.

    Warning

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

2.3.2. Installing Decision Server using the deployable zip file

Decision Server provides the runtime environment for business assets and accesses the data stored in the assets repository (knowledge store).

Prerequisites

  • A backed up Red Hat JBoss EAP installation, version 7.1 or higher. The base directory of the Red Hat JBoss EAP installation is referred to as EAP_HOME.
  • Sufficient user permissions to complete the installation.
  • The following file, downloaded by clicking Download next to Decision Server on the Product Downloads page of the Red Hat Customer Portal:

    rhdm-7.0.0.GA-kie-server-ee7.zip

    Procedure

    1. Extract the rhdm-7.0.0.GA-kie-server-ee7.zip archive to a temporary directory. In the following examples, this directory is called TEMP_DIR.
    2. Copy the TEMP_DIR/rhdm-7.0.0.GA-kie-server-ee7/rhdm-7.0.0.GA-kie-server-ee7/kie-server.war directory to EAP_HOME/standalone/deployments/.

      Warning

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

    3. Copy the contents of the TEMP_DIR/rhdm-7.0.0.GA-kie-server-ee7/rhdm-7.0.0.GA-kie-server-ee7/SecurityPolicy/ to EAP_HOME/bin. When asked to overwrite files, select Yes.
    4. In the EAP_HOME/standalone/deployments/ directory, create an empty file named kie-server.war.dodeploy. This file ensures that Decision Server is automatically deployed when the server starts.

2.3.3. Creating users

Before you can use Decision Central, you must create a user that has the admin role. To log in to Decision Server, you must create a user that has the kie-server role. You can create a single user that has both of these roles.

Prerequisites

Red Hat Decision Manager installed in an EAP_HOME as described in one of the following sections:

Procedure

  1. In a terminal application, navigate to the EAP_HOME/bin directory.
  2. Create a user that you will use to log in to Decision Central and Decision Server. 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 kie-server,admin
    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. Make a note of your user name and password.

2.3.4. Configuring Decision Server

If Decision Server will be managed by Decision Central, you must edit the standalone.xml file in both the Decision Server and Decision Central installations, as described in this section.

Note

Only make these changes if Decision Server will be managed by Decision Central.

Prerequisites

Procedure

  1. In the Decision Central EAP_HOME/standalone/configuration/standalone.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 Decision Server EAP_HOME/standalone/configuration/standalone.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. In this file, 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 Decision Server installation, for example, rhdm700-decision-server-1.
    • Replace <HOST> with the ID or name of the Decision Server host, for example, localhost or 192.7.8.9.
    • Replace <PORT> with the port of the Decision Server host, for example, 8080.

      Note

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

    • Replace <DECISION_CENTRAL_URL> with the URL of Decision Central. Decision Server connects to this URL during startup.

2.3.5. Running Red Hat Decision Manager

After you have installed Red Hat Decision Manager on Red Hat JBoss EAP, use this procedure to run the Red Hat Decision Manager in standalone mode.

Prerequisites

Procedure

  1. In a terminal application, navigate to EAP_HOME/bin.
  2. Run the standalone configuration:

    • On Linux or UNIX-based systems:

      $ ./standalone.sh
    • On Windows:

      standalone.bat
      Note

      If you deployed Decision Server without Decision Central on Red Hat JBoss EAP then you must use one of the following commands to start Red Hat JBoss EAP with the standalone-full profile.

      On Linux or UNIX-based systems:

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

      On Windows:

      standalone.bat -c standalone-full.xml
  3. In a web browser, open the URL localhost:8080/decision-central.
  4. Log in using the user name rhdmAdmin and the password password@1.

2.4. Installing Decision Server on Red Hat JBoss Web Server ZIP installation

Decision Server provides the runtime environment for business assets and accesses the data stored in the assets repository (knowledge store). This section explains how to perform the ZIP file installation to install Decision Server on an existing Red Hat JBoss Web Server 3.1 instance.

Prerequisites

  • A backed up Red Hat JBoss Web Server 3.1 with Tomcat 8 or higher server installation. The base directory of the JBoss Web Server installation is referred to as JWS_HOME.
  • Sufficient user permissions to complete the installation.
  • The rhdm-7.0-kie-server-jws.zip file. To download this file:

    1. Click Download next to Red Hat Decision Manager 7.0.0 Add Ons on the Product Downloads page of the Red Hat Customer Portal.
    2. Unzip the rhdm-7.0.0.GA-add-ons.zip file. The rhdm-7.0-kie-server-jws.zip file is in the unzipped directory.

Procedure

  1. Extract the rhdm-7.0-kie-server-jws.zip archive to a temporary directory. In the following examples, this directory is called TEMP_DIR.
  2. Copy the TEMP_DIR/rhdm-7.0-kie-server-jws/kie-server.war directory to the JWS_HOME/tomcat8/webapps directory.

    Warning

    Ensure the names of the Red Hat Decision Manager deployments you are copying do not conflict with your existing deployments in the Red Hat JBoss Web Server instance.

  3. Remove the .war extensions from the kie-server.war folder.
  4. Open the JWS_HOME/tomcat8/conf/tomcat-users.xml file in a text editor.
  5. Add users and roles to the JWS_HOME/tomcat8/conf/tomcat-users.xml file. In the following example, <ROLE_NAME> is a role supported by Red Hat Decision Manager. For a list of supported roles, see Section 1.3, “User roles”. <USERNAME> and <PASSWORD> is a user and password combination of your choice:

    <role rolename="<ROLE_NAME>"
    <user username="<USER_NAME> password="<PASSWORD>" 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="rhdmUser" password="user1234" roles="admin,kie-server"/>
  6. In the JWS_HOME/tomcat8/bin directory, create a readable setenv.sh file with the following content:

    CATALINA_OPTS="-Xmx1024m -Dorg.jbpm.server.ext.disabled=true -Dorg.jbpm.ui.server.ext.disabled=true -Dorg.jbpm.case.server.ext.disabled=true"

    Important

    On Microsoft Windows, add the following values to the setenv.bat file:

    set "CATALINA_OPTS=-Xmx1024m -Dorg.jbpm.server.ext.disabled=true -Dorg.jbpm.ui.server.ext.disabled=true -Dorg.jbpm.case.server.ext.disabled=true"

  7. To start JBoss Web Server, enter one of the following commands in the JWS_HOME/tomcat8/bin directory:

    • On Linux or UNIX-based systems:

      $ ./startup.sh
    • On Windows:

      startup.bat
  8. After a few minutes, review the the JWS_HOME/tomcat8/logs directory and correct any errors.

2.4.1. Verifying Decision Server on Red Hat JBoss Web Server

To verify that Decision Server is working on Red Hat JBoss Web Server, enter the following command:

curl -X GET "http://localhost:8080/kie-server/services/rest/server" -H  "accept: application/xml" -u '<CONTROLLER>:<CONTROLLER_PWD>'

In this command, replace <CONTROLLER> and <CONTROLLER_PWD> with the values in the tomcat-users.xml file.

The output of this command provides information about the Decision Server instance.

2.5. Running standalone Decision Central

You can use the Decision Central standalone JAR file to run Decision Central without needing to deploy it to an application server such as Red Hat JBoss EAP.

Note

Red Hat supports this installation type only when it is installed on premise, on Red Hat Enterprise Linux.

Procedure

  1. Download the Decision Central standalone JAR file from the Red Hat Customer Portal.
  2. In a terminal window, navigate to the directory where you downloaded the installer file.
  3. Create the application-config.yaml configuration file with the following contents:

    swarm:
      management:
        security-realms:
          ApplicationRealm:
            local-authentication:
              default-user: local
              allowed-users: local
              skip-group-loading: true
            properties-authentication:
              path: /path/to/application-users.properties
              plain-text: true
            properties-authorization:
              path: /path/to/application-roles.properties
    datasource:
      management:
        wildfly:
          admin: admin
  4. Create the application-users.properties file. Include an administrative user and if this Decision Central instance will be a controller for Decision Server, include a controller user, for example:

    rhdmAdmin=password1
    controllerUser=controllerUser1234
  5. Create the application-roles.properties file to assign roles to the users that you included in the application-users.properties file, for example:

    rhdmAdmin=admin
    controllerUser=kie-server

    For more information, see Section 1.3, “User roles”.

  6. Enter the following command:

    java -jar rhdm-7.0.0.GA-decision-central-standalone.jar -s
    application-config.yaml

    In addition, you can set any properties supported by Decision Central by including the -D<property>=<value> parameter in this command, for example:

    java -jar rhdm-7.0.0.GA-decision-central-standalone.jar -s
    application-config.yaml -D<property>=<value> -D<property>=<value>

    See Section 2.5.1, “Supported properties” for more information.

2.5.1. Supported properties

When you install standalone Decision Central, you can use the properties listed in this section in the following command:

java -jar rhdm-7.0.0.GA-decision-central-standalone.jar -s application-config.yaml -D<property>=<value> -D<property>=<value>

In this command, <property> is a property from the following list and <value> is a value that you assign to that property:

  • org.uberfire.nio.git.dir: Location of the directory .niogit. Default: working directory
  • org.uberfire.nio.git.dirname: Name of the git directory. Default: .niogit
  • org.uberfire.nio.git.daemon.enabled: Enables or disables the git daemon. Default: true
  • org.uberfire.nio.git.daemon.host: If the git daemon is enabled, uses this property as the local host identifier. Default: localhost
  • org.uberfire.nio.git.daemon.port: If the git daemon is enabled, uses this property as the port number. Default: 9418
  • org.uberfire.nio.git.ssh.enabled: Enables or disables the SSH daemon. Default: true
  • org.uberfire.nio.git.ssh.host: If the SSH daemon enabled, uses this property as the local host identifier. Default: localhost
  • org.uberfire.nio.git.SSH.port: If the SSH daemon is enabled, uses this property as the port number. Default: 8001
  • org.uberfire.nio.git.ssh.cert.dir: Location of the directory .security where local certificates will be stored. Default: working directory
  • org.uberfire.nio.git.ssh.passphrase: Pass phrase to access the public key store of your operating system when cloning git repositories with SCP style URLs. Example: git@github.com:user/repository.git.
  • org.uberfire.nio.git.ssh.algorithm: Algorithm used by SSH. Default: DSA

    Note

    If you plan to use RSA or any algorithm other than DSA, make sure you set up your application server to use the Bouncy Castle JCE library.

  • org.uberfire.metadata.index.dir: Place where Lucene .index folder will be stored. Default: working directory
  • org.uberfire.ldap.regex.role_mapper: Regex pattern used to map LDAP principal names to application role name. Note that the variable role must be part of the pattern as it is substited by the application role name when matching a principal value to role name. Default: Not used.
  • org.uberfire.sys.repo.monitor.disabled: Disable configuration monitor (do not disable unless you know what you’re doing). Default: false
  • org.uberfire.secure.key: Secret password used by password encryption. Default`: org.uberfire.admin
  • org.uberfire.secure.alg: Crypto algorithm used by password encryption. Default: PBEWithMD5AndDES
  • org.uberfire.domain: security-domain name used by uberfire. Default: ApplicationRealm
  • org.guvnor.m2repo.dir: Place where Maven repository folder will be stored. Default: working-directory/repositories/kie
  • org.guvnor.project.gav.check.disabled: Disable GAV checks. Default: false
  • org.kie.build.disable-project-explorer: Disable automatic build of selected Project in Project Explorer. Default: false
  • org.kie.verification.disable-dtable-realtime-verification: Disables the realtime validation and verification of decision tables. Default: false
  • org.kie.server.controller: URL for connecting with a Kie Server Controller, for example: ws://localhost:8080/decision-central/websocket/controller.
  • org.kie.example: Enables external clone of a demo application from GitHub.
  • org.kie.build.disable-project-explorer: Disable automatic build of selected Project in Project Explorer. Default: false
  • org.kie.verification.disable-dtable-realtime-verification: Disables the realtime validation and verification of decision tables. Default: false
  • org.kie.server.controller: URL for connecting with a Kie Server Controller, for example: ws://localhost:8080/decision-central/websocket/controller.
  • org.kie.server.user: User name used to connect with the Decision Server nodes from the controller. This property is only required when using this Decision Central installation as a controller.
  • org.kie.server.pwd: Password used to connect with the Decision Server nodes from the controller. This property is only required when using this Decision Central installation as a controller.

2.6. Installing and running the standalone Decision Server Controller

You can configure Decision Server to run in managed or unmanaged mode. If Decision Server is unmanaged, you must manually create and maintain containers. If Decision Server is managed, the standalone Decision Server Controller manages the Decision Server configuration and you interact with the Controller to create and maintain containers.

The standalone Decision Server Controller is integrated with Decision Central. If you install Decision Central, use the Exection Server page to create and maintain containers. However, if you do not install Decision Central, you can install the standalone Decision Server Controller and use the REST API or the Decision Server Java Client API to interact with it.

2.6.1. Installing the standalone Decision Server Controller on Red Hat JBoss EAP

You can install the standalone Decision Server Controller and use the REST API or the Decision Server Java Client API to interact with it.

Prerequisites

  • A backed up Red Hat JBoss EAP installation, version 7.1 or higher. The base directory of the Red Hat JBoss EAP installation is referred to as EAP_HOME.
  • Sufficient user permissions to complete the installation. *

Procedure

  1. Download the rhdm-7.0-controller-ee7.zip file by clicking Download next to Red Hat Decision Manager 7.0.0 Add Ons on the Product Downloads page of the Red Hat Customer Portal.
  2. Unzip the rhdm-7.0.0.GA-add-ons.zip file. The rhdm-7.0-controller-ee7.zip file is in the unzipped directory.
  3. Extract the rhdm-7.0-controller-ee7 archive to a temporary directory. In the following examples, this directory is called TEMP_DIR.
  4. Copy the TEMP_DIR/rhdm-7.0-controller-ee7/controller.war directory to EAP_HOME/standalone/deployments/.

    Warning

    Ensure the names of the standalone Decision Server Controller deployments you are copying do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

  5. Copy the contents of the TEMP_DIR/rhdm-7.0-controller-ee7/SecurityPolicy/ directory to EAP_HOME/bin. When asked to overwrite files, select Yes.
  6. In the EAP_HOME/standalone/deployments/ directory, create an empty file named controller.war.dodeploy. This file ensures that the standalone Decision Server Controller is automatically deployed when the server starts.

2.6.1.1. Creating users

Before you can use the standalone Decision Server Controller, you must create a user that has the kie-server role.

Prerequisite

The controller installed in an EAP_HOME home.

Procedure

  1. In a terminal application, navigate to the EAP_HOME/bin directory.
  2. Enter the following command and replace <USER_NAME> and <PASSWORD> with the user name and password of your choice.

    $ ./add-user.sh -a --user <username> --password <password> --role 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. Make a note of your user name and password.

2.6.1.2. Configuring Decision Server and the standalone Decision Server Controller

If Decision Server will be managed by the standalone Decision Server Controller, you must edit the standalone.xml file in both the Decision Server and standalone Decision Server Controller installations, as described in this section.

Prerequisites

Procedure

  1. In the Controller EAP_HOME/standalone/configuration/standalone.xml file, add the following properties to 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 Decision Server EAP_HOME/standalone/configuration/standalone.xml file, add the following properties to 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. In this file, replace the following values:

    • Replace <CONTROLLER_USER> and <CONTROLLER_PWD> with the credentials of a user with the kie-server role.
    • Replace <KIE_SERVER_ID> with the ID or name of the Decision Server installation, for example, rhdm700-decision-server-1.
    • Replace <HOST> with the ID or name of the Decision Server host, for example, localhost or 192.7.8.9.
    • Replace <PORT> with the port of the Decision Server host, for example, 8080.

      Note

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

    • Replace <CONTROLLER_URL> with the URL of the standalone Decision Server Controller. Decision Server connects to this URL during startup, for example:

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

2.6.1.3. Running the standalone Decision Server Controller

After you have installed the standalone Decision Server Controller on Red Hat JBoss EAP, use this procedure to run the standalone Decision Server Controller.

Prerequisite

The standalone Decision Server Controller installed and configured in an EAP_HOME

Procedure

  1. In a terminal application, navigate to EAP_HOME/bin.
  2. Enter the following command:

    • On Linux or UNIX-based systems:

      $ ./standalone.sh
    • On Windows:

      standalone.bat
  3. To verify that the 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 2.6.1.1, “Creating users”. The output of this command provides information about the Decision Server instance.

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

Alternatively, you can use the Decision Server Java API Client to access the standalone Decision Server Controller.

2.6.2. Installing the standalone Decision Server Controller on Red Hat JBoss Web Server

You can install the standalone Decision Server Controller and use the REST API or the Decision Server Java Client API to interact with it.

Prerequisites

  • A backed up Red Hat JBoss Web Server 3.1 with Tomcat 8 or higher server installation. The base directory of the JBoss Web Server installation is referred to as JWS_HOME.
  • Sufficient user permissions to complete the installation.
  • The rhdm-7.0-controller-jws.zip file. To download this file:

    1. Click Download next to Red Hat Decision Manager 7.0.0 Add Ons on the Product Downloads page of the Red Hat Customer Portal.
    2. Unzip the rhdm-7.0.0.GA-add-ons.zip file. The rhdm-7.0-controller-jws.zip file is in the unzipped directory.

Procedure

  1. Extract the rhdm-7.0-controller-jws.zip archive to a temporary directory. In the following examples, this directory is called TEMP_DIR.
  2. Copy the TEMP_DIR/rhdm-7.0-controller-jws.zip/controller.war directory to the JWS_HOME/tomcat8/webapps directory.

    Warning

    Ensure the names of the Red Hat Decision Manager deployments you are copying do not conflict with your existing deployments in the Red Hat JBoss Web Server instance.

  3. Remove the .war extensions from the controller.war folder.
  4. Copy the contents of the TEMP_DIR/rhdm-7.0-controller-jws/SecurityPolicy/ directory to JWS_HOME/bin. When asked to overwrite files, select Yes.
  5. In the JWS_HOME/standalone/deployments/ directory, create an empty file named controller.war.dodeploy. This file ensures that the standalone Decision Server Controller is automatically deployed when the server starts.
  6. Add the kie-server role and user to the JWS_HOME/tomcat8/conf/tomcat-users.xml file. In the following example, <USERNAME> and <PASSWORD> is a user and password combination of your choice:

    <role rolename="kie-server"/>
    <user username="<USER_NAME>" password="<PASSWORD>" roles="kie-server"/>
  7. In the JWS_HOME/tomcat8/bin directory of the instance running Decision Server, create a readable setenv.sh file with the following content:

    CATALINA_OPTS="-Xmx1024m -Dorg.jbpm.server.ext.disabled=true -Dorg.jbpm.ui.server.ext.disabled=true -Dorg.jbpm.case.server.ext.disabled=true -Dorg.kie.server.controller.user=<CONTROLLER_USER> -Dorg.kie.server.controller.pwd=<CONTROLLER_PWD> -Dorg.kie.server.id=<KIE_SERVER_ID> -Dorg.kie.server.location=http://<HOST>:<PORT>/kie-server/services/rest/server -Dorg.kie.server.controller=http://<HOST>:<PORT>/controller/rest/controller"

  8. In the JWS_HOME/tomcat8/bin directory of the instance running the standalone Decision Server Controller, create a readable setenv.sh file with the following content:

    CATALINA_OPTS="-Dorg.kie.server.user=<USERNAME> -Dorg.kie.server.pwd=<USER_PWD>"

  9. To start the standalone Decision Server Controller, enter one of the following commands in the JWS_HOME/tomcat8/bin directory:

    • On Linux or UNIX-based systems:

      $ ./startup.sh
    • On Windows:

      startup.bat
  10. After a few minutes, review the the JWS_HOME/tomcat8/logs directory and correct any errors.
  11. To verify that the Controller is working on Red Hat JBoss Web Server, enter the following command. In this command, replace <CONTROLLER> and <CONTROLLER_PWD> with the values in the tomcat-users.xml file. The output of this command provides information about the Decision Server instance.

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

Alternatively, you can use the Decision Server Java API Client to access the standalone Decision Server Controller.