Show Table of Contents
Chapter 2. Installation options
Red Hat JBoss BPM Suite comes in two versions:
- Executable jar installer for installation on Red Hat JBoss Enterprise Application Platform (EAP) 6.1.1.
- Zip file install which itself comes in two versions:
jboss-bpms-6.MINOR_VERSION-redhat-x-deployable-eap6.x.zip: version adapted for deployment on Red Hat JBoss Enterprise Application Platform (EAP 6.1.1).jboss-bpms-6.MINOR_VERSION-redhat-x-deployable-generic.zip: the deployable version with additional libraries adapted for deployment on Red Hat JBoss Web Server (WS), Apache Tomcat 6, and Apache Tomcat 7.
Depending on your environment, you may choose the installation option best suited for your project needs.
Note
Red Hat JBoss BPM Suite 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 following system property
"-Dfile.encoding=UTF-8".
2.1. The Red Hat JBoss BPM Suite Installer installation
This section describes the steps required to install Red Hat JBoss BPM Suite using the jar file installer installation method. The jar file is an executable file that installs EAP6 if you do not already have it, or you can use it to install BPMS on an existing EAP6 installation.
Note
Due to IBM JDK not being able to use keystores generated on other JDKs, it is not possible to install JBoss BPM Suite into an existing JBoss EAP running on IBM JDK with a keystore generated on another JDK.
2.1.1. Downloading Red Hat JBoss BPM Suite Installer
- Go to the Red Hat Customer Portal and log in.
- Click → .
- In the Product Downloads page that opens, click Red Hat JBoss BPM Suite.
- From the Version drop-down menu, select version 6.0.3.
- Select Red Hat JBoss BPM Suite 6.0.3 Installer for EAP 6.1.1 and then click Download.
2.1.2. Installing Red Hat JBoss BPM Suite using the Installer
The installer for Red Hat JBoss BPM Suite is an executable Java jar file. You can use it to install BPMS on an existing EAP 6.1.1 installation or a brand new one. The installer gives you the option to install EAP 6.1.1 if you do not already have it.
Note
For security reasons, you should run the installer as a
non-root user.
Setup Location and Users
Navigate to the folder where you downloaded the installer file in a command prompt and execute the following command (replace the VERSION number and x with the actual file name).java -jar jboss-bpms-installer-VERSION.GA-redhat-x.jarNote
When running the installer on Windows, you may be prompted to provide administrator credentials during the installation. To prevent this, add theizpack.mode=privilegedoption to the installation command:java -Dizpack.mode=privileged -jar jboss-bpms-installer-VERSION.GA-redhat-x.jar- The graphical installer will execute and display a splash screen and a license agreement page. Accept the license to proceed.
- In the next screen, provide the parent location of an existing EAP where BPMS needs to be installed. If you instead prefer to install BPMS in a brand new EAP, then point this location to a parent directory where there is no existing EAP. BPMS will then be installed on top of a fresh EAP server bundled with the installer. The screenshot below depicts an example directory path:

Figure 2.1. BPM Suite Installer Directory Path
- In the next two screens, create two users: the first one for the management console of the EAP (ManagementRealm) and the second one for managing BPMS itself (ApplicationRealm). Make a note of these usernames and passwords as you will need them to access the EAP server and the BPMS application respectively.
Note
The passwords that you create must have at least 8 characters and must contain atleast one number and one alphanumeric character.Depicted below is a screenshot of the username and password page:
Figure 2.2. BPM Suite Installer Username and Password Screen
Note
The application role assigned to the second user that you create is the admin role. This is the only role that can be assigned to this newly created user. You can create more users with narrow roles afterwards by using the command line. Setup Security Environment
Next, you will setup the security environment of your new BPMS install. Decide to enable or disable the Java Security Manager in this step by clicking on the checkbox. The Java Security Manager makes your system more secure but may downgrade performance. You need to make a decision based on your environment.- Next, configure the passwords for the SSL Keystores for both server and client side for JMS messages. This is to make sure that the messages sent to BPMS via JMS can be encrypted as it may contain sensitive information.

Final Configuration Steps
Choose whether you want to setup pure IPv6 configuration on the server that the installation is taking place. This will allow you to setup runtime IPv6 specific configurations later.- Choose default configuration for the runtime environment in the next step and click next to review the installation details. If you are happy with the details, click next to start the actual installation or click previous to go back and make changes.
- The installer will go through the steps to install BPMS and will perform post installation configuration steps when you click next. The installer will also start the BPMS server and connect to it to validate the installation. Click next to get to the last screen where you can generate the installation script and properties file. Click done to quit the installer.
You have successfully installed Red Hat JBoss BPM Suite using the installer.
2.1.3. Installing Red Hat JBoss BPM Suite using the Installer in CLI Mode
The installer for Red Hat JBoss BPMS can also be executed through the command-line interface (CLI). The procedure below demonstrates the steps that you are likely to encounter using this option to install BPMS.
- Navigate to the folder where you downloaded the installer file in a command prompt and execute the following command (replace the VERSION number and x with the actual file name).
java -jar jboss-bpms-installer-VERSION.GA-redhat-x.jar -console
- The command-line interactive process will start and display the End-User license agreement. You will be prompted to select an option at the end of this license:
press 1 to continue, 2 to quit, 3 to redisplay.
- Enter 1 to begin the installation and type in the parent directory of an existing EAP installation. If you specify a directory where EAP does not exist, the installer will install a new version of EAP for you.
If you wish to install on an existing EAP installation, the parent directory of that EAP installation should be specified. [/home/user]
If you decide to create a new folder for the installation to take place, you will be prompted to select the following:press 1 to continue, 2 to quit, 3 to redisplay.
- Create a user for the management console of EAP (Management Realm):
Create an administrative user This user will be added to the host container's management realm for administrative purposes. It can be used to access the management console, the management CLI or other applications secured in this realm. Admin username: [admin]
- Create and confirm a password for the user of the EAP management console:
The password must have at least 8 characters, and contain at least one number and one non-alphanumeric symbol. Admin password: [] Confirm admin password: [******************************]
- After the passwords have been entered, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- Enter 1 then create a BPMS user:
Create a Business Process Management Suite User Create a BPM Suite user. The user will be added to the ApplicationRealm, and can be used to access the Business Central Console. The User will be assigned the 'admin' application roles. The BPMS username cannot be any of the following: 'admin', 'analyst', 'user', 'manager' or 'developer'. BPMS username: [bpmsAdmin]
- Create and confirm a password for the BPMS user:
The password must have at least 8 characters, and contain at least one number and one non-alphanumeric symbol. BPMS password: [] Confirm BPMS password: [****************]
- After the passwords have been entered, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- Configure the Java Security Manager by either pressing 1 to select it or 0 to deselect it.
Configure the Java Security Manager A Java security manager offers JVM level security beyond what is provided by the application container. It enforces access rules at the JVM runtime based on one or more security policies. This installer will place two security policies in the installation directory with the filenames 'security.policy' and 'kie.policy' regardless of choice. Those policies will be enabled at runtime if the option below is selected. Please note that a security manager imposes a significant performance overhead when enabled. It is suggested the included policies be applied in production if user requirements call for a stronger measure than what is already provided by the application container's authentication and authorization mechanism. Please see the JBoss Business Process Management Suite administrative documentation for further details and consideration. [x] Enable the Java security manager Input 1 to select, 0 to deselect:
- After the Java Security Manager choice, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- The Configure JMS SSL keystores will display on the CLI:
Configure JMS SSL keystores Some JMS messages sent to BPMS can contain password information. In order to make sure that this information is sent safely, SSL must be used, which uses public/private key encryption to set up an encrypted connection between the client and the server. Please supply the private passwords to use with BPMS. These passwords should not be shared with others. If multiple distinct clients are necessary, the number of distinct client keystores can also be indicated. The server's keystore certificate will automatically be imported into the client keystores. Passwords to use for the generated keystores. They must have at least 6 characters.
- Enter the server keystore password:
Server keystore password: [] Re-enter server keystore password: [**********]
- Enter the client keystores password:
Client keystores password: [**********] Re-enter client keystores password: [**********]
- Enter the number of client keystores to generate:
Number of client keystores to generate: [1]
- After the keystores configuration, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- Next, select whether to enable the IPv6 configuration.
IPv6 configuration If this computer is using a pure IPv6 configuration, please check the box below. A pure IPv6 setup requires additional configuration at runtime to ensure the proper bindings of the management and http interfaces. [ ] Enable pure IPv6 configuration Input 1 to select, 0 to deselect:
- After the IPv6 configuration choice, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- Configure the runtime environment by either choosing the default configuration or inputting advanced options.
Configure runtime environment Red Hat JBoss Business Process Management Suite can be further customized at this time. 0 [x] Perform default configuration 1 [ ] Perform advanced configuration Input Selection:
If you select 1, "Perform advanced configuration," complete the following configurations:[ ] Install password vault Input 1 to select, 0 to deselect: [ ] Enable SSL security Input 1 to select, 0 to deselect: [ ] Enable LDAP authentication Input 1 to select, 0 to deselect: [ ] Add a security-domain Input 1 to select, 0 to deselect:
- Next, choose an option from the prompt below:
press 1 to continue, 2 to quit, 3 to redisplay.
- Configure the password vault by creating a password and pressing 1 to continue:
Configure password vault A password vault encrypts sensitive strings and stores them in an encrypted keystore. The vault mechanism manages decrypting the strings for use with security domains, security realms, or other verification systems. Please make note of your entry below in order to mask any subsequent passwords. See EAP 6 documentation for further details. The password must have no fewer than 6 characters. Vault keystore password: [] Re-enter vault keystore password: [**********] press 1 to continue, 2 to quit, 3 to redisplay.
- The .jar file will begin to upack and configure.
- After a successful installation, the command-line will ask you if you would like to generate an automatic installation script and properties file.
Installation has completed successfully. Application installed on /home/user/Documents/BPMS_Installer Would you like to generate an automatic intallation script and properties file? (y/n) [n]:
- If you select [ y ], provide a path for the automatic installation script:
Select path for the automatic installation script: [/home/user/Documents/BPMS_Installer/<auto script filename>]
This generated script will allow the user to run the installer in the following way for future installations:java -jar jboss-bpms-installer.jar <auto script filename>
Note
Running the installer in this way will result in an installation identical to the installation from which the auto script was generated. Note that sensitive values, such as passwords, will need to be provided from an external file or provided at auto installation time. The optional argument below allows the user to provide these values automatically:-variablefile <variable filename>
Sensitive values can also be provided using the following argument:-variables key1=value1,key2=value2
- The command-line will provide the following message upon a successful auto script creation and/or console installation:
XML written successfully. [ Console installation done ] [BPMS_Installer]$
- Start JBoss EAP by running
standalone.shin thejboss-eap-[VERSION]/bindirectory../standalone.sh
- Navigate to http://localhost:8080/business-central in a web browser.
- Login with the correct username/password as given to the BPMS user in the "Create and confirm a password for the BPMS user" step.

Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.