Preparing the Case event emitter application for deployment

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

To prepare the Case event emitter for deployment to WebSphere® Application Server, you unpack the WAR file, you customize the configuration file, and you repackage the WAR file.

Before you begin

Important:

This manual configuration approach is provided for reference only. The recommended approach is to use the automated deployment via the EnableCaseBAI.py script, which automatically configures all required settings including the necessary JVM properties.

If you must use manual deployment, you must also manually configure the -DcaseEventEmitterJsonFile JVM system property on your WebSphere Application Server to point to the configuration file location. Without this property, the Case Event Emitter will not function correctly, even if the configuration file is packaged inside the WAR file.

For automated deployment, see Installing and configuring the Case event emitter automatically.

Make sure Java™ 1.6 or later is installed and set in your PATH environment variable.

About this task

After you have installed the interim fix, the CaseEventEmitter.war file is available in your Workflow_Install_Root/CaseManagement/analytics/ directory.

Procedure

To unpack the WAR file, browse to the directory that contains the CaseEventEmitter.war file, for example /work, and run the xvf command.
```
cd work
mkdir testdir
cd testdir
mkdir expanded
cd expanded
jar xvf ../../CaseEventEmitter.war
```
The WAR file includes the template-CaseEventEmitter.json file and the sample-CaseEventEmitter.json file in the WEB-INF/classes/ directory. The template-CaseEventEmitter.json file provides a template to help you fill out the properties. The sample-CaseEventEmitter.json file provides a sample configuration file.
Copy the provided template-CaseEventEmitter.json and rename it to CaseEventEmitter.json or copy your existing CaseEventEmitter.json file to this location.
```
cp WEB-INF/classes/template-CaseEventEmitter.json WEB-INF/classes/CaseEventEmitter.json
```
Edit the CaseEventEmitter.json file to match the configuration of your Content Engine server to retrieve events.
The configuration file is described in Structure of the Case event emitter JSON file.
Re-create and repackage the WAR file from the directory where you decompressed it, by running the cvf command.
Now you work from the work\testdir\expanded directory, which you created in step 1. Your work directory contains the edited CaseEventEmitter.json, which you configured in step 3.
```
jar cvf ../../CaseEventEmitter.war .
```
Configure the JVM system property to specify the configuration file location.

The Case Event Emitter requires the -DcaseEventEmitterJsonFile JVM system property to locate its configuration file. You must set this property on the WebSphere Application Server where the emitter is deployed.
1. Open the WebSphere Application Server administration console.
2. Navigate to Servers > Server Types > WebSphere application servers > your_server_name.
3. Under Server Infrastructure, expand Java and Process Management and click Process definition.
4. Under Additional Properties, click Java Virtual Machine.
5. In the Generic JVM arguments field, add the following property:
```
-DcaseEventEmitterJsonFile=<full_path_to_CaseEventEmitter.json>
```
  For example:
```
-DcaseEventEmitterJsonFile=/opt/IBM/WebSphere/AppServer/profiles/AppSrv01/config/CaseEventEmitter.json
```
6. Click OK and save the configuration.
7. Restart the server for the changes to take effect.
The Case Event Emitter can now locate and load its configuration file via the JVM system property.

What to do next

You are now ready to deploy the CaseEventEmitter.war file to WebSphere Application Server, as instructed in Deploying the Case event emitter application.