Administration And Configuration Guide
The Administration guide for Red Hat JBoss BRMS 6
Abstract
Chapter 1. Introduction
1.1. About Red Hat JBoss BRMS
1.2. Use Case: Business Decision Management in the Insurance Industry with JBoss BRMS

Figure 1.1. BRMS Use Case: Insurance Industry Decision Making
Chapter 2. Repository
Project Explorer from the unified environment of Red Hat JBoss BRMS.
2.1. Creating a repository
Important
ADMIN role can create a repository.
Procedure 2.1. Creating a New Repository
- Open the Administration perspective: on the main menu, click → .
- On the perspective menu, click → .
- The Create Repository pop-up window is displayed.

Figure 2.1. Create Repository Pop-up
- Enter the mandatory details:
- Repository name.
Note
Note that the repository name should be a valid filename. Avoid using a space or any special character that might lead to an invalid folder name. - Select an organizational unit in which the repository is to be created from the Organizational Unit drop-down option.
- Click Create
- A confirmation prompt with an OK button is displayed which notifies the user that the repository is created successfully. Click OK.
2.2. Cloning a repository
Important
ADMIN role can clone a repository.
Procedure 2.2. Cloning a repository
- Open the Administration perspective.
- On the Repositories menu, select .
- The Clone Repository pop-up window is displayed.

Figure 2.2. Clone Repository Pop-up
- In the Clone Repository dialog window, enter the repository details:
- Enter the Repository Name to be used as the repository identifier in the Asset repository and select the Organizational Unit it should be added to.
- Enter the URL of the GIT repository:
- For a Local Repository:
file:///path-to-repository/reponame - For a Remote or preexisting Repository:
git://hostname/reponame
Note
The file protocol is only supported for 'READ' operations. 'WRITE' operations are not supported. - If applicable, enter the User Name and Password to be used for authentication when cloning the repository.
- Click Clone.
- A confirmation prompt with an OK button is displayed which notifies the user that the repository is created successfully. Click OK.
2.3. Maven repository
- Builds
- Documentation
- Reporting
- Dependencies
- Releases
- SCMs
- Distribution
- Local: refers to a local repository where all the project dependencies are stored and is located with the current installation in the default folder as "m2". It is a cache of the remote downloads, and also contains the temporary build artifacts which have not yet been released.
- Remote: refers to any other type of repository that can be accessed by a variety of protocols such as file:// or http://. These repositories can be at a remote location set up by a third-party for downloading of artifacts or an internal repository set up on a file or HTTP server, used to share private artifacts between the development teams for managing internal releases.
2.4. Project
pom.xml) with information on how to build the output artifact. It also contains the Module Descriptor file, kmodule.xml, that contains the KIE Base and KIE Session configuration for the assets in the project.
2.5. Creating a project
- Open the Project Authoring perspective: on the main menu, click → .
- In the Project Explorer, select the organizational unit and the repository where you want to create the project.
- In the perspective menu, go to → .
- In the Create new Project dialog window, define the project details:
- In the Resource Name text box, enter the project name.

Figure 2.3. New Project Screen
Note
Note that the project name should be a valid filename. Avoid using a space or any special character that might lead to an invalid folder name.
- The explorer refreshes to show a New Project Wizard pop-up window.

Figure 2.4. New Project Wizard Pop-up
- Define the Project General Settings and Group artifact version details for this new project. These parameters are stored inside the
pom.xmlmaven configuration file.- Project Name: The name for the project; for example
Mortgages - Project Description: The description of the project which may be useful for the project documentation purpose.
- Group ID: group ID of the project; for example
org.mycompany.commons - Artifact ID: artifact ID unique in the group; for example
myframework - Version ID: version of the project; for example
2.1.1
The Project Screen view is updated with the new project details as defined in the pom.xml file. Note, that you can switch between project descriptor files in the drop down-box with Project Settings and Knowledge Base Setting, and edit their contents.
2.6. Adding dependencies
- Open the Project Editor for the given project:
- In the Project Explorer view of the
Project Authoringperspective, open the project directory. - In the perspective menu, go to → .
- In the Project Screen view, select in the Project Settings drop-down box the Dependencies item.
- On the updated Project Screen, click the button to add a maven dependency or click the button to add a dependency from the Knowledge Store (Artifact repository):
- When adding a maven dependency, a user has to define the Group ID, Artifact ID and the Version ID in the new row which is created in the dependency table.
- When adding a dependency from the Knowledge Store, select the dependency in the displayed dialog box: the dependency will be added to the dependency table.
- To apply the various changes, the dependencies must be saved.
Chapter 3. Logging
3.1. Logging
logback functionality for logging configuration.
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.x</version>
</dependency>Note
slf4j-nop and slf4j-simple are ideal for a light environment.
3.2. Configuring Logging
logback.xml file located at business-central.war/WEB-INF/classes/logback.xml. To set the logging level of the org.drools package to "debug" for verbose logging, you would need to add the following line to the file:
<configuration>
<logger name="org.drools" level="debug"/>
...
<configuration>- org.guvnor
- org.jbpm
- org.kie
- org.slf4j
- org.dashbuilder
- org.uberfire
- org.errai
- etc...
log4j, the log4j.xml can be located at business-central.war/WEB-INF/log4j.xml and can be configured in the following way:
<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
<category name="org.drools">
<priority value="debug" />
</category>
...
</log4j:configuration>Note
Chapter 4. Command line configuration
kie-config-cli tool is a command line configuration tool that provides capabilities to manage the system repository from the command line and can be used in an online or offline mode.
Online mode(default and recommended) - on startup, the tool connects to a Git repository using a Git server provided bykie-wb. All changes are made locally and published to upstream only after explicitly executing the push-changes command. Use the exit command to publish local changes. To discard local changes on exit, use the discard command.Offline mode(a kind of installer style) - creates and manipulates the system repository directly on the server (there is no discard option).
- Go to the Red Hat Customer Portal and log in.
- Click → .
- In the Product Downloads page that opens, click Red Hat JBoss BRMS.
- From the Version drop-down menu, select 6.0.3.
- In the displayed table, navigate to the Supplementary Tools row and then click Download.
kie-config-cli-6.MINOR_VERSION-redhat-x-dist with file kie-config-cli.sh.
4.1. Starting the kie-config-cli tool in online mode
- To start the kie-config-cli tool in online mode, navigate to the
kie-config-cli-6.MINOR_VERSION-redhat-x-distdirectory where you installed the tool and then execute the following command. - In a Unix environment run:
./kie-config-cli.sh
In a Windows environment run:./kie-config-cli.bat
git://kie-wb-host:9148/system
4.2. Starting the kie-config-cli tool in offline mode
- Navigate to the
kie-config-cli-6.MINOR_VERSION-redhat-x-distdirectory where you installed the tool. - In a Unix environment, run:
./kie-config-cli.sh offline
In a Windows environment, run:./kie-config-cli.bat offline
.niogit) is located. If .niogit does not yet exist, the folder value can be left empty and a brand new setup is created.
4.3. Commands available for the kie-config-cli tool
add-deployment- adds a new deployment unitadd-repo-org-unit- adds a repository to the organizational unitadd-role-org-unit- adds role(s) to an organizational unitadd-role-project- adds role(s) to a projectadd-role-repo- adds role(s) to a repositorycreate-org-unit- creates new organizational unitcreate-repo- creates a new git repositorydiscard- does not publish local changes, cleans up temporary directories and closes the toolexit- publishes work, cleans up temporary directories and closes the toolhelp- prints available commands with descriptionslist-deployment- lists available deploymentslist-org-units- lists available organizational unitslist-repo- lists available repositoriespush-changes- pushes changes to upstream repository (in online mode only)remove-deployment- removes existing deploymentremove-org-unit- removes existing organizational unitremove-repo- removes an existing repository from config onlyremove-repo-org-unit- removes a repository from the organizational unitremove-role-org-unit- removes role(s) from an organizational unitremove-role-project- removes role(s) from a projectremove-role-repo- removes role(s) from a repository
Chapter 5. Migration
5.1. Data Migration
- Download the migration tool by logging in at the Red Hat Customer Portal and then navigating to Red Hat JBoss BPM Suite Software Downloads section. Click on Red Hat JBoss BPM Suite Migration Tool to download the zip archive.
- Unzip the downloaded zip archive in a directory of your choice, navigate to this directory in a command prompt and then run the following command:
./bin/runMigration.sh -i <source-path> -o <destination-path> -r <repository-name>
- <source-path> is a path to a source JCR repository.
- <desintation-path> is a path to a destination GIT VFS. This folder must not exist already.
- <repository-name> an arbitrary name for the new repository.
Importing the repository in Business Central
Note
Importing the repository in JBDS
- Start JBoss Developer Studio.
- Start the Red Hat JBoss BPM Suite server (if not already running) by selecting the server from the server tab and click the start icon.
- Select → and navigate to the Git folder. Open the Git folder to select and click next.
- Select the repository source as and click next.
- Select the repository that is to be configured from the list of available repositories.
- Import the project as a general project in the next window and click next. Name this project and click Finish.
5.2. API and Backwards Compatibility
knowledge-api jar for backwards compatible code. This API is the public interface for working with BPMS and BRMS and is backwards compatible.
5.3. Migrating task service
LocalHTWorkItemHandler.
Chapter 6. Integration
jboss-brms-engine.zip file and is called kie-spring-VERSION-redhat-MINORVERSION.jar.
As a Self Managed Process Engine
RuntimeManager API, perfect synchronization between process engine and task service is managed internally and the end user does not have to deal with the internal code to make these two work together.
As a Shared Task Service
TaskService, you have more flexibility in configuring the task service instance as it is independent of the RuntimeManager. Once configured it is then used by the RuntimeManager when requested.
org.ie.spring.factorybeans.RuntimeEnvironmentFactoryBean class. This factory class is responsible for producing instances of RuntimeEnvironment that are consumed by RuntimeManager upon creation.
- DEFAULT - default (most common) configuration for RuntimeManager
- EMPTY - completely empty environment to be manually populated
- DEFAULT_IN_MEMORY - same as DEFAULT but without persistence of the runtime engine
- DEFAULT_KJAR - same as DEFAULT but knowledge asset are taken from KJAR identified by releaseid or GAV
- DEFAULT_KJAR_CL - build directly from classpath that consists kmodule.xml descriptor
- knowledgeBase
- assets
- releaseId
- groupId, artifactId, version
entity manager factory and transaction manager.
Chapter 7. Localization and customization
7.1. Available Languages
- United States English (
en_US) - Spanish (
es_ES) - Japanese (
ja_JP) - Chinese (
zh_CN) - Portuguese (
pt_BR) - French (
fr_CA) - German (
de_DE)
Note
7.2. Changing language settings
Changing the User Interface Language in Business Central
http://localhost:8080/business-central/?locale=pt_BR
7.3. Running the JVM with UTF-8 Encoding
7.4. Access control
Workbench Configuration
$JBOSS_HOME business-central.war/WEB-INF/classes/workbench-policy.propeties
Chapter 8. Monitoring
8.1. JBoss Operations Network
8.2. Downloading Red Hat JBoss ON for BRMS
- Go to the Red Hat Customer Portal and log in.
- Click → .
- In the Product Downloads page that opens, click Red Hat JBoss Operations Network..
- From the Version drop-down menu, select version 3.2.0.
- Select Red Hat JBoss Operations Network 3.2.0 Base Distribution and then click Download.
8.3. Installing the BRMS Plug-in into JBoss ON
Procedure 8.1. Copying the JBoss BRMS plug-in JAR files
- Extract the JBoss BRMS plug-in pack archive to a temporary location. This creates a subdirectory with the name jon-plugin-pack-brms-bpms-3.2.0.GA. For example:
[root@server rhq-agent]# unzip jon-plugin-pack-brms-bpms-3.2.0.GA.zip -d /tmp
- Copy the extracted BRMS plug-in JAR files from the jon-plugin-pack-brms-bpms-3.2.0.GA/ directory to the JBoss ON server plug-in directory. For example:
[root@server rhq-agent]# cp /tmp/jon-plugin-pack-brms-bpms-3.2.0.GA/*.jar /opt/jon/jon-server-3.2.0.GA1/plugins
- Start the JBoss Operations Network server to update the BRMS plug-in.
Procedure 8.2. Uploading the BRMS plug-in through GUI
- Start the JBoss Operations Network Server and Log in to access the GUI.
- In the top navigation of the GUI, open the Administration menu.
- In the Configuration area on the left, select the Server Plugins link.
- At the bottom of the list of loaded server plug-ins, click the Upload a plugin button and choose the BRMS plugin.
- The BRMS plug-in for JBoss Operations Network is now uploaded.
8.4. Monitoring Kie Bases and Kie Sessions
-kie.mbeans = enabled
KieBaseConfiguration kbconf = KieServices.Factory.get().newKieBaseConfiguration();
kbconf.setOption(MBeansOption.ENABLED);Note
Kie Services have been implemented for BRMS 6; for BRMS 5, Drools Services was the naming convention used and it had different measurements on sessions. For example, → renaming occured in the updated version.
8.5. The JBoss Rules Kie Base Monitoring Service
- Start all internal MBeans
- Stop all internal MBeans
8.6. The JBoss Rules Kie Session Monitoring Service
- Reset all metrics counters.
- Return statistics for a specific rules.
- Get statistics for a specific process.
- Get statistics for a specific process instance.
- The total number of facts in working memory.
- The total number of matches created since the last reset.
- The total number of matches fired since the last reset.
- The total number of matches canceled since the last reset.
- The total time spent firing rules since the last reset.
- The total number of process instances started since the last reset.
- The total number of process instances completed since the last reset.
- The timestamp of the last reset operation.
Appendix A. Revision History
| Revision History | |||
|---|---|---|---|
| Revision 1.0.0-20 | Mon Feb 09 2015 | ||
| |||
