Installing and configuring the BPM event emitter

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

To install the BPM event emitter to the IBM® Business Automation Workflow server, you enable the generation of Dynamic Event Framework (DEF) events and you install the BPMEventEmitter application in the Support cluster of an Application, Messaging, and Support topology pattern of a production environment.

Important: Enabling IBM Business Automation Insights events can cause the JMS destination queue to fill up due to Business Automation Insights configuration issues or Business Automation Insights system issues, preventing the event emitter from processing messages and stopping Business Automation Insights event emission. Without a configured exception queue to handle JMS queue issues, messages become stuck on the destination queue. Once the JMS queue is full, performance degradation and SIB message-store-full errors appear in logs. If you encounter these issues, disable Business Automation Insights events as the first troubleshooting step. To prevent this, configure an exception queue before enabling Business Automation Insights events.

Before you begin

Running IBM Business Automation Workflow
Make sure that your IBM Business Automation Workflow environment is up and running.
Adjusting the scripts
  • If your IBM Business Automation Workflow environment has several deployment environments, in both the EnableBAI.py and SampleConfigureJSONEventsToJMS.py scripts, update each deploymentEnvironmentName variable value to the name of the deployment environment that you want to configure.
  • If your authentication alias to use for the JMS queue connection factory is different from DeAdminAlias, in the SampleConfigureJSONEventsToJMS.py script, update the jmsQueueConnectionFactory_AuthorizationAlias variable value to the actual alias name.
  • If the name of the service integration bus is not in the format BPM.<deployment_environment_name>.Bus, in theSampleConfigureJSONEventsToJMS.py script, update the ServiceIntegrationBusName variable value to the actual bus name.

About this task

To set up IBM Business Automation Workflow and install the BPM event emitter application, you use the EnableBAI.py script.
Important: Only events that are generated after you enable the emitters are sent to IBM Business Automation Insights and displayed in the dashboards. Enabling the emitters does not retroactively send historical process, case, or task data. If you require historical analytics, you must enable the emitters before you start any process or case execution.

Procedure

  1. To emit events for BPMN processes, install the default configuration. 
    <Dmgr_profile_root>\bin\wsadmin.[bat|sh] -f Workflow_Install_Root\BPM\Lombardi\tools\def\EnableBAI.py --enable
  2. If you want to emit events for BPEL processes and human tasks, also run the following script from your deployment manager root. 
    <Dmgr_profile_root>\bin\wsadmin.[bat|sh] -conntype none -profileName profile_name -f Workflow_Install_Root\ProcessChoreographer\admin\setStateObserver.py -cluster AppCluster -enable DEF
    For more information about the command and its parameters, see setStateObserver.py administrative script.
  3. Restart your IBM Business Automation Workflow deployment environment (Dmgr, Node, and servers).

Results

The script has the following effects.
  1. It enables the generation of dynamic event framework (DEF) events whose subscription arrays are configured as specified in Workflow_Install_Root/BPM/Lombardi/tools/def/SampleConfigureJSONEventsToJMS.py. For more information about subscription arrays, see Capturing IBM Business Automation Workflow events for external consumption External link opens a new window or tab.
  2. It installs the BPMEventEmitter application.

What to do next

Configure the BPM event emitter as described in Retrieving your Kafka connection information and generating the BPMEventEmitter.yml file.