Skip to content
This repository has been archived by the owner on Feb 26, 2020. It is now read-only.

Activiti Cloud Native APIs & Shared Models

License

Notifications You must be signed in to change notification settings

AlfrescoArchive/activiti-cloud-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

activiti-cloud-api

Activiti Cloud Native APIs & Shared Models.

Cloud Runtime Events

These events are sent to the engineEvents Spring Cloud Stream destination in the runtime-bundle microservice in JSON format.

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

Name Description Type Example
appName Application name, for a runtime bundle it is the value of the activiti.cloud.application.name spring property. string myapp
appVersion Application version, for a runtime-bundle it is the value of the activiti.cloud.application.version spring property. string 1
serviceName Service name, for a runtime-bundle it is the value of the spring.application.name spring property. string rb-myapp
serviceFullName Service full name, at the moment it is the same as serviceName. string rb-myapp
serviceType Service type, for a runtime-bundle it is the value of the activiti.cloud.service.type spring property. string runtime-bundle
serviceVersion Service version, for a runtime-bundle it is the value of the activiti.cloud.service.version spring property. string
sequenceNumber Sequence index of the event if it is part of an aggregate within the message if part of the same transaction.
messageId ID of the message that carried the event, all the events that are part of the same tx are aggregated in the same message. string
entityId ID of the entity included in the message. string

Plus the following common Activiti Core API properties defined in org.activiti.api.model.shared.event.RuntimeEvent

Name Description Type Example
id event ID
entity The entity included in the message object
timestamp event timestamp
eventType event type string
processInstanceId
parentProcessInstanceId
processDefinitionId
processDefinitionKey
processDefinitionVersion
businessKey

Cloud Event Types

The following list shows all available cloud event types.

Most of the event types are the same as in the original enum from the internal deprecated old API in Activiti Core, so the same description still applies: org.activiti.engine.delegate.event.ActivitiEventType.

A new enum is available for all the Cloud events: org.activiti.cloud.api.process.events.CloudRuntimeEventType

Name Description Class
ACTIVITY_STARTED org.activiti.cloud.api.process.model.events.CloudBPMNActivityStartedEvent
ACTIVITY_CANCELLED org.activiti.cloud.api.process.model.events.CloudBPMNActivityCancelledEvent
ACTIVITY_COMPLETED org.activiti.cloud.api.process.model.events.CloudBPMNActivityCompletedEvent
ERROR_RECEIVED org.activiti.cloud.api.process.model.events.CloudBPMNErrorReceivedEvent
SIGNAL_RECEIVED org.activiti.cloud.api.process.model.events.CloudBPMNSignalReceivedEvent
TIMER_FIRED org.activiti.cloud.api.process.model.events.CloudBPMNTimerFiredEvent
TIMER_CANCELLED org.activiti.cloud.api.process.model.events.CloudBPMNTimerCancelledEvent
TIMER_SCHEDULED org.activiti.cloud.api.process.model.events.CloudBPMNTimerScheduledEvent
TIMER_EXECUTED org.activiti.cloud.api.process.model.events.CloudBPMNTimerExecutedEvent
TIMER_FAILED org.activiti.cloud.api.process.model.events.CloudBPMNTimerFailedEvent
TIMER_RETRIES_DECREMENTED org.activiti.cloud.api.process.model.events.CloudBPMNTimerRetriesDecrementedEvent
MESSAGE_WAITING The process reached a message catch event and is listening for a BPMN message, see ACTIVITY_MESSAGE_WAITING org.activiti.cloud.api.process.model.events.CloudBPMNMessageWaitingEvent
MESSAGE_RECEIVED see ACTIVITY_MESSAGE_RECEIVED org.activiti.cloud.api.process.model.events.CloudBPMNMessageReceivedEvent
MESSAGE_SENT see ACTIVITY_MESSAGE_SENT org.activiti.cloud.api.process.model.events.CloudBPMNMessageSentEvent
INTEGRATION_REQUESTED the runtime bundle has sent a request to a cloud connector org.activiti.cloud.api.process.model.events.CloudIntegrationRequestedEvent
INTEGRATION_RESULT_RECEIVED the runtime bundle has received a result from a cloud connector org.activiti.cloud.api.process.model.events.CloudIntegrationResultReceivedEvent
PROCESS_DEPLOYED org.activiti.cloud.api.process.model.events.CloudProcessDeployedEvent
PROCESS_CREATED org.activiti.cloud.api.process.model.events.CloudProcessCreatedEvent
PROCESS_STARTED org.activiti.cloud.api.process.model.events.CloudProcessStartedEvent
PROCESS_COMPLETED org.activiti.cloud.api.process.model.events.CloudProcessCompletedEvent
PROCESS_CANCELLED org.activiti.cloud.api.process.model.events.CloudProcessCancelledEvent
PROCESS_SUSPENDED org.activiti.cloud.api.process.model.events.CloudProcessSuspendedEvent
PROCESS_RESUMED org.activiti.cloud.api.process.model.events.CloudProcessResumedEvent
PROCESS_UPDATED org.activiti.cloud.api.process.model.events.CloudProcessUpdatedEvent
SEQUENCE_FLOW_TAKEN org.activiti.cloud.api.process.model.events.CloudSequenceFlowTakenEvent
START_MESSAGE_DEPLOYED Similar to MESSAGE_WAITING, but for start message events. org.activiti.cloud.api.process.model.events.CloudStartMessageDeployedEvent
MESSAGE_SUBSCRIPTION_CANCELLED A message event subscription entity being deleted, i.e. when a running process is deleted with an active catch message event activity or after a catch message event activity triggered by corresponding throw message. org.activiti.cloud.api.process.model.events.CloudMessageSubscriptionCancelledEvent
TASK_CREATED org.activiti.cloud.api.process.model.events.CloudTaskCreatedEvent
TASK_UPDATED org.activiti.cloud.api.process.model.events.CloudTaskUpdatedEvent
TASK_ASSIGNED org.activiti.cloud.api.process.model.events.CloudTaskAssignedEvent
TASK_COMPLETED org.activiti.cloud.api.process.model.events.CloudTaskCompletedEvent
TASK_SUSPENDED org.activiti.cloud.api.process.model.events.CloudTaskSuspendedEvent
TASK_ACTIVATED org.activiti.cloud.api.process.model.events.CloudTaskActivatedEvent
TASK_CANCELLED org.activiti.cloud.api.process.model.events.CloudTaskCancelledEvent
TASK_CANDIDATE_USER_ADDED org.activiti.cloud.api.process.model.events.CloudTaskCandidateUserAddedEvent
TASK_CANDIDATE_USER_REMOVED org.activiti.cloud.api.process.model.events.CloudTaskCandidateUserRemovedEvent
TASK_CANDIDATE_GROUP_ADDED org.activiti.cloud.api.process.model.events.CloudTaskCandidateGroupAddedEvent
TASK_CANDIDATE_GROUP_REMOVED org.activiti.cloud.api.process.model.events.CloudTaskCandidateGroupRemovedEvent
VARIABLE_CREATED org.activiti.cloud.api.process.model.events.CloudVariableCreatedEvent
VARIABLE_UPDATED org.activiti.cloud.api.process.model.events.CloudVariableUpdatedEvent
VARIABLE_DELETED org.activiti.cloud.api.process.model.events.CloudVariableDeletedEvent

JSON Schema

For a detailed view of event contents refer to the Activiti Cloud Events JSON schemas. NB these schema files are generated running the test JsonSchemaGeneratorTest.