Activiti Cloud Native APIs & Shared Models.
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 |
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
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.