Enabling the widget to display process activities

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15

To view workflow process activity details in the Case History visualizer widget, the Case History event emitter needs to be installed and configured in the Business Automation Workflow on-premises environment.

Before you begin

Note: The information in this document applies only to the on-premises Business Automation Workflow.

Confirm that the following environment prerequisites are met:

Download and install Business Automation Workflow 26.0.0.0 and its interim fixes, and configure your working environment. If the Business Automation Workflow environment is configured with an external Content Platform Engine, the minimum version that is required for Content Platform Engine is V5.5.5.
Make sure that you use the latest versions of the emitter and script.

Confirm that the following files exist:

File name	Location
CHEventEmitter.war	`workflow_install_root`/CaseManagement/analytics
EnableCH.py	`workflow_install_root`/CaseManagement/analytics
CHEmitterConfig.properties	`workflow_install_root`/CaseManagement/analytics

About this task

The Case History event emitter emits Business Automation Workflow process events, which are processed by the Case History server. After the events are processed, Business Automation Workflow process activity details can be viewed in the Case History Visualizer timeline.

Enabling the Timeline Visualizer widget to display Business Automation Workflow process activities includes the following main steps:

Installing Case History Emitter
Updating the Case History emitter application
Syntax of the EnableCH.py script
Updating the Case History emitter configuration property values

Installing Case History Emitter

Edit online

About this task

Use the EnableCH.py script to install the Case History emitter application. For a list of options that are available with EnableCH.py, see Syntax of the EnableCH.py script.

Procedure

Confimr that your Business Automation Workflow environment is up and running.
Make a copy of the CHEmitterConfig.properties file and rename it to include target object store in the format CHEmitterConfig_<TOS Name>.properties. For example, if the target object store name is TOS1, then rename the file to CHEmitterConfig_TOS1.properties.
Make multiple copies of the file, one for each target object store, which needs to be processed.
Update each CHEmitterConfig_<TOS Name>.properties file. See Updating the Case History emitter configuration property values.

Run the following command:

<Dmgr_profile_root>\bin\wsadmin.[bat|sh] -f <Workflow_Install_Root>\CaseManagement\analytics\EnableCH.py --enableCH --property=<Workflow_Install_Root>\CaseManagement\analytics\CHEmitterConfig_<TOS Name1>.properties

Note: --property takes the list of property files with comma separated values. For example, see the command for target object stores TOS1 and TOS2.

--property=<Workflow_Install_Root>\CaseManagement\analytics\CHEmitterConfig_TOS1.properties, <Workflow_Install_Root>\CaseManagement\analytics\CHEmitterConfig_TOS2.properties

Restart your Business Automation Workflow environment.
If your Business Automation Workflow environment is configured with an externalContent Platform Engine environment, restart the Content Platform Engine environment after the Business Automation Workflow environment is restarted.

Results

The script installs the CHEventEmitter application with the configuration parameters that are specified in the CHEmitterConfig_<TOS Name>.properties file.

Note: Case History emitter starts emitting Business Automation Workflow process engine events from the time that it is installed.

Updating the Case History emitter application

Edit online

Procedure

Make a backup copy of the CHEventEmitter.war and CHEmitterConfig.properties files that are located in the <Workflow_Install_Root>/CaseManagement/analytics directory.
If more than one deployment environment is available, change the value of the deploymentEnvironmentName parameter from None to the name of the deployment environment that you want to update in the <Workflow_Install_Root>/CaseManagement/analytics/CHEmitterConfig_<TOS Name>.properties file.

Update the application by running the following Jython command:

<Dmgr_profile_root>/bin/wsadmin.[bat|sh] -lang jython -f <Workflow_Install_Root>/CaseManagement/analytics/EnableCH.py -u application

Optional: If the configuration of the Case History database connection needs to be updated, run the following Jython command:
```
<Dmgr_profile_root>/bin/wsadmin.[bat|sh] -lang jython -f <Workflow_Install_Root>/CaseManagement/analytics/EnableCH.py -u dbConnection -d <Workflow_Install_Root>/CaseManagement/analytics/CHEmitterConfig_<TOS Name>.properties
```
Note: This step is required only when updating the Case History emitter for the first time after upgrading Business Automation Workflow to 24.0.1.
Restart your Business Automation Workflow environment.

Note: If you specify new Case History store database connection information, the emitter will process only Business Automation Workflow process engine events that start from the current updated time.

Syntax of the EnableCH.py script

Edit online

About this task

The EnableCH.py script configures the Dynamic Event Framework (DEF), and deploys the CHEventEmitter application according to the specified emitter configuration parameters.

Syntax: This script configures the Dynamic Event Framework (DEF) to subscribe to Business Automation Workflow activity events, and installs the CHEventEmitter application to emit Business Automation Workflow process engine events to the Case History store. For more information, see the CHEmitterConfig_<TOS Name>.properties file.

Usage

wsadmin.(sh|bat) -f EnableCH.py [--enableCH --property=propertyFile] | --update=application | 
--update=dbconnection --property=propertyFileList | --help

wsadmin.(sh|bat) -f EnableCH.py [-e -d propertyFile] | -u application | -u dbconnection -d propertyFileList | --help

Parameters

Parameter	Description
-e or --enableCH	(Optional) Configures the Dynamic Event Framework (DEF) to subscribe to Business Automation Workflow activity events, and installs the `CHEventEmitter` application to emit Business Automation Workflow process engine events to the Case History store. For details, see the CHEmitterConfig_<TOS Name>.properties file.
-u application or --update=application	Uses the `<Workflow_Install_Root>`/CaseManagement/analytics/CHEventEmitter.war archive to update the installed `CHEventEmitter` application.
-u dbconnection or --update=dbconnection	Updates the application connection information, as specified in the properties file.
--property=propertyFile	You can update the property values in the CHEmitterConfig_<TOS Name>.properties configuration file. Multiple files can be specified as comma-separated list with one file per target object store to be processed.
--help	Displays the parameter documentation.

Updating the Case History emitter configuration property values

Edit online

Procedure

Collect details of the Case History store database. The details are used by CHEventEmitter to store the Business Automation Workflow activity event information for further processing by the Case History server.
Create a copy of the CHEmitterConfig.properties file, and rename it to include the target object store name of format CHEmitterConfig_<TOS Name>.properties. For example, if the target object store name is TOS1, then rename the file to CHEmitterConfig_TOS1.properties.
Make multiple copies of the file one for each of the target object store, which needs to be processed.

Refer to the following table for property updates.

Table 1. Property values to configure the Case History emitter
Property name	Value	Description
DeploymentEnvironmentName	`None` or a real name	The name of the target deployment environment. If only one deployment environment is available, you can use `None`.
dbType	`DB2` or `MSSQL` or `ORACLE` or `POSTGRESQL`	The database server type of the Case History store database. The value can be one of `<DB2\|MSSQL\|ORACLE\|POSTGRESQL>`.
dbServer	Database server name	The database server name of the Case History store database
dbPort	Database server port	The database server port of the Case History store database
dbName	Database name	The database name of the Case History store
dbUser	Database user	The database username of the Case History store database
dbPassword	Database password	The database password of the Case History store
dbPasswordBase64	Database password in Base64 encoded format	(Optional) The database password of the Case History store, in Base64 format. The users can provide either the dbPassword or the dbPasswordBase64 value.
dbSchema	Database schema name	The database schema of the Case History store
dbInstance	Database instance name	(Optional) The database instance of the Case History store. This setting is specific to the MSSQL database server type.
dbServiceName	Database SID name	(Optional) The database SID name of the Case History store. This setting is specific to the Oracle database server type.

Note:

The property values in Table 1 (db*) are used to build a JDBC connection to the database. If you have more parameters to specify for the database connection, you can configure the connection by specifying a JDBC URL manually by using the dbJDBCUrl property.

dbJDBCUrl=<JDBC url to connect to db>

for example, for Oracle, the JDBC URL can be:

 jdbc:oracle:thin:<dbUser>/<dbPassword>@<dbServer>:<dbPort>:<dbServiceName>

Limitations:

When using dbJDBCUrl property, all other property values (db*) are ignored.
When using dbJDBCUrl to specify more JDBC parameters, the additional parameters might be supported by the database vendor, but not by the Case History emitter.