Chapter 14. Installing Red Hat Process Automation Manager from ZIP files

Procedure

1. Extract the rhpam-7.12.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.12.0-business-central-eap7-deployable/jboss-eap-7.4 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.12.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.12.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.12.0-kie-server-ee8/rhpam-7.12.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.12.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.12.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.12.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. Optional: To change Red Hat Process Automation Manager from using property-based user storage to file-based user storage, complete the following steps:

   1. Run the following command to apply the kie-fs-realm patch:

      $ ./bin/elytron-tool.sh filesystem-realm --users-file application-users.properties --roles-file application-roles.properties --output-location kie-fs-realm-users

   2. Open each kie-fs-realm-users/*/<USER>.xml file where <USER> is a Red Hat Process Automation Manager user.
   3. Replace <attribute name="roles" value= with <attribute name="role" value=.
2. In a terminal application, navigate to the EAP_HOME/bin directory.

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

   $ ./bin/jboss-cli.sh --commands="embed-server --std-out=echo,/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity(identity=<USERNAME>),/subsystem=elytron/filesystem-realm=ApplicationRealm:set-password(identity=<USERNAME>, clear={password=<PASSWORD>}),/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity-attribute(identity=<USERNAME>, name=role, value=[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).

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

   $ ./bin/jboss-cli.sh --commands="embed-server --std-out=echo,/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity(identity=<USERNAME>),/subsystem=elytron/filesystem-realm=ApplicationRealm:set-password(identity=<USERNAME>, clear={password='<PASSWORD>'}),/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity-attribute(identity=<USERNAME>, name=role, value=[kie-server])"

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

6. Optional: 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:

   $ ./bin/jboss-cli.sh --commands="embed-server --std-out=echo,/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity(identity=<USERNAME>),/subsystem=elytron/filesystem-realm=ApplicationRealm:set-password(identity=<USERNAME>, clear={password='<PASSWORD>'}),/subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity-attribute(identity=<USERNAME>, name=role, value=[admin,rest-all,kie-server])"

   Note

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

7. Optional: To create several users at one time, create a file that contains the user data and run the following command, where <USER_DATA>.cli is the file that contains the user data:

   $ ./bin/jboss-cli.sh --file=<USER_DATA>.cli

   The <USER_DATA>.cli file should contain data similar to the following example:

   embed-server --std-out=echo
   
   # first user
   /subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity(identity=<USERNAME>)
   /subsystem=elytron/filesystem-realm=ApplicationRealm:set-password(identity=<USERNAME>, clear={password='<PASSWORD>'})
   /subsystem=elytron/filesystem-realm=ApplicationRealm:add-identity-attribute(identity=<USERNAME>, name=role, value=[admin,role,group])
   
   # second user
   ...

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

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.
3. Under the <system-properties> tag, set the value of the following JVM properties to the number of CPUs plus one: