Configuring the Case event emitter for IBM Business Automation Insights

Before you begin

Before you begin:

• Business Automation Insights must be installed and configured in your environment. See Installing Business Automation Insights.
• Kafka must be configured and accessible for event streaming.
• You must have one or more target object stores configured for your case solutions.

About this task

The Case event emitter captures events from case solutions and sends them to Business Automation Insights for analysis and visualization. For information about case event formats, see Case event formats.

You can use the process_events_after_completion parameter to set the emitter to process the events that are generated after the case is completed.

The configuration steps are similar for both IBM Business Automation Workflow Runtime and Authoring, with minor differences in the custom resource structure.

To configure the Case event emitter:

1. Edit the custom resource (CR) file for your IBM Business Automation Workflow deployment.
2. Locate the case.event_emitter section in your CR.
   • For IBM Business Automation Workflow Runtime, this is under baw_configuration[x].case.event_emitter.
   • For IBM Business Automation Workflow Authoring, this is under workflow_authoring_configuration.case.event_emitter.
3. Configure the required parameters for the Case event emitter.

   The following parameters are required:

   • tos_name: Target Object Store name of CASE.
   • connection_point_name: Connection point name for the Target Object Store.
   • date_sql: Creation date of the events in the format yyyyMMddTHHmmssZ. The emitter starts processing events from this date. If a bookmark exists, the emitter ignores this parameter and processes events from the bookmark.
   • logical_unique_id: Up to 8-character alphanumeric string without underscores. This value is required for bookmark tracking. The emitter tracks processed events using a Content Engine Audit Processing Bookmark with a display name based on this value.
   • solution_list: Comma-separated list of case solution names to process. The default value is "*" for all solutions.

   Example configuration for IBM Business Automation Workflow Runtime:

   baw_configuration:
     - name: instance1
       case:
         event_emitter:
           - tos_name: "BAWINS1TOS"
             connection_point_name: "P8Admins"
             date_sql: "20200630T002840Z"
             logical_unique_id: "bawinst1"
             solution_list: "SampleSolution1,SampleSolution2"

   Example configuration for IBM Business Automation Workflow Authoring:

   workflow_authoring_configuration:
     case:
       event_emitter:
         - tos_name: "BAWTOS"
           connection_point_name: "pe_conn_BAWTOS"
           date_sql: "20200630T002840Z"
           logical_unique_id: "bawinst1"
           solution_list: "*"

4. Optional: Configure additional parameters as needed.

   Additional optional parameters include:

   • casetype_list: Comma-separated list of case types to process. The default value is empty (all case types).
   • emitter_batch_size: Case event emitter batch size. The default value is 1000.
   • process_pe_events: Whether to process FileNet® Process Engine events in addition to IBM Business Automation Workflow events. The default value is true. Set to false to disable FileNet process events.

   For a complete list of parameters and their descriptions, see Business Automation Workflow on containers runtime parameters or Business Automation Workflow on containers authoring parameters.

   Example with additional parameters:

   case:
     event_emitter:
       - tos_name: "BAWINS1TOS"
         connection_point_name: "P8Admins"
         date_sql: "20200630T002840Z"
         logical_unique_id: "bawinst1"
         solution_list: "SampleSolution1,SampleSolution2"
         casetype_list: "CaseType1,CaseType2"
         emitter_batch_size: 1000
         process_pe_events: false

5. Optional: If you want to configure multiple target object stores, add additional entries to the event_emitter array.

   You can configure the emitter to process events from multiple target object stores by specifying multiple entries with different tos_name and connection_point_name values.

   Example with multiple target object stores:

   case:
     event_emitter:
       - tos_name: "TOS1Name"
         connection_point_name: "tos1_connection_point_name"
         date_sql: "20200630T002840Z"
         logical_unique_id: "bawinst1"
         solution_list: "SampleSolution1,SampleSolution2"
       - tos_name: "TOS2Name"
         connection_point_name: "tos2_connection_point_name"
         date_sql: "20220930T002710Z"
         logical_unique_id: "bawinst1"
         solution_list: "SampleSolution3,SampleSolution4"

6. Save the CR file and apply the changes to your deployment.

   kubectl apply -f <custom_resource_file>.yaml

7. Verify that the Case event emitter is processing events.

   Check the logs of the IBM Business Automation Workflow pods to confirm that the Case event emitter is running and processing events.

Results

The Case event emitter is now configured and will capture events from your case solutions. The emitter sends messages to the target Business Automation Insights Kafka topics.

What to do next

After configuring the Case event emitter, you can:

• View the captured case events in Business Automation Insights dashboards.
• Configure additional event emitters for BPM and Workforce Insights. See Configuring the BPM event emitter for Business Automation Insights and Configuring the Workforce Insights emitter for Business Automation Insights.
• Monitor the bookmark status to track event processing progress.
• Adjust the solution_list or casetype_list parameters to filter which case events are captured.