Chapter 36. KIE Server ZIP file installation and configuration

Procedure

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

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

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

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

3. Copy the JWS_TEMP_DIR/rhpam-7.11.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.52.0.Final-redhat-00007.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" />

   Copy to Clipboard Toggle word wrap
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>"/>

   Copy to Clipboard Toggle word wrap

   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"/>

   Copy to Clipboard Toggle word wrap

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"

      Copy to Clipboard Toggle word wrap

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

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

      Copy to Clipboard Toggle word wrap

Procedure

1. Complete the following steps to prepare your database:

   1. Extract rhpam-7.11.0-add-ons.zip in a temporary directory, for example TEMP_DIR.
   2. Extract TEMP_DIR/rhpam-7.11.0-migration-tool.zip.
   3. Change your current directory to the TEMP_DIR/rhpam-7.11.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

      Copy to Clipboard Toggle word wrap
      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.11.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

   Copy to Clipboard Toggle word wrap
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 36.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>

      Copy to Clipboard Toggle word wrap
      Expand

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

      Show more

   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>

      Copy to Clipboard Toggle word wrap

      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

        Copy to Clipboard Toggle word wrap

      • For Windows:

        JWS_HOME/tomcat/bin/setenv.bat

        Copy to Clipboard Toggle word wrap

   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>}"

      Copy to Clipboard Toggle word wrap