Shared fields

Draft comment:
This topic is shared by BAW, CP4BA. Last updated on 2025-03-13 12:15
Some fields are common to all types of time series, as described in the table.

The Case event emitter also processes FileNet® Process Engine workflows and workitems. Workflow and workitem events have no context information.

Table 1. Shared fields
Attribute Description Optional or required Type
id The identifier of the time series event. It matches the id attribute of the corresponding raw event. Required String
offset The Kafka message offset Required Number
partition The Kafka message partition Required Number
version The document version of the time series event Required A string constant with value of "1.0.0"
type The type of the event Required String constant

Typical values: "case", "task", "document"

timestamp The timestamp of the corresponding raw event Required A string containing an ISO8601 date.
case-instance-id The identifier of the case instance Required String
state The state of the case event Required A string constant.

Possible values: New, Initializing, Working, Complete, FailedFor a detailed list, see Case raw event formats

audit-sequence The audit sequence of the corresponding raw event Required Number
case-folder-id The identifier of the case folder Required String
source-class-id The identifier of the source class of case Required String
source-class-display-name The display name of the source class of case Required String
case-type-name The name of the case type Required String
case-type-display-name The display name of the case type Required String
solution-name The name of the solution to which the case belongs Required String
category The category of the event Required The string constant "icm"
user The creator of the raw event Required String
data The business data. Present only if case properties are audited. Optional JSON object
Table 2. Context-related shared fields
Event part Description Optional or required Type
trace-id The trace identifier. Required if the trace-id and span-id values are set in the raw event context. Conditionally required String
span-id The span identifier. Required if the trace-id and span-id values are set in the raw event context. Conditionally required String
parent-span-id The identifier of the parent span Optional String
icm.sytem.id The source of events Required String
content-engine-server The Content Platform Engine server to which the emitter connects Required String
emitter-logical-unique-id The logical unique identifier of the case event emitter that emitted the event Required String
object-store-display-name The display name of the object store to which the event belongs Required String
object-store-symbolic-name The symbolic name of the object store to which the event belongs Required String
object-store-id The identifier of the object store to which the event belongs Required String
p8-domain-name The name of the P8 domain to which the object store belongs, from where the event is emitted Required String
p8-domain-id The identifier of the P8 domain to which the object store belongs, from where the event is emitted Required String