Engine events

The engine events are sent to the Spring Cloud Stream destination engineEvents in the application runtime bundle in JSON format.

Properties

All events have a common set of Activiti Cloud API properties defined in org.activiti.cloud.api.model.shared.events.CloudRuntimeEvent:

NameDescriptionTypeExample
appNameThe name of an application. In the runtime bundle this is the value of the activiti.cloud.application.name spring propertyStringmy-application-name
appVersionThe version number of an application. In the runtime bundle this is the value of the activiti.cloud.application.version spring propertyString1
serviceNameThe name of the service in an application. In the application runtime bundle this is the value of the spring.application.name spring propertyStringrb-my-application-name
serviceFullNameThe full name of the service in an application. This is the same as serviceNameStringrb-my-application-name
serviceTypeThe type of service. In the application runtime bundle this is the value of the activiti.cloud.service.type spring propertyStringruntime-bundle
serviceVersionThe version of the service. In the runtime bundle this is the value of the activiti.cloud.service.version spring propertyString
messageIdThe ID of the message that carried the event. All events that are part of the same transaction are aggregated into the same messageString
sequenceNumberThe sequence index of an event within a messageString
entityIdThe ID of an entity included in a messagestring

All events also have a common set of Activiti Core API properties defined in org.activiti.api.model.shared.event.RuntimeEvent:

NameDescriptionTypeExample
idThe event IDString
entityThe entity included in the messageObject
timestampThe timestamp of the event
eventTypeThe type of eventString
processInstanceIdThe process instance IDString
parentProcessInstanceIdThe parent process instance ID if one existsString
processDefinitionIdThe process definition IDString
processDefinitionKeyThe process definition keyString
processDefinitionVersionThe version of the process definitionString
businessKeyThe business key associated to the process instance if one existsString

Event Types

An enumeration is available for all the Cloud events: org.activiti.cloud.api.process.events.CloudRuntimeEventType

The following table describes all available engine events with their associated class and a JSON schema of their contents:

Note: The JSON schema files were generated using JsonSchemaGeneratorTest.

NameDescriptionClassJSON schema
ACTIVITY_STARTEDAn activity is starting to execute. This event is sent just before an activity is executedorg.activiti.cloud.api.process.model.events.CloudBPMNActivityStartedEventACTIVITY_STARTED
ACTIVITY_CANCELLEDAn activity has been cancelledorg.activiti.cloud.api.process.model.events.CloudBPMNActivityCancelledEventACTIVITY_CANCELLED
ACTIVITY_COMPLETEDAn activity has been completedorg.activiti.cloud.api.process.model.events.CloudBPMNActivityCompletedEventACTIVITY_COMPLETED
ERROR_RECEIVEDAn activity has received an error eventorg.activiti.cloud.api.process.model.events.CloudBPMNErrorReceivedEventERROR_RECEIVED
SIGNAL_RECEIVEDAn activity has received a signalorg.activiti.cloud.api.process.model.events.CloudBPMNSignalReceivedEventSIGNAL_RECEIVED
TIMER_FIREDA timer has been fired. It will be followed by either a TIMER_EXECUTED or TIMER_FAILED eventorg.activiti.cloud.api.process.model.events.CloudBPMNTimerFiredEventTIMER_FIRED
TIMER_CANCELLEDA timer has been cancelled, for example if a task was completed before the timer expiredorg.activiti.cloud.api.process.model.events.CloudBPMNTimerCancelledEventTIMER_CANCELLED
TIMER_SCHEDULEDA timer has been scheduledorg.activiti.cloud.api.process.model.events.CloudBPMNTimerScheduledEventTIMER_SCHEDULED
TIMER_EXECUTEDA timer has executedorg.activiti.cloud.api.process.model.events.CloudBPMNTimerExecutedEventTIMER_EXECUTED
TIMER_FAILEDA timer failed to fireorg.activiti.cloud.api.process.model.events.CloudBPMNTimerFailedEventTIMER_FAILED
TIMER_RETRIES_DECREMENTEDThe retry count for a timer has been decreasedorg.activiti.cloud.api.process.model.events.CloudBPMNTimerRetriesDecrementedEventTIMER_RETRIES_DECREMENTED
MESSAGE_WAITINGA message catch event is waiting to receive a messageorg.activiti.cloud.api.process.model.events.CloudBPMNMessageWaitingEventMESSAGE_WAITING
MESSAGE_RECEIVEDAn activity received a messageorg.activiti.cloud.api.process.model.events.CloudBPMNMessageReceivedEventMESSAGE_RECEIVED
MESSAGE_SENTA message throw event has sent a messageorg.activiti.cloud.api.process.model.events.CloudBPMNMessageSentEventMESSAGE_SENT
INTEGRATION_REQUESTEDThe application runtime bundle has sent a request to a connectororg.activiti.cloud.api.process.model.events.CloudIntegrationRequestedEventINTEGRATION_REQUESTED
INTEGRATION_RESULT_RECEIVEDThe application runtime bundle has received a result from a connectororg.activiti.cloud.api.process.model.events.CloudIntegrationResultReceivedEventINTEGRATION_RESULT_RECEIVED
PROCESS_DEPLOYEDA new process definition is available. These events are sent when the application runtime bundle first starts and on any restartsorg.activiti.cloud.api.process.model.events.CloudProcessDeployedEventPROCESS_DEPLOYED
PROCESS_CREATEDA process instance has been createdorg.activiti.cloud.api.process.model.events.CloudProcessCreatedEventPROCESS_CREATED
PROCESS_STARTEDA process instance has been startedorg.activiti.cloud.api.process.model.events.CloudProcessStartedEventPROCESS_STARTED
PROCESS_COMPLETEDA process instance has been completed. This event is sent after the final ACTIVITY_COMPLETED event is sentorg.activiti.cloud.api.process.model.events.CloudProcessCompletedEventPROCESS_COMPLETED
PROCESS_CANCELLEDA process instance has been cancelledorg.activiti.cloud.api.process.model.events.CloudProcessCancelledEventPROCESS_CANCELLED
PROCESS_SUSPENDEDA process instance has been suspendedorg.activiti.cloud.api.process.model.events.CloudProcessSuspendedEventPROCESS_SUSPENDED
PROCESS_RESUMEDA previously suspended process instance has been resumedorg.activiti.cloud.api.process.model.events.CloudProcessResumedEventPROCESS_RESUMED
PROCESS_UPDATEDA process instance has been updatedorg.activiti.cloud.api.process.model.events.CloudProcessUpdatedEventPROCESS_UPDATED
SEQUENCE_FLOW_TAKENA sequence flow between two activities has been takenorg.activiti.cloud.api.process.model.events.CloudSequenceFlowTakenEventSEQUENCE_FLOW_TAKEN
START_MESSAGE_DEPLOYEDA start message event is waiting to catch a message. Similar to MESSAGE_WAITING but specific to start message eventsorg.activiti.cloud.api.process.model.events.CloudStartMessageDeployedEventSTART_MESSAGE_DEPLOYED
MESSAGE_SUBSCRIPTION_CANCELLEDA message event subscription entity has been deleted. For example, if a process instance is deleted that had an active catch message event activityorg.activiti.cloud.api.process.model.events.CloudMessageSubscriptionCancelledEventMESSAGE_SUBSCRIPTION_CANCELLED
TASK_CREATEDA task has been created. Note: Service tasks do not emit a TASK_CREATED event. The INTEGRATION_REQUESTED event should be monitored to report or track service tasks.org.activiti.cloud.api.task.model.events.CloudTaskCreatedEventTASK_CREATED
TASK_UPDATEDA task has been updatedorg.activiti.cloud.api.task.model.events.CloudTaskUpdatedEventTASK_UPDATED
TASK_ASSIGNEDA task has been assignedorg.activiti.cloud.api.task.model.events.CloudTaskAssignedEventTASK_ASSIGNED
TASK_COMPLETEDA task has been completed. Note: Service tasks do not emit a TASK_COMPLETED event. The INTEGRATION_RESULT_RECEIVED event should be monitored to report or track service tasks.org.activiti.cloud.api.task.model.events.CloudTaskCompletedEventTASK_COMPLETED
TASK_SUSPENDEDA task has been suspendedorg.activiti.cloud.api.task.model.events.CloudTaskSuspendedEventTASK_SUSPENDED
TASK_ACTIVATEDA previously suspended task has been reactivatedorg.activiti.cloud.api.task.model.events.CloudTaskActivatedEventTASK_ACTIVATED
TASK_CANCELLEDA task has been cancelledorg.activiti.cloud.api.task.model.events.CloudTaskCancelledEventTASK_CANCELLED
TASK_CANDIDATE_USER_ADDEDA user has been added to the list of candidates for a taskorg.activiti.cloud.api.task.model.events.CloudTaskCandidateUserAddedEventTASK_CANDIDATE_USER_ADDED
TASK_CANDIDATE_USER_REMOVEDA user has been removed from the list of candidates for a taskorg.activiti.cloud.api.task.model.events.CloudTaskCandidateUserRemovedEventTASK_CANDIDATE_USER_REMOVED
TASK_CANDIDATE_GROUP_ADDEDA group has been added to the list of candidates for a taskorg.activiti.cloud.api.task.model.events.CloudTaskCandidateGroupAddedEventTASK_CANDIDATE_GROUP_ADDED
TASK_CANDIDATE_GROUP_REMOVEDA group has been removed from the list of candidates for a taskorg.activiti.cloud.api.task.model.events.CloudTaskCandidateGroupRemovedEventTASK_CANDIDATE_GROUP_REMOVED
VARIABLE_CREATEDA variable has been createdorg.activiti.cloud.api.shared.model.events.CloudVariableCreatedEventVARIABLE_CREATED
VARIABLE_UPDATEDA variable has been updatedorg.activiti.cloud.api.shared.model.events.CloudVariableUpdatedEventVARIABLE_UPDATED
VARIABLE_DELETEDA variable has been deletedorg.activiti.cloud.api.shared.model.events.CloudVariableDeletedEventVARIABLE_DELETED

© 2023 Alfresco Software, Inc. All Rights Reserved.