Case raw event formats

Raw events for IBM® Case Manager cases, activities, compound activities, stages, documents, case comments, activity comments, step comments, document comments, and Case Content Cortex processes (workflow and workitem). These raw events are JSON objects with attributes.

Notation and examples

The Case event emitter also processes stage events.

The Case event emitter also processes Content Cortex Process Engine workflows and workitems.

The dot notation indicates nested fields. For example, context.trace-id means the trace-id fields within the context JSON object.

Code samples are provided in Examples of raw event attributes.

Common attributes
Kafka output
Context attributes
User attributes
Data attributes
System attributes
Source attributes

Common attributes

Table 1. Common attributes
Event part	Description	Optional or required	Type
business-events-envelope-version	The source of the event that defines the event format	Required	The `"1.0.1"` string
business-events-extension-version	The extension and the version of extension that defines the event format	Required	The `"icm/1.0.0"` string
id	The event identifier	Required	String
timestamp	The timestamp of this event	Required	A string that contains an ISO8601 date.
category	The category of this event that indicates the object on which the event occurred.	Required	String Typical value: `icm:<name object with “Event” suffix>` Example: `icm:CaseEvent`, `icm:TaskEvent` See the list of values in Valid string values for the category attribute of Case and Case Content Cortex process events.
type	Indicates which event action was performed on the event.	Required	String Typical value: `icm:<name object with "Event" suffix>:<object state>` Examples: `icm:CaseEvent: Initializing`, `icm:TaskEvent: Complete` See the list of values in Valid string values for the type attribute of Case and Case Content Cortex process events.

Kafka output

Table 2. Kafka output attributes
Event part	Description	Optional or required	Type
kafka	Information about the event stored inside Kafka	Optional	JSON object
kafka.key	The key used for storing the event within Kafka	Optional	String

Context attributes

Context information is not available for Case processes from Content Cortex.

Table 3. context attributes
Event part	Description	Optional or required	Type
context	The correlation information	Required	JSON object
context.trace-id	The trace identifier	Required	String
context.span-id	The span identifier	Required	String
context.parent-span-id	The parent span identifier	Optional. Not present if the Case process is a top-level one.	String

User attributes

Table 4. user attributes
Event part	Description	Optional or required	Type
user	Information about the user who acted on the event	Required	JSON object
user.id	The identifier of the user who acted on the event, typically the `Creator` field on the audit event	Required	String

Data attributes

Table 5. data attributes
Event part	Description	Optional or required	Type
data	The data pertaining to the audited property	Optional	JSON object
data.icm	Case-specific information about the audited data	Required	JSON object
data.icm.xx	`xx` is the name of the audited property	Optional	A String, Number, Boolean, or `null`, depending on the type of the audited property

System attributes

Table 6. system attributes
Event part	Description	Optional or required	Type
system	Information about the system that generated the event	Required	JSON object
sytem.id	The identifier of the system that generated this event	Required	String
system.icm	IBM Business Automation Insights-specific information about the system	Required	JSON object
system.icm.content-engine-server	The Content Platform Engine server to which the emitter connects	Required	String
system.icm.emitter-logical-unique-id	The logical unique identifier of the case event emitter that emitted the event	Required	String
system.icm.object-store-display-name	The display name of the object store to which the event belongs	Required	String
system.icm.object-store-symbolic-name	The symbolic name of the object store to which the event belongs	Required	String
system.icm.object-store-id	The identifier of the object store to which the event belongs	Required	String
system.icm.p8-domain-name	The name of the P8 domain to which the object store belongs, from where the event is emitted	Required	String
system.icm.p8-domain-id	The identifier of the P8 domain to which the object store belongs, from where the event is emitted	Required	String

Source attributes

source: general

Table 7. source attributes
Event part	Description	Optional or required	Type
source	Information about the source that generated this event	Required	JSON object
source.type	The type of source that generated this event	Required	String Valid values: `case`, `task`, `stage`, `workflow`, `workitem`, `document`, `case-comment`, `task-comment`, `step-comment`, `document-comment`
source.id	The identifier of the source that generated this event	Required	String
source.name	The name of the type of source that generated this event. Applies only to case and activity events.	Required	String
source.icm	IBM Business Automation Workflow-specific information about the case or activity or document or comment hierarchy.	Required	JSON object
source.icm.audit-sequence	The audit sequence of the generated event. This sequence is unique for each event.	Required	Number
source.icm.state	The state of the object when the event occurred.	Required	String See the list of values in Valid values for the source.icm.state attribute.
source.icm.case-health	The current case health status. Applies only if case health is enabled.	Optional	String Possible values: `Good Health`, `Warning`, `Poor Health`, `No Health`.
source.icm.case-folder-id	The identifier of the case folder the object belongs to.	Required	String
source.icm.case-id	The identifier of the case instance to which the object belongs.	Required	String
source.icm.case-type-display-name	The display name of the case type to which the object belongs	Required	String
source.icm.task-type-display-name	The name of the activity type to which the object belongs. Applies only to activity events.	Required	String
source.icm.is-task-todo	Indicates whether the case activity is a To-Do activity.	Optional	Boolean
source.icm.is-task-quick	Indicates whether the case activity is a Quick Task.	Optional	Boolean
source.icm.task-deadline-time	The deadline time of a quick task case activity.	Optional	String String that contains an ISO8601 date.
source.icm.class-id	The identifier of the class of the object on which the event occurred	Required	String
source.icm.source-class-display-name	The display name of the class of the object on which the event occurred	Required	String
source.icm.solution.name	The name of the solution to which the object belongs	Required	String
source.icm.case-type-id	The identifier of the case type to which the object belongs	Required	String
source.icm.case-type-name	The name of the case type to which the object belongs	Required	String
source.icm.case-start-time	The timestamp when the case starts	Optional	A string that contains an ISO8601 date
source.icm.task-start-time	The timestamp when the task starts	Optional	A string that contains an ISO8601 date
source.icm.stage-restart-time	The timestamp when the stage was restarted last time	Optional	A string that contains an ISO8601 date
source.icm.case-instance-id	The identifier of the case instance to which the object belongs	Required	String
source.icm.case-instance-name	The name of the case instance to which the object belongs	Required	String
source.icm.case-version	The version number of this particular event on the case (internal). This field refers to the `CreatedDate` value on the audit event and applies only to case events.	Optional	String
source.icm.is-task-container	Specifies whether the object on which the event occurred is a container activity. Applies only to activity events and compound activity events.	Optional	Boolean
source.icm.document-version-series-id	The identifier of the version series of the document on which the event occurred. Applies only to document events.	Optional	String
source.icm.document-current-version-id	The identifier of the document on which the event occurred. Applies only to document events.	Optional	String
source.icm.comment-text	The text provided as comments. Applies only to comment events.	Optional	String
source.icm.comment-version	Information that describes the version of the comment (internal only). Applies only to comment events and refers to the `CreatedDate` value on the audit event.	Optional	String
source.icm.comment-id	The identifier of the comment object	Optional	String
source.icm.step-name	Identifies the step name. Applies only to step-comment events.	Optional	String
source.icm.workflow-number	Identifies the workflow number (Process Engine). Applies only to step-comment events.	Optional	String
source.icm.work-class-name	The name of the WorkClass (Process Engine). Applies only to step-comment events.	Optional	String
source.icm.step-id	The step identifier. Applies only to step-comment events.	Optional	String
source.icm.step-id	The step identifier. Applies only to step-comment events.	Optional	String
source.icm.case-stage	Indicates the current stage of the case	Optional	String

source.instance

Table 8. source.instance attributes
Event part	Description	Optional or required	Type
source.instance	IBM Business Automation Workflow specific information about the current case, activity, document, or comment	Required	JSON object
source.instance.id	The identifier of the instance on which the event occurred. If the instance is an event on the case, this is the identifier of the case instance. If the instance is an event on the activity, this is the identifier of the activity instance, and so on.	Required	String
source.instance.name	The name of the instance of the object on which the event occurred.	Required	String

source.parent

Table 9. source.parent attributes
Event part	Description	Optional or required	Type
source.parent	Information about the activity, document, or comment parent in the hierarchy. Not applicable to case events.	Required	JSON object
source.parent.type	The type of the parent	Required	String
source.parent.id	The identifier of the parent	Required	String
source.parent.name	The name of the parent	Required	String
source.parent.instance	Information about the instance of the parent in the hierarchy	Required	JSON object
source.parent.instance.id	The identifier of the instance of the parent in the hierarchy	Required	String
source.parent.instance.name	The name of the instance of the parent in the hierarchy	Required	String
source.parent.parent	The parent of the subactivity in the hierarchy. This is a recursive scheme up to the case that is the topmost parent in the hierarchy. Each parent object can have the same attributes as the attributes in source.parent	Optional	JSON object

source: Content Cortex PE workflow and workitem events

These attributes are required only for workflow and workitem events.

Table 10. `source` attributes for Content Cortex process workflow and workitem events
Event part	Description	Type
source.icm.joint-type	The status of the step if it is a joint step or normal step.	Number
source.icm.split-type	The status of the step if it is a split step or normal step.	Number
source.icm.step-type	The status of the step if it is a normal or compound step.	String
source.icm.route-count	The number of routes at that step.	Double
source.icm.destination-step-id	The identifier of the first destination step.	Double
source.icm.destination-step-name	The name of the first destination step.	String
source.icm.originator-id	The identifier of the originator.	Double
source.icm.originator-user-name	The name of the originator.	String
source.icm.user-id	The identifier of the user that performs the operation.	Double
source.icm.user-name	The name of the user that performs the operation.	String
source.icm.bound-user-id	The identifier of the bound user.	Double
source.icm.workflow-id	The identifier of the workflow the event belongs to.	String
source.icm.workitem-id	The identifier of the workitem the event belongs to.	String
source.icm.is-dynamic-workflow	Whether the workflow is dynamic or not.	Boolean
source.icm.workclass-id	The identifier of the class of the workflow.	Double
source.icm.workclass-revision-id	The identifier of the version of the workclass the workflow is created with.	Double
source.icm.task-id	The identifier of the case activity that is related to this workflow.	String
source.icm.operation-id	The identifier of the operation that it is performing in a queue.	Double
source.icm.queue-name	The name of the queue the workitem resides in.	String
source.icm.operation-name	The name of the operation the workitem needs to perform.	String
source.icm.workflow-name	The name of the workflow	String
source.icm.map-name	The name of the map.	String
source.icm.event-log-name	The name of the Process Engine event log in which the event was generated.	Number
source.icm.region-number	The Process Engine isolated region number that the workflow or workitem belongs to.	Double
source.icm.event-type	The type of the Process Engine event.	Double
source.icm.duration	The time spent by the workflow or workitem which is recorded from the event.	Double
source.icm.occurrence-id	The identifier of the event occurrence.	Double
source.icm.server-sequence-id	The server sequence identifier of the Process Engine.	Double
source.icm.sequence-number	The server sequence identifier of the Process Engine.	Double
source.icm.queue-id	The identifier of the queue in which the workitem is placed.	Double
source.icm.map-id	The identifier of the map of the workflow	Double
source.icm.workflow-number	The identifier of the workflow the event belongs to.	String
source.icm.wob-number	The identifier of the workitem the event belongs to.	String

Valid `string` values for the category attribute of Case and Case Content Cortex process events

This attribute can also take values for StageEvent, WorkflowEvent, and WorkitemEvent.

"icm:CaseEvent"
"icm:TaskEvent"
"icm:StageEvent"
"icm:CompoundTaskEvent"
"icm:DocumentEvent"
"icm:CaseCommentEvent"
"icm:TaskCommentEvent"
"icm:StepCommentEvent"
"icm:DocumentCommentEvent"
"icm:WorkflowEvent"
"icm:WorkitemEvent"

Valid `string` values for the type attribute of Case and Case Content Cortex process events