This document describes how to install IBM Business Automation Manager Open Editions on a Red Hat JBoss Enterprise Application Platform 7.4 instance.

Prerequisites

About IBM Business Automation Manager Open Editions

IBM Business Automation Manager Open Editions is the IBM middleware platform for creating business automation applications and microservices. It enables enterprise business and IT users to document, simulate, manage, automate, and monitor business processes and policies. It is designed to empower business and IT users to collaborate more effectively, so business applications can be changed easily and quickly.

IBM Business Automation Manager Open Editions is an open source decision management platform that combines business rules management, complex event processing, and Decision Model & Notation (DMN) execution for solving planning problems. It automates business decisions and makes that logic available to the entire business.

Business assets such as rules, decision tables, and DMN models are organized in projects and stored in the Business Central repository. This ensures consistency, transparency, and the ability to audit across the business. Business users can modify business logic without requiring assistance from IT personnel.

IBM Business Automation Manager is made up of Business Central and KIE Server.

  • KIE Server is the server where rules and other artifacts are executed. It is used to instantiate and execute rules and solve planning problems. KIE Server provides the runtime environment for business assets and accesses the data stored in the assets repository (knowledge store).

  • Business Central is the graphical user interface where you create and manage business rules that KIE Server executes.

  • Business Central is the graphical user interface where you create and manage business rules that KIE Server executes. It enables you to perform the following tasks:

    • Create, manage, and edit your rules, processes, and related assets.

    • Manage connected KIE Server instances and their KIE containers (deployment units).

    • Execute runtime operations against processes and tasks in KIE Server instances connected to Business Central.

      Business Central is also available as a standalone JAR file. You can use the Business Central standalone JAR file to run Business Central without needing to deploy it to an application server.

Red Hat JBoss Enterprise Application Platform (Red Hat JBoss EAP) 7.4 is a certified implementation of the Java Enterprise Edition 8 (Java EE 8) 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.

The instructions in this document explain how to install IBM Business Automation Manager Open Editions in a Red Hat JBoss EAP 7.4 server instance.

For instructions on how to install IBM Business Automation Manager Open Editions in other environments, see the following documents:

IBM Business Automation Manager Open Editions roles and users

To access Business Central or KIE Server, you must create users and assign them appropriate roles before the servers are started. You can create users and roles when you install Business Central or KIE Server.

If both Business Central and KIE Server are running on a single instance, a user who is authenticated for Business Central can also access KIE Server.

However, if Business Central and KIE Server are running on different instances, a user who is authenticated for Business Central must be authenticated separately to access KIE Server. For example, if a user who is authenticated on Business Central but not authenticated on KIE Server tries to view or manage process definitions in Business Central, a 401 error is logged in the log file and the Invalid credentials to load data from remote server. Contact your system administrator. message appears in Business Central.

This section describes IBM Business Automation Manager Open Editions user roles.

Note

The admin, analyst, developer, manager, process-admin, user, and rest-all roles are reserved for Business Central. The kie-server role is reserved for KIE Server. For this reason, the available roles can differ depending on whether Business Central, KIE Server, or both are installed.

  • admin: Users with the admin role are the Business Central administrators. They can manage users and create, clone, and manage repositories. They have full access to make required changes in the application. Users with the admin role have access to all areas within IBM Business Automation Manager Open Editions.

  • analyst: Users with the analyst role have access to all high-level features. They can model and execute their projects. However, these users cannot add contributors to spaces or delete spaces in the Design → Projects view. Access to the Deploy → Execution Servers view, which is intended for administrators, is not available to users with the analyst role. However, the Deploy button is available to these users when they access the Library perspective.

  • developer: Users with the developer role have access to almost all features and can manage rules, models, process flows, forms, and dashboards. They can manage the asset repository, they can create, build, and deploy projects. Only certain administrative functions such as creating and cloning a new repository are hidden from users with the developer role.

  • manager: Users with the manager role can view reports. These users are usually interested in statistics about the business processes and their performance, business indicators, and other business-related reporting. A user with this role has access only to process and task reports.

  • process-admin: Users with the process-admin role are business process administrators. They have full access to business processes, business tasks, and execution errors. These users can also view business reports and have access to the Task Inbox list.

  • user: Users with the user role can work on the Task Inbox list, which contains business tasks that are part of currently running processes. Users with this role can view process and task reports and manage processes.

  • rest-all: Users with the rest-all role can access Business Central REST capabilities.

  • kie-server: Users with the kie-server role can access KIE Server REST capabilities. This role is mandatory for users to have access to Manage and Track views in Business Central.

Downloading the IBM Business Automation Manager Open Editions installation files

You can use the installer JAR file or deployable ZIP files to install IBM Business Automation Manager Open Editions. You can run the installer in interactive or command line interface (CLI) mode. Alternatively, you can extract and configure the Business Central and KIE Server deployable ZIP files. If you want to run Business Central without deploying it to an application server, download the Business Central Standalone JAR file.

Download an IBM Business Automation Manager Open Editions distribution that meets your environment and installation requirements.

Procedure

Using the IBM Business Automation Manager Open Editions installer

This section describes how to install Business Central and KIE Server using the installer JAR file. The JAR file is an executable file that installs IBM Business Automation Manager Open Editions in an existing Red Hat JBoss EAP 7.4 server installation. You can run the installer in interactive or command line interface (CLI) mode.

Note

The IBM Business Automation Manager Open Editions JAR file installer does not support the Red Hat JBoss EAP distribution installed by yum or RPM Package Manager. If you want to install IBM Business Automation Manager Open Editions in this type of Red Hat JBoss EAP installation, download the IBM Business Automation Manager Open Editions 8.0 - Business Central for EAP 7 file and follow the steps in Installing IBM Business Automation Manager Open Editions from ZIP files.

Note

Because IBM JDK cannot use keystores generated on other JDKs, you cannot install IBM Business Automation Manager Open Editions 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:

Using the installer in interactive mode

The installer for IBM Business Automation Manager Open Editions is an executable JAR file. You can use it to install IBM Business Automation Manager Open Editions in an existing Red Hat JBoss EAP 7.4 server installation.

Note

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

Prerequisites
  • The IBM Business Automation Manager Open Editions 8.0 - Installer has been downloaded from the IBM Business Automation Manager Open Editions 8.0 downloads page .

  • A supported JDK is installed. For a list of supported JDKs, see IBM Business Automation Manager Open Editions 8 system requirements.

  • A backed-up Red Hat JBoss EAP 7.4 server installation is available.

  • Sufficient user permissions to complete the installation are granted.

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

    Note

    IBM Business Automation Manager Open Editions 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. For a list of system properties, see Business Central system properties.

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

    java -jar IBAMOE-8.0-INS.Jar
    java -jar IBAMOE-8.0-INS.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
    IBAMOE-8.0-INS.Jar
    IBAMOE-8.0-INS.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
    IBAMOE-8.0-INS.Jar
    IBAMOE-8.0-INS.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.4 server home where you want to install IBM Business Automation Manager Open Editions 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 IBM Business Automation Manager Open Editions 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 IBM Business 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 IBM Business Automation Manager Open Editions 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 IBAMOE-8.0-INS.Jar <path-to-auto.xml-file>
    java -jar IBAMOE-8.0-INS.Jar <path-to-auto.xml-file>

You have successfully installed IBM Business Automation Manager Open Editions using the installer. If you installed only Business Central, repeat these steps to install KIE Server on a separate server.

Note

If you use Microsoft SQL Server, make sure you have configured applicable transaction isolation for your database. If you do not, you may experience deadlocks. The recommended configuration is to turn on ALLOW_SNAPSHOT_ISOLATION and READ_COMMITTED_SNAPSHOT by entering the following statements:

ALTER DATABASE <DBNAME> SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE <DBNAME> SET READ_COMMITTED_SNAPSHOT ON

Using the installer in CLI mode

You can use the command-line interface (CLI) to run the IBM Business Automation Manager Open Editions installer.

Note

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

Prerequisites
  • The IBM Business Automation Manager Open Editions 8.0 - Installer has been downloaded from the IBM Business Automation Manager Open Editions 8.0 downloads page .

  • A supported JDK is installed. For a list of supported JDKs, see IBM Business Automation Manager Open Editions 8 system requirements.

  • A backed-up Red Hat JBoss EAP 7.4 server installation is available.

  • Sufficient user permissions to complete the installation are granted.

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

    Note

    IBM Business Automation Manager Open Editions 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. For a list of system properties, see Business Central system properties.

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

    java -jar IBAMOE-8.0-INS.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.
Specify the home directory of one of the following servers:  {EAP} 7 or {JWS} 5. For more information, see https://access.redhat.com/articles/3354301[Red Hat Decision Manager 7 Supported Configurations].

+ . Enter the parent directory of an existing Red Hat JBoss EAP 7.4 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.

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

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

    Would you like to generate an automatic installation script and properties file?
  3. 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.

  4. 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 an IBM Business Automation Manager Open Editions 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 IBAMOE-8.0-INS.Jar <path-to-auto.xml-file>
  5. If you installed only Business Central, repeat these steps to install KIE Server on a separate server.

Note

If you use Microsoft SQL Server, make sure you have configured applicable transaction isolation for your database. If you do not, you may experience deadlocks. The recommended configuration is to turn on ALLOW_SNAPSHOT_ISOLATION and READ_COMMITTED_SNAPSHOT by entering the following statements:

ALTER DATABASE <DBNAME> SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE <DBNAME> SET READ_COMMITTED_SNAPSHOT ON

Using the installer to configure KIE Server with the IBM Business Automation Manager controller

KIE Server can be managed by the IBM Business Automation Manager controller or it can be unmanaged. If KIE Server is unmanaged, you must manually create and maintain KIE containers (deployment units). If KIE Server is managed, the IBM Business Automation Manager controller manages the KIE Server configuration and you interact with the IBM Business Automation Manager controller to create and maintain KIE containers.

The IBM Business Automation Manager controller is integrated with Business Central. If you install Business Central, you can use the Execution Server page in Business Central to interact with the IBM Business Automation Manager controller.

You can use the installer in interactive or CLI mode to install Business Central and KIE Server, and then configure KIE Server with the IBM Business Automation Manager controller.

Prerequisites
  • Two computers with backed-up Red Hat JBoss EAP 7.4 server installations are available.

  • Sufficient user permissions to complete the installation are granted.

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

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

Installing IBM Business Automation Manager Open Editions from ZIP files

You can use the IBM Business Automation Manager Open Editions ZIP files (one for Business Central and one for KIE Server) to install IBM Business Automation Manager Open Editions without using the installer.

Note

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

For information about installing the headless IBM Business Automation Manager controller, see Installing and running the headless IBM Business Automation Manager controller.

Installing Business Central from the ZIP file

Business Central is the graphical user interface where you create and manage business rules that KIE Server executes. You can use a deployable ZIP file to install and configure Business Central.

Prerequisites
  • A backed-up Red Hat JBoss EAP installation version 7.4 is available. The base directory of the Red Hat JBoss EAP installation is referred to as EAP_HOME.

  • Sufficient user permissions to complete the installation are granted.

  • The following file is downloaded from the IBM Business Automation Manager Open Editions 8.0 downloads page :

    IBAMOE-8.0-BC7.zip IBAMOE-8.0-BC7.zip

Procedure
  1. Extract the IBAMOE-8.0-BC7.zip IBAMOE-8.0-BC7.zip file to a temporary directory. In the following examples this directory is called TEMP_DIR.

  2. Copy the contents of the TEMP_DIR/bamoe-8.0-BC7/jboss-eap-7.4 TEMP_DIR/bamoe-8.0-BC7/jboss-eap-7.4 directory to EAP_HOME. When prompted, merge or replace files.

    Warning
    Ensure that the names of the IBM Business Automation Manager Open Editions deployments that you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.

Installing KIE Server from the ZIP file

KIE Server provides the runtime environment for business assets and accesses the data stored in the assets repository (knowledge store). You can use a deployable ZIP file to install and configure KIE Server.

Prerequisites
  • A backed-up Red Hat JBoss EAP installation version 7.4 is available. The base directory of the Red Hat JBoss EAP installation is referred to as EAP_HOME.

  • Sufficient user permissions to complete the installation are granted.

  • The following file is downloaded from the IBM Business Automation Manager Open Editions 8.0 downloads page : IBAMOE-8.0-KS8.Zip IBAMOE-8.0-KS8.Zip

Procedure
  1. Extract the IBAMOE-8.0-KS8.Zip IBAMOE-8.0-KS8.Zip archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

  2. Copy the TEMP_DIR/IBAMOE-8.0-KS8/kie-server.war TEMP_DIR/IBAMOE-8.0-KS8/kie-server.war directory to EAP_HOME/standalone/deployments/.

    Warning
    Ensure the names of the IBM Business Automation Manager Open Editions 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/IBAMOE-8.0-KS8/IBAMOE-8.0-KS8/SecurityPolicy/ TEMP_DIR/IBAMOE-8.0-KS8/IBAMOE-8.0-KS8/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.

Note

If you use Microsoft SQL Server, make sure you have configured applicable transaction isolation for your database. If you do not, you may experience deadlocks. The recommended configuration is to turn on ALLOW_SNAPSHOT_ISOLATION and READ_COMMITTED_SNAPSHOT by entering the following statements:

ALTER DATABASE <DBNAME> SET ALLOW_SNAPSHOT_ISOLATION ON
ALTER DATABASE <DBNAME> SET READ_COMMITTED_SNAPSHOT ON

Configuring JDBC data sources for KIE Server

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.

Typically, solutions using IBM Business Automation Manager Open Editions manage several resources within a single transaction. JMS for asynchronous jobs, events, and timers, for example. IBM Business Automation Manager Open Editions requires an XA driver in the datasource when possible to ensure data atomicity and consistent results. If transactional code for different schemas exists inside listeners or derives from hooks provided by the jBPM engine, an XA driver is also required.

Do not use non-XA datasources unless you are positive you do not have multiple resources participating in single transactions.

Note

For production environments, specify an actual data source. Do not use the example data source in production environments.

Prerequisites
Procedure
  1. Complete the following steps to prepare your database:

    1. Extract IBAMOE-8.0-AO.zip in a temporary directory, for example TEMP_DIR.

    2. Extract TEMP_DIR/bamoe-8.0-migration-tool.zip.

    3. Change your current directory to the TEMP_DIR/bamoe-8.0.2-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 IBM Business Automation Manager Open Editions org.kie.persistence.postgresql.useText=true and org.kie.persistence.postgresql.useBytea=true flags. Do not use the postgresql-jbpm-lo-trigger-clob.sql script when creating a BYTEA-based schema. IBM Business Automation Manager Open Editions 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="bamoeUser"/>
        <property name="org.kie.server.pwd" value="bamoe123!"/>
        <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>

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

  • Sybase: org.hibernate.dialect.SybaseASE157Dialect

Creating users

If you used the deployable ZIP files to install IBM Business Automation Manager Open Editions, before you can log in to Business Central or KIE Server, you must create users. This section shows you how to create a Business Central user with the admin, rest-all, and kie-server roles and a KIE Server user that has the kie-server role. For information about roles, see IBM Business Automation Manager Open Editions roles and users.

Note

IBM Business Automation Manager Open Editions stores user data as a set of properties or as a set of files. File-based storage provides several extra features, such as SSH login and a user maintenance UI.

The user script examples in this documentation use the file-based user script, jboss-cli.sh, instead of the property-based user script, add-users.sh.

Prerequisites
  • IBM Business Automation Manager Open Editions is installed in the base directory of the Red Hat JBoss EAP installation (EAP_HOME).

Note

When installing IBM Business Automation Manager Open Editions 8.0, user data is now stored only in files rather than properties.

You can only create users using the file-based user script jboss-cli.sh and the procedure to change from using property based user storage is mandatory if you were previously using that method.

Procedure
  1. To change IBM Business Automation Manager Open Editions 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 an IBM Business Automation Manager Open Editions 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.
  4. 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:

    $ ./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])"
$ ./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).

  1. 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])"
$ ./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])"
  1. Make a note of your user names and passwords.

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

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

Configuring KIE Server to connect to Business Central

Warning
This section provides a sample setup that you can use for testing purposes. Some of the values are unsuitable for a production environment, and are marked as such.

If a KIE Server is not configured in your IBM Business Automation Manager Open Editions environment, or if you require additional KIE Servers in your IBM Business Automation Manager Open Editions environment, you must configure a KIE Server to connect to Business Central.

Note

If you are deploying KIE Server on Red Hat OpenShift Container Platform, see the Deploying an IBM Business Automation Manager Open Editions environment on Red Hat OpenShift Container Platform 4 using Operators document for instructions about configuring it to connect to Business Central.

Prerequisites
Procedure
  1. In your IBM Business Automation Manager Open Editions installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for IBM Business Automation Manager Open Editions, 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 1. JVM Properties for the managed 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 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 IBM Business Automation Manager Open Editions on KIE Server, see Running IBM Business Automation Manager Open Editions.

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

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

Thread efficiency

To ensure that the optimal number of threads are used, set the value of the threading system properties to the sum of the number of CPUs plus one.

  1. In your IBM Business Automation Manager Open Editions installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for IBM Business Automation Manager Open Editions, 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:

org.appformer.concurrent.managed.thread.limit
org.appformer.concurrent.unmanaged.thread.limit
org.appformer.concurrent.indexing.thread.limit
org.appformer.concurrent.rest.api.thread.limit
Note
The number of CPUs plus one is a valid baseline value for all properties. You might have to fine-tune further based on additional testing.

Securing passwords with a keystore

You can use a keystore to encrypt passwords that are used for communication between Business Central and KIE Server. You should encrypt both controller and KIE Server passwords. If Business Central and KIE Server are deployed to different application servers, then both application servers should use the keystore.

Use Java Cryptography Extension KeyStore (JCEKS) for your keystore because it supports symmetric keys. Use KeyTool, which is part of the JDK installation, to create a new JCEKS.

Note

If KIE Server is not configured with JCEKS, KIE Server passwords are stored in system properties in plain text form.

Prerequisites
  • KIE Server is installed in Red Hat JBoss EAP.

  • Java 8 or higher is installed.

Procedure
  1. In the Red Hat JBoss EAP home directory, enter the following command to create a KIE Server user with the kie-server role and specify a password. In the following example, replace <USERNAME> and <PASSWORD> with the user name and password of your choice.

    $<EAP_HOME>./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'])"
  2. To use KeyTool to create a JCEKS, enter the following command in the Java 8 home directory:

    $<JAVA_HOME>/bin/keytool -importpassword -keystore <KEYSTORE_PATH> -keypass <ALIAS_KEY_PASSWORD> -alias <PASSWORD_ALIAS> -storepass <KEYSTORE_PASSWORD> -storetype JCEKS

    In this example, replace the following variables:

    • <KEYSTORE_PATH>: The path where the keystore will be stored

    • <KEYSTORE_PASSWORD>: The keystore password

    • <ALIAS_KEY_PASSWORD>: The password used to access values stored with the alias

    • <PASSWORD_ALIAS>: The alias of the entry to the process

  3. When prompted, enter the password for the KIE Server user that you created.

  4. Set the following system properties in the EAP_HOME/standalone/configuration/standalone-full.xml file and replace the placeholders as listed in the following table:

        <system-properties>
            <property name="kie.keystore.keyStoreURL" value="<KEYSTORE_URL>"/>
            <property name="kie.keystore.keyStorePwd" value="<KEYSTORE_PWD>"/>
            <property name="kie.keystore.key.server.alias" value="<KEY_SERVER_ALIAS>"/>
            <property name="kie.keystore.key.server.pwd" value="<KEY_SERVER_PWD>"/>
            <property name="kie.keystore.key.ctrl.alias" value="<KEY_CONTROL_ALIAS>"/>
            <property name="kie.keystore.key.ctrl.pwd" value="<KEY_CONTROL_PWD>"/>
        </system-properties>
    Table 3. System properties used to load a KIE Server JCEKS
    System property Placeholder Description

    kie.keystore.keyStoreURL

    <KEYSTORE_URL>

    URL for the JCEKS that you want to use, for example file:///home/kie/keystores/keystore.jceks

    kie.keystore.keyStorePwd

    <KEYSTORE_PWD>

    Password for the JCEKS

    kie.keystore.key.server.alias

    <KEY_SERVER_ALIAS>

    Alias of the key for REST services where the password is stored

    kie.keystore.key.server.pwd

    <KEY_SERVER_PWD>

    Password of the alias for REST services with the stored password

    kie.keystore.key.ctrl.alias

    <KEY_CONTROL_ALIAS>

    Alias of the key for default REST Process Automation Controller where the password is stored

    kie.keystore.key.ctrl.pwd

    <KEY_CONTROL_PWD>

    Password of the alias for default REST Process Automation Controller with the stored password

  5. Start KIE Server to verify the configuration.

Configuring SSH to use RSA

SSH is used to clone Git repositories. By default, the DSA encryption algorithm is provided by Business Central. However, some SSH clients, for example SSH clients in the Fedora 23 environment, use the RSA algorithm instead of the DSA algorithm. Business Central contains a system property that you can use to switch from DSA to RSA if required.

Note

SSH clients on supported configurations, for example Red Hat Enterprise Linux 7, are not affected by this issue. For a list of supported configurations, see IBM Business Automation Manager Open Editions 8 Supported Configurations. Red Hat Decision Manager 7 Supported Configurations.

Procedure

Complete one of the following tasks to enable this system property:

  • Modify the ~/.ssh/config file on the client side as follows to force the SSH client to accept the deprecated DSA algorithm:

    Host <SERVER_IP>
           HostKeyAlgorithms +ssh-dss
  • Include the -Dorg.uberfire.nio.git.ssh.algorithm=RSA parameter when you start Business Central, for example:

    $ ./standalone.sh -c standalone-full.xml
    -Dorg.uberfire.nio.git.ssh.algorithm=RSA

Verifying the IBM Business Automation Manager Open Editions installation

After you have installed IBM Business Automation Manager Open Editions, create an asset to verify that the installation is working.

Procedure
  1. In a terminal window, navigate to the EAP_HOME/bin directory and enter the following command to start IBM Business Automation Manager Open Editions:

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

    If you deployed Business Central without KIE Server, you can start Business Central with the standalone.sh script without specifying the standalone-full.xml file. In this case, ensure that you make any configuration changes to the standalone.xml file before starting Business Central.

  2. In a web browser, enter localhost:8080/business-central.

    • If you configured IBM Business Automation Manager Open Editions to run from a domain name, replace localhost with the domain name, for example:

      http://www.example.com:8080/business-central http://www.example.com:8080/business-central

    • If you configured IBM Business Automation Manager Open Editions to run in a cluster, replace localhost with the IP address of a particular node, for example:

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

  3. Enter the admin user credentials that you created during installation. The Business Central home page appears.

  4. Select MenuDeployExecution Servers.

  5. Confirm that default-kieserver is listed under Server Configurations.

  6. Select MenuDesignProjects.

  7. Open the MySpace space.

  8. Click Try SamplesMortgagesOK. The Assets window appears.

  9. Click Add AssetData Object.

  10. Enter MyDataObject in the Data Object field and click OK.

  11. Click SpacesMySpaceMortgages and confirm that MyDataObject is in the list of assets.

  12. Delete the Mortgages project.

Running IBM Business Automation Manager Open Editions

Use this procedure to run the IBM Business Automation Manager Open Editions on Red Hat JBoss EAP in standalone mode.

Prerequisites
  • IBM Business Automation Manager Open Editions is installed and configured.

Note
If you changed the default host (localhost) or the default port (9990), then before you run IBM Business Automation Manager Open Editions, you must edit the business-central.war/WEB-INF/classes/datasource-management.properties and business-central.war/WEB-INF/classes/security-management.properties files as described in Solution 3519551.
Procedure
  1. In a terminal application, navigate to EAP_HOME/bin.

  2. Run the standalone configuration:

    • On Linux or UNIX-based systems:

      $ ./standalone.sh -c standalone-full.xml
    • On Windows:

      standalone.bat -c standalone-full.xml
      Note

      If you deployed Business Central without KIE Server, you can start Business Central with the standalone.sh script without specifying the standalone-full.xml file. In this case, ensure that you make any configuration changes to the standalone.xml file before starting Business Central.

      On Linux or UNIX-based systems:

      $ ./standalone.sh

      On Windows:

      standalone.bat
  3. In a web browser, open the URL localhost:8080/business-central.

    If you configured IBM Business Automation Manager Open Editions to run from a domain name, replace localhost with the domain name, for example:

    http://www.example.com:8080/business-central http://www.example.com:8080/business-central

  4. Log in using the credentials of the user that you created for Business Central in Creating users.

Installing and running the headless IBM Business Automation Manager controller

You can configure KIE Server to run in managed or unmanaged mode. If KIE Server is unmanaged, you must manually create and maintain KIE containers (deployment units). If KIE Server is managed, the IBM Business Automation Manager controller manages the KIE Server configuration and you interact with the IBM Business Automation Manager controller to create and maintain KIE containers.

Business Central has an embedded IBM Business Automation Manager controller. If you install Business Central, use the Execution Server page to create and maintain KIE containers. If you want to automate KIE Server management without Business Central, you can use the headless IBM Business Automation Manager controller.

Installing the headless IBM Business Automation Manager controller

You can install the headless IBM Business Automation Manager controller and use the REST API or the KIE Server Java Client API to interact with it.

Prerequisites
  • A backed-up Red Hat JBoss EAP installation version 7.4 is available. The base directory of the Red Hat JBoss EAP installation is referred to as EAP_HOME.

  • Sufficient user permissions to complete the installation are granted.

Procedure
  1. Navigate to the IBM Business Automation Manager Open Editions 8.0 downloads page and follow the instructions to download IBM Business Automation Manager Open Editions 8.0 - Add-ons.

  2. Extract the IBAMOE-8.0-AO.zip file. The bamoe-8.0.2-controller-ee7.zip file is in the extracted directory.

  3. Extract the bamoe-8.0.2-controller-ee7.zip archive to a temporary directory. In the following examples this directory is called TEMP_DIR.

  4. Copy the TEMP_DIR/bamoe-8.0.2-controller-ee7/controller.war directory to EAP_HOME/standalone/deployments/.

    Warning
    Ensure that the names of the headless IBM Business Automation Manager controller deployments you copy do not conflict with your existing deployments in the Red Hat JBoss EAP instance.
  5. Copy the contents of the TEMP_DIR/bamoe-8.0.2-controller-ee7/SecurityPolicy/ directory to EAP_HOME/bin.

  6. When prompted 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 IBM Business Automation Manager controller is automatically deployed when the server starts.

Creating a headless IBM Business Automation Manager controller user

Before you can use the headless IBM Business Automation Manager controller, you must create a user that has the kie-server role.

Prerequisites
  • The headless IBM Business Automation Manager controller is installed in the base directory of the Red Hat JBoss EAP installation (EAP_HOME).

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

  2. Enter the following command and 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=['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'])"

+

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 your user name and password.

Configuring KIE Server and the headless IBM Business Automation Manager controller

If KIE Server will be managed by the headless IBM Business Automation Manager controller, you must edit the standalone-full.xml file in KIE Server installation and the standalone.xml file in the headless IBM Business Automation Manager controller installation.

Prerequisites
  • KIE Server is installed in an EAP_HOME.

  • The headless IBM Business Automation Manager controller is installed in an EAP_HOME.

    Note

    You should install KIE Server and the headless IBM Business Automation Manager controller on different servers in production environments. However, if you install KIE Server and the headless IBM Business Automation Manager controller on the same server, for example in a development environment, make these changes in the shared standalone-full.xml file.

  • On KIE Server nodes, a user with the kie-server role exists.

  • On the server nodes, a user with the kie-server role exists.

    For more information, see Creating users.

Procedure
  1. In the EAP_HOME/standalone/configuration/standalone-full.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 KIE Server EAP_HOME/standalone/configuration/standalone-full.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 KIE Server installation, for example, bamoe-8.0.2-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 the headless IBM Business Automation Manager controller. KIE Server connects to this URL during startup.

Running the headless IBM Business Automation Manager controller

After you have installed the headless IBM Business Automation Manager controller on Red Hat JBoss EAP, use this procedure to run the headless IBM Business Automation Manager controller.

Prerequisites
  • The headless IBM Business Automation Manager controller is installed and configured in the base directory of the Red Hat JBoss EAP installation (EAP_HOME).

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

  2. If you installed the headless IBM Business Automation Manager controller on the same Red Hat JBoss EAP instance as the Red Hat JBoss EAP instance where you installed 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 IBM Business Automation Manager controller on a separate Red Hat JBoss EAP instance from the Red Hat JBoss EAP instance where you installed KIE Server, start the headless IBM Business 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 IBM Business 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 Creating a headless IBM Business 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>'
Note

Alternatively, you can use the KIE Server Java API Client to access the headless IBM Business Automation Manager controller.

Configuring and running standalone Business Central

You can use the Business Central standalone JAR file to run Business Central without deploying it to an application server. You can use sample configuration files to run the Business Central standalone JAR file out of the box or you can customize the sampfiles for your requirements.

Note

This JAR file is supported only when it is run on Red Hat Enterprise Linux.

Prerequisites
  • The IBM Business Automation Manager Open Editions 8.0 - Business Central Standalone (IBAMOE-8.0-BCS.Jar) and the IBM Business Automation Manager Open Editions 8.0 - Add-ons (IBAMOE-8.0-AO.zip) files have been downloaded from the IBM Business Automation Manager Open Editions 8.0 downloads page.

Procedure
  1. Extract the downloaded bamoe-8.0.4-AO.zip to a temporary directory. This archive includes the bamoe-8.0.4-standalone-sample-configuration.zip file.

  2. Extract the bamoe-8.0.4-standalone-sample-configuration.zip file to the directory that contains the IBAMOE-8.0-BCS.Jar file. The bamoe-8.0.4-standalone-sample-configuration.zip file contains the following sample configuration files:

    • application-script.cli: Sample script for adding a user and kie server system properties

    • kie-fs-realm-users: Sample user data

      You can run the IBAMOE-8.0-BCS.Jar files with the sample data provided in the configuration files or you can customize the data for your requirements.

  3. To customize the configuration data, complete the following steps:

    1. Edit the application-script.cli file to include an administrative user with admin, user, rest-all, rest-client and kie-server roles. In the following example, replace <USERNAME> and <PASSWORD> with your username and password of the user you want to create.

      /subsystem=elytron/filesystem-realm=KieRealm:add-identity(identity=<USERNAME>)
      /subsystem=elytron/filesystem-realm=KieRealm:set-password(identity=<USERNAME>, clear={password="<PASSWORD>"})
      /subsystem=elytron/filesystem-realm=KieRealm:add-identity-attribute(identity=<USERNAME>, name=role, value=["admin","user","rest-all","rest-client","kie-server"])
  4. To run the Business Central standalone JAR file, enter the following command:

    java -jar IBAMOE-8.0-BCS.Jar --cli-script=application-script.cli
  5. To set application properties when you run the JAR file, include the -D<PROPERTY>=<VALUE> parameter in the command, where <PROPERTY> is the name of a supported application property and <VALUE> is the property value:

    java -jar IBAMOE-8.0-BCS.Jar --cli-script=application-script.cli -D<PROPERTY>=<VALUE> -D<PROPERTY>=<VALUE>

    For example, to run Business Central and connect to KIE Server as the user controllerUser, enter:

    java -jar IBAMOE-8.0-BCS.Jar \
     --cli-script=application-script.cli \
    -Dorg.kie.server.user=controllerUser \
    -Dorg.kie.server.pwd=controllerUser1234

    Doing this enables you to deploy containers to KIE Server. See Business Central system properties for more information.

    Note

    To enable user and group management in Business Central, set the value of the org.uberfire.ext.security.management.wildfly.cli.folderPath property to kie-fs-realm-users.

Maven settings and repositories for IBM Business Automation Manager Open Editions

When you create an IBM Business Automation Manager Open Editions project, Business Central uses the Maven repositories that are configured for Business Central. You can use the Maven global or user settings to direct all IBM Business Automation Manager Open Editions projects to retrieve dependencies from the public IBM Business Automation Manager Open Editions repository by modifying the Maven project object model (POM) file (pom.xml). You can also configure Business Central and KIE Server to use an external Maven repository or prepare a Maven mirror for offline use.

For more information about IBM Business Automation Manager Open Editions packaging and deployment options, see Packaging and deploying an IBM Business Automation Manager Open Editions project.

Adding Maven dependencies for IBM Business Automation Manager Open Editions

To use the correct Maven dependencies in your IBM Business Automation Manager Open Editions project, add the IBM Business Automation Manager Open Editions bill of materials (BOM) files to the project’s pom.xml file. When you add the BOM files, the correct versions of transitive dependencies from the provided Maven repositories are included in the project.

Procedure
  1. Declare the IBM Business Automation Manager Open Editions BOM in the pom.xml file:

    <dependencyManagement>
     <dependencies>
      <dependency>
       <groupId>com.redhat.ba</groupId>
       <artifactId>ba-platform-bom</artifactId>
       <version>8.0.4.redhat-00001</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 IBM Business Automation Manager Open Editions 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 an IBM Business Automation Manager Open Editions 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 IBM Business Automation Manager Open Editions 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 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 IBM Business Automation Manager Open Editions, 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.

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

Configuring an external Maven repository for Business Central and KIE Server

You can configure Business Central and KIE Server to use an external Maven repository, such as Nexus or Artifactory, instead of the built-in repository. This enables Business Central and KIE Server to access and download artifacts that are maintained in the external Maven repository.

Important

Artifacts in the repository do not receive automated security patches because Maven requires that artifacts be immutable. As a result, artifacts that are missing patches for known security flaws will remain in the repository to avoid breaking builds that depend on them. The version numbers of patched artifacts are incremented. For more information, see JBoss Enterprise Maven Repository.

Note

For information about configuring an external Maven repository for an authoring environment on Red Hat OpenShift Container Platform, see the following document:

Prerequisites
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 IBM Business Automation Manager Open Editions installation directory, navigate to the standalone-full.xml file. For example, if you use a Red Hat JBoss EAP installation for IBM Business Automation Manager Open Editions, 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.

Next steps

For each Business Central project that you want to export or push as a KJAR artifact to the external Maven repository, you must add the repository information in the project pom.xml file. For instructions, see Packaging and deploying an IBM Business Automation Manager Open Editions project.

Preparing a Maven mirror repository for offline use

If your IBM Business Automation Manager Open Editions deployment does not have outgoing access to the public Internet, you must prepare a Maven repository with a mirror of all the necessary artifacts and make this repository available to your environment.

Note

You do not need to complete this procedure if your IBM Business Automation Manager Open Editions deployment is connected to the Internet.

Prerequisites
  • A computer that has outgoing access to the public Internet is available.

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

  2. Navigate to the IBM Business Automation Manager Open Editions 8.0 downloads page and follow the instructions to download the Business Automation Manager Open Editions 8.0 - Offline Repository Builder product deliverable file.

  3. Extract the contents of the Business Automation Manager Open Editions 8.0 - Offline Repository Builder product deliverable file into any directory.

  4. 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 IBM support.

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

  6. Copy the contents of the repository subdirectory to a directory on the computer on which you deployed IBM Business Automation Manager Open Editions. This directory becomes the offline Maven mirror repository.

  7. Create and configure a settings.xml file for your IBM Business Automation Manager Open Editions deployment as described in Configuring an external Maven repository for Business Central and KIE Server.

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

  9. Set the kie.maven.offline.force property for Business Central to true. For instructions about setting properties for Business Central, see Installing and configuring IBM Business Automation Manager Open Editions on Red Hat JBoss EAP 7.4.

Importing projects from Git repositories

Git is a distributed version control system. It implements revisions as commit objects. When you save your changes to a repository, a new commit object in the Git repository is created.

Business Central uses Git to store project data, including assets such as rules and processes. When you create a project in Business Central, it is added to a Git repository that is embedded in Business Central. If you have projects in other Git repositories, you can import those projects into the Business Central Git repository through Business Central spaces.

Prerequisites
  • IBM Business Automation Manager Open Editions projects exist in an external Git repository.

  • You have the credentials required for read access to that external Git repository.

Procedure
  1. In Business Central, click MenuDesignProjects.

  2. Select or create the space into which you want to import the projects. The default space is MySpace.

  3. To import a project, do one of the following:

    • Click Import Project.

    • Select Import Project from the drop-down list.

  4. In the Import Project window, enter the URL and credentials for the Git repository that contains the projects that you want to import and click Import. The projects are added to the Business Central Git repository and are available from the current space.

Customizing the branding of Business Central

You can customize the branding of the Business Central login page and application header by replacing the images with your own.

Customizing the Business Central login page

You can customize the company logo and the project logo on the Business Central login page.

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 IBM Business Automation Manager Open Editions 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.

Customizing Business Central application header

You can customize the Business Central application header.

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 IBM Business Automation Manager Open Editions 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.

Integrating LDAP and SSL

With IBM Business Automation Manager Open Editions you can integrate LDAP and SSL through Red Hat Single Sign-On. For more information, see the Red Hat Single Sign-On Server Administration Guide.

Appendix A: Business Central system properties

The Business Central system properties listed in this section are passed to standalone*.xml files.

Git directory

Use the following properties to set the location and name for the Business Central Git directory:

  • org.uberfire.nio.git.dir: Location of the Business Central Git directory.

  • org.uberfire.nio.git.dirname: Name of the Business Central Git directory. Default value: .niogit.

  • org.uberfire.nio.git.ketch: Enables or disables Git ketch.

  • org.uberfire.nio.git.hooks: Location of the Git hooks directory.

Git over HTTP

Use the following properties to configure access to the Git repository over HTTP:

  • org.uberfire.nio.git.proxy.ssh.over.http: Specifies whether SSH should use an HTTP proxy. Default value: false.

  • http.proxyHost: Defines the host name of the HTTP proxy. Default value: null.

  • http.proxyPort: Defines the host port (integer value) of the HTTP proxy. Default value: null.

  • http.proxyUser: Defines the user name of the HTTP proxy.

  • http.proxyPassword: Defines the user password of the HTTP proxy.

  • org.uberfire.nio.git.http.enabled: Enables or disables the HTTP daemon. Default value: true.

  • org.uberfire.nio.git.http.host: If the HTTP daemon is enabled, it uses this property as the host identifier. This is an informative property that is used to display how to access the Git repository over HTTP. The HTTP still relies on the servlet container. Default value: localhost.

  • org.uberfire.nio.git.http.hostname: If the HTTP daemon is enabled, it uses this property as the host name identifier. This is an informative property that is used to display how to access the Git repository over HTTP. The HTTP still relies on the servlet container. Default value: localhost.

  • org.uberfire.nio.git.http.port: If the HTTP daemon is enabled, it uses this property as the port number. This is an informative property that is used to display how to access the Git repository over HTTP. The HTTP still relies on the servlet container. Default value: 8080.

Git over HTTPS

Use the following properties to configure access to the Git repository over HTTPS:

  • org.uberfire.nio.git.proxy.ssh.over.https: Specifies whether SSH uses an HTTPS proxy. Default value: false.

  • https.proxyHost: Defines the host name of the HTTPS proxy. Default value: null.

  • https.proxyPort: Defines the host port (integer value) of the HTTPS proxy. Default value: null.

  • https.proxyUser: Defines the user name of the HTTPS proxy.

  • https.proxyPassword: Defines the user password of the HTTPS proxy.

  • user.dir: Location of the user directory.

  • org.uberfire.nio.git.https.enabled: Enables or disables the HTTPS daemon. Default value: false

  • org.uberfire.nio.git.https.host: If the HTTPS daemon is enabled, it uses this property as the host identifier. This is an informative property that is used to display how to access the Git repository over HTTPS. The HTTPS still relies on the servlet container. Default value: localhost.

  • org.uberfire.nio.git.https.hostname: If the HTTPS daemon is enabled, it uses this property as the host name identifier. This is an informative property that is used to display how to access the Git repository over HTTPS. The HTTPS still relies on the servlet container. Default value: localhost.

  • org.uberfire.nio.git.https.port: If the HTTPS daemon is enabled, it uses this property as the port number. This is an informative property that is used to display how to access the Git repository over HTTPS. The HTTPS still relies on the servlet container. Default value: 8080.

JGit
  • org.uberfire.nio.jgit.cache.instances: Defines the JGit cache size.

  • org.uberfire.nio.jgit.cache.overflow.cleanup.size: Defines the JGit cache overflow cleanup size.

  • org.uberfire.nio.jgit.remove.eldest.iterations: Enables or disables whether to remove eldest JGit iterations.

  • org.uberfire.nio.jgit.cache.evict.threshold.duration: Defines the JGit evict threshold duration.

  • org.uberfire.nio.jgit.cache.evict.threshold.time.unit: Defines the JGit evict threshold time unit.

Git daemon

Use the following properties to enable and configure the Git daemon:

  • org.uberfire.nio.git.daemon.enabled: Enables or disables the Git daemon. Default value: true.

  • org.uberfire.nio.git.daemon.host: If the Git daemon is enabled, it uses this property as the local host identifier. Default value: localhost.

  • org.uberfire.nio.git.daemon.hostname: If the Git daemon is enabled, it uses this property as the local host name identifier. Default value: localhost

  • org.uberfire.nio.git.daemon.port: If the Git daemon is enabled, it uses this property as the port number. Default value: 9418.

  • org.uberfire.nio.git.http.sslVerify: Enables or disables SSL certificate checking for Git repositories. Default value: true.

    Note
    If the default or assigned port is already in use, a new port is automatically selected. Ensure that the ports are available and check the log for more information.
Git SSH

Use the following properties to enable and configure the Git SSH daemon:

  • org.uberfire.nio.git.ssh.enabled: Enables or disables the SSH daemon. Default value: true.

  • org.uberfire.nio.git.ssh.host: If the SSH daemon enabled, it uses this property as the local host identifier. Default value: localhost.

  • org.uberfire.nio.git.ssh.hostname: If the SSH daemon is enabled, it uses this property as local host name identifier. Default value: localhost.

  • org.uberfire.nio.git.ssh.port: If the SSH daemon is enabled, it uses this property as the port number. Default value: 8001.

    Note
    If the default or assigned port is already in use, a new port is automatically selected. Ensure that the ports are available and check the log for more information.
  • org.uberfire.nio.git.ssh.cert.dir: Location of the .security directory where local certificates are stored. Default value: Working directory.

  • org.uberfire.nio.git.ssh.idle.timeout: Sets the SSH idle timeout.

  • org.uberfire.nio.git.ssh.passphrase: Pass phrase used 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 value: RSA.

  • org.uberfire.nio.git.gc.limit: Sets the GC limit.

  • org.uberfire.nio.git.ssh.ciphers: A comma-separated string of ciphers. The available ciphers are aes128-ctr, aes192-ctr, aes256-ctr, arcfour128, arcfour256, aes192-cbc, aes256-cbc. If the property is not used, all available ciphers are loaded.

  • org.uberfire.nio.git.ssh.macs: A comma-separated string of message authentication codes (MACs). The available MACs are hmac-md5, hmac-md5-96, hmac-sha1, hmac-sha1-96, hmac-sha2-256, hmac-sha2-512. If the property is not used, all available MACs are loaded.

    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.
KIE Server nodes and IBM Business Automation Manager controller

Use the following properties to configure the connections with the KIE Server nodes from the IBM Business Automation Manager controller:

  • org.kie.server.controller: The URL is used to connect to the IBM Business Automation Manager controller. For example, ws://localhost:8080/business-central/websocket/controller.

  • org.kie.server.user: User name used to connect to the KIE Server nodes from the IBM Business Automation Manager controller. This property is only required when using this Business Central installation as an IBM Business Automation Manager controller.

  • org.kie.server.pwd: Password used to connect to the KIE Server nodes from the IBM Business Automation Manager controller. This property is only required when using this Business Central installation as an IBM Business Automation Manager controller.

Maven and miscellaneous

Use the following properties to configure Maven and other miscellaneous functions:

  • kie.maven.offline.force: Forces Maven to behave as if offline. If true, disables online dependency resolution. Default value: false.

    Note
    Use this property for Business Central only. If you share a runtime environment with any other component, isolate the configuration and apply it only to Business Central.
  • org.uberfire.gzip.enable: Enables or disables Gzip compression on the GzipFilter compression filter. Default value: true.

  • org.kie.workbench.profile: Selects the Business Central profile. Possible values are FULL or PLANNER_AND_RULES. A prefix FULL_ sets the profile and hides the profile preferences from the administrator preferences. Default value: FULL

  • org.appformer.m2repo.url: Business Central uses the default location of the Maven repository when looking for dependencies. It directs to the Maven repository inside Business Central, for example, http://localhost:8080/business-central/maven2. Set this property before starting Business Central. Default value: File path to the inner m2 repository.

  • appformer.ssh.keystore: Defines the custom SSH keystore to be used with Business Central by specifying a class name. If the property is not available, the default SSH keystore is used.

  • appformer.ssh.keys.storage.folder: When using the default SSH keystore, this property defines the storage folder for the user’s SSH public keys. If the property is not available, the keys are stored in the Business Central .security folder.

  • appformer.experimental.features: Enables the experimental features framework. Default value: false.

  • org.kie.demo: Enables an external clone of a demo application from GitHub.

  • org.uberfire.metadata.index.dir: Place where the Lucene .index directory is stored. Default value: Working directory.

  • org.uberfire.ldap.regex.role_mapper: Regex pattern used to map LDAP principal names to the application role name. Note that the variable role must be a part of the pattern as the application role name substitutes the variable role when matching a principle value and role name.

  • org.uberfire.sys.repo.monitor.disabled: Disables the configuration monitor. Do not disable unless you are sure. Default value: false.

  • org.uberfire.secure.key: Password used by password encryption. Default value: org.uberfire.admin.

  • org.uberfire.secure.alg: Crypto algorithm used by password encryption. Default value: PBEWithMD5AndDES.

  • org.uberfire.domain: Security-domain name used by uberfire. Default value: ApplicationRealm.

  • org.guvnor.m2repo.dir: Place where the Maven repository folder is stored. Default value: <working-directory>/repositories/kie.

  • org.guvnor.project.gav.check.disabled: Disables group ID, artifact ID, and version (GAV) checks. Default value: false.

  • org.kie.build.disable-project-explorer: Disables automatic build of a selected project in Project Explorer. Default value: false.

  • org.kie.builder.cache.size: Defines the cache size of the project builder. Default value: 20.

  • org.kie.library.assets_per_page: You can customize the number of assets per page in the project screen. Default value: 15.

  • org.kie.verification.disable-dtable-realtime-verification: Disables the real-time validation and verification of decision tables. Default value: false.

IBM Business Automation Manager controller

Use the following properties to configure how to connect to the IBM Business Automation Manager controller:

  • org.kie.workbench.controller: The URL used to connect to the IBM Business Automation Manager controller, for example, ws://localhost:8080/kie-server-controller/websocket/controller.

  • org.kie.workbench.controller.user: The IBM Business Automation Manager controller user. Default value: kieserver.

  • org.kie.workbench.controller.pwd: The IBM Business Automation Manager controller password. Default value: kieserver1!.

  • org.kie.workbench.controller.token: The token string used to connect to the IBM Business Automation Manager controller.

Java Cryptography Extension KeyStore (JCEKS)

Use the following properties to configure JCEKS:

  • kie.keystore.keyStoreURL: The URL used to load a Java Cryptography Extension KeyStore (JCEKS). For example, file:///home/kie/keystores/keystore.jceks.

  • kie.keystore.keyStorePwd: The password used for the JCEKS.

  • kie.keystore.key.ctrl.alias: The alias of the key for the default REST IBM Business Automation Manager controller.

  • kie.keystore.key.ctrl.pwd: The password of the alias for the default REST IBM Business Automation Manager controller.

Rendering

Use the following properties to switch between Business Central and KIE Server rendered forms:

  • org.jbpm.wb.forms.renderer.ext: Switches the form rendering between Business Central and KIE Server. By default, the form rendering is performed by Business Central. Default value: false.

  • org.jbpm.wb.forms.renderer.name: Enables you to switch between Business Central and KIE Server rendered forms. Default value: workbench.

Additional resources

Next steps