This topic applies only to the IBM Business Automation Workflow Advanced configuration.

Events for activities

Edit online
Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Events are emitted for activities if monitoring is requested for these activities in IBM® Integration Designer. These events are also written to the audit log.

State transitions and activity events

The state changes and the events that are emitted depend on the type of activity:
  • Invoke, assign, empty, reply, rethrow, throw, terminate, and Java™ snippet activities
    Figure 1. State transitions and events for invoke activities and short-lived activities
    The diagram shows the states, the state transitions, and the events that are emitted during the lifetime of an invoke activity or a short-lived activity.
  • Pick (receive choice), wait, and receive activities
    Figure 2. State transitions and events for wait, and receive activities
    The diagram shows the states, the state transitions, and the events that are emitted during the lifetime of pick, wait, and receive activities.
  • Human task activities
    Figure 3. State transitions and events for human task activities
    The diagram shows the states, the state transitions, and the events that are emitted during the lifetime of a human task activity.
  • Structured activities, such as flow or sequence activities
    Figure 4. State transitions and events for structured activities
    The diagram shows the states, the state transitions, and the events that are emitted during the lifetime of a structured activity.

Activity events

The columns in the following table contain:
Code
Contains the number of the event.
Event name
The name of the event.

The following table describes all activity events.

Table 1. Activity events
Code Event name Description
21006 ACTIVITY_READY Activity ready. This event is emitted when a human task activity is started.
21007 ACTIVITY_STARTED Activity started. For invoke activities, a business object payload is available.
21011 ACTIVITY_COMPLETED Activity completed. For invoke, human task, receive, and reply activities, a business object payload is available.
21021 ACTIVITY_CLAIM_CANCELED Claim canceled. This event is emitted when the claim for a human task activity is canceled.
21022 ACTIVITY_CLAIMED Activity claimed. This event is emitted when a human task activity is claimed.
21027 ACTIVITY_TERMINATED Activity terminated. Long-running activities can be terminated as an effect of fault handling on the scope or process the activity is assigned to.
21080 ACTIVITY_FAILED Activity failed. This event is emitted if a fault occurs when the activity runs and the fault is propagated to the fault handlers that are defined for the enclosing scopes or process.
21081 ACTIVITY_EXPIRED Activity expired. This event applies to invoke and human task activities only.
42005 ACTIVITY_SKIPPED Activity skipped. This event applies only to activities that have join behavior defined. If the join behavior evaluates to false, then the activity is skipped and the skipped event is emitted.
42012 ACTIVITY_OUTPUT_MESSAGE_SET Activity output message set. A business object payload is available.

This event is emitted when the output message for a claimed human task activity is set without completing the activity, for example, to store intermediate results. The state of the activity does not change.

This event is not emitted when a human task activity is completed.
42013 ACTIVITY_FAULT_MESSAGE_SET Activity fault message set. Business object payload is available.

This event is emitted when a fault message for a claimed human task activity is set without completing the activity. This event is not emitted when a human task activity is completed with a fault.

42015 ACTIVITY_STOPPED Activity stopped. An activity can be stopped if an unhandled fault occurs when the activity runs.
42031 ACTIVITY_FORCE_RETRIED Activity forcibly retried. To force activities to retry, use Business Process Choreographer Explorer.
42032 ACTIVITY_FORCE_COMPLETED Activity forcibly completed. To force activities to complete use Business Process Choreographer Explorer.
42036 ACTIVITY_MESSAGE_RECEIVED A pick (receive choice) activity has received a message
42037 ACTIVITY_LOOP_CONDITION_TRUE Loop condition true
42038 ACTIVITY_LOOP_CONDITION_FALSE Loop condition false
42039 ACTIVITY_WORKITEM_DELETED Work item deleted. This event applies to pick, human tasks, and receive events only.

This event is emitted only when a work item is explicitly deleted by an API request. If the work item is deleted because the corresponding process instance is deleted, an event is not emitted.
42040 ACTIVITY_WORKITEM_CREATED Work items created. This event applies only to pick, human tasks, and receive events.
42050 ACTIVITY_ESCALATED Activity escalated. This event applies only to pick, human tasks, and receive events when the escalation associated with the human task activity is raised.
42054 ACTIVITY_WORKITEM_REFRESHED Activity work items refreshed. This event applies only to pick, human tasks, and receive events.
42055 ACTIVITY_WORKITEM_TRANSFERRED Work item transferred. This event applies only to pick, human tasks, and receive events.
42057 ACTIVITY_PARALLEL_BRANCHES_STARTED This event is emitted when branches are started for a forEach activity.
42060 ACTIVITY_CUSTOMPROPERTY_SET This event is emitted when a custom property of an activity instance is changed.
42061 ACTIVITY_BRANCH_CONDITION_TRUE This event is emitted when the case condition of a choice activity evaluates to true. There is, at most, one event with the case element condition set to true for each navigated choice activity instance. That is, non-entered case elements are not honored by an event, and otherwise elements provoke the same event as condition case elements.
42062 ACTIVITY_ALL_BRANCH_CONDITIONS_FALSE This event is emitted when no case element was used and no otherwise element exists. In this case, the navigation continues at the end of the choice construct.
42063 ACTIVITY_JUMPED This event is emitted after the final activity event of the source activity of the jump action and before the first event of the target activity.
42064 ACTIVITY_SKIP_REQUESTED Skip activity requested. This event is emitted if the corresponding activity is not in an active state and a skip or cancelSkipRequest API is called. In this case, the request has no immediate effect on the navigation. The event contains a flag to distinguish between a skip and a cancelSkipRequest call.

The ECSCurrentID for the event to be skipped is not set to the AIID of the associated activity.
42065 ACTIVITY_SKIPPED_ON_REQUEST Event skipped on request. This event is emitted when the navigation after an activity that is marked for skipping is continued.
42069 ACTIVITY_TIMER_RESCHEDULED This event is emitted when a rescheduleTimer request is processed. This event can be produced for wait, human task, invoke, and pick activities.
42070 ACTIVITY_SKIPPED_ON_EXIT_CONDITION This event is emitted when an exit condition of the onEntry type evaluates to true, and the activity is skipped for this reason.
42072 ACTIVITY_CHILD_PROCESS_TERMINATING This event is emitted if the corresponding activity is an invoke activity in the running state, has a child process, and the forceRetry, forceComplete, or skip API is called or the activity expires.
42073 ACTIVITY_CONDITION_FORCED An activity that has stopped because of an error evaluating a join condition was forced to continue navigating.
42074 ACTIVITY_LOOP_CONDITION_FORCED An activity that has stopped because of an error evaluating a repeat-until or while loop condition was forced to continue navigating.
42075 ACTIVITY_FOR_EACH_COUNTERS_FORCED An activity that has stopped because of an error evaluating a for-each loop condition was forced to continue navigating.