Configuring the BPM event emitter for IBM Business Automation Insights

For IBM® Business Automation Insights to capture events for processes running on a container deployment of IBM Business Automation Workflow, you must update the custom resource to enable the BPM event emitter.

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.

About this task

The BPM event emitter captures business process events from your workflow applications and sends them to Business Automation Insights for analysis and visualization.

Important: On container deployments of Business Automation Workflow, the BPM event emitter supports only BPMN events. For information about BPMN event formats, see BPMN event formats.

The configuration steps differ depending on whether you are configuring Business Automation Workflow Runtime or Authoring.

Procedure

Edit the custom resource (CR) file for your Business Automation Workflow deployment.
Locate the appropriate configuration section based on your deployment type:
- For Runtime: In the baw_configuration[x] section, add the business_event parameters.
  Note: If you have multiple Business Automation Workflow instances, ensure that you apply the changes to the correct instance by specifying the appropriate array index [x].
- For Authoring: In the workflow_authoring_configuration section, add the business_event parameters.
Set the business_event.enable parameter to true.
Configure additional business_event parameters as needed for your environment.
Key parameters include:
- enable_task_record: Whether to enable the task record in generated events. The default value is true.
- enable_task_api: Whether to record additional task information in generated events. The default value is false.
- subscription: List of subscription configurations that define which events to monitor.
For a complete list of parameters and their descriptions, see:
- Runtime: Business Automation Workflow on containers runtime parameters
- Authoring: Business Automation Workflow on containers authoring parameters
Example configuration for Runtime with subscription:
```
baw_configuration:
  - name: instance1
    business_event:
      enable: true
      enable_task_record: true
      enable_task_api: false
      subscription:
        - app_name: '*'
          version: '*'
          component_type: '*'
          component_name: '*'
          element_type: '*'
          element_name: '*'
          nature: '*'
```
Example configuration for Authoring with subscription:
```
workflow_authoring_configuration:
  business_event:
    enable: true
    enable_task_record: true
    enable_task_api: false
    subscription:
      - app_name: '*'
        version: '*'
        component_type: '*'
        component_name: '*'
        element_type: '*'
        element_name: '*'
        nature: '*'
```
Save the CR file and apply the changes to your deployment.
```
kubectl apply -f <custom_resource_file>.yaml
```

Results

The BPM event emitter is now configured and will capture BPMN events from your workflow processes. The events are sent to Business Automation Insights Kafka topics for processing and analysis.

What to do next

After configuring the BPM event emitter, you can:

View the captured events in Business Automation Insights dashboards.
Configure additional event emitters for Case and Workforce Insights. See Configuring the Case event emitter for Business Automation Insights and Configuring the Workforce Insights emitter for Business Automation Insights.
Customize the subscription configuration to monitor specific applications, components, or event types.