Overview
CPS-1628 - Getting issue details... STATUS
- This page gives a description of CPS events including their fields
- Events will be split into events and Kafka headers
Events
| # | Description | Source | Status | Notes |
|---|---|---|---|---|
| 1 | LCM Event | NCMP | In Use | |
| 2 | AVC Event | NCMP | In Use | |
| 3 | AVC Subscription Event | NCMP | Implemented | |
| 4 | DMI Async Request Response Event | NCMP | Implemented | |
| 5 | NCMP Async Request Response Event | NCMP | Implemented | |
| 6 | Bulk Response Event | NCMP | In Progress | |
| 7 | Bulk Response Client Topic Event | NCMP | In Progress |
LCM Event
Description
LCM (Life Cycle Management) Event
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
| LCM Event | object | The payload for LCM event | X | Defined by LCM event object below |
LCM Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event | X | ||
| eventCorrelationId | string | The id identifying the event | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventSource | string | The source of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The schema that this event adheres to | X | ||
| eventSchemaVersion | string | The version of the schema that this event adheres to | X | ||
| event | object | The payload of an event | X | Defined by event object below |
Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| cmHandleId | string | cmHandle id | X | ||
| oldValues | object | Values that represents the state of a cmHandle | X | Defined by values object below | |
| newValues | object | Values that represents the state of a cmHandle | X | Defined by values object below |
Values Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| dataSyncEnabled | string | cmHandle id | X | ||
| cmHandleState | string | State of cmHandle | X | Enum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"] | |
| cmHandleProperties | object | cmHandle properties | X | List of Java <String, String> Maps |
AVC Event
Description
AVC Event
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
| AVC Event | object | The payload for AVC event | X | Defined by AVC event object below |
AVC Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event | X | ||
| eventCorrelationId | string | The id identifying the event | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventSource | string | The source of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The schema that this event adheres to | X | ||
| eventSchemaVersion | string | The version of the schema that this event adheres to | X | ||
| event | object | The payload of an event | X | java object not defined by schema |
AVC Subscription Event
Description
AVC Subscription Event
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
| Subscription Event | object | The payload for avc subscription event | X | Defined by Subscription event object below |
Subscription Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| version | string | The event type version | X | ||
| eventType | object | The event type | X | Enum: ["CREATE"] | |
| event | object | The payload for an event | X | Defined by event object below |
Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| subscription | object | The subscription details | X | Defined by subscription object below | |
| dataType | object | The datatype content | X | Defined by dataType object below | |
| predicates | object | Additional values to be added into the subscription | X | Defined by predicates object below |
Subscription Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| clientID | string | The client ID | X | ||
| name | string | The name of the subscription | X | ||
| isTagged | boolean | optional parameter, default is false | X | default: false |
DataType Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| dataspace | string | The dataspace name | X | ||
| dataCategory | string | The category type of the data | X | ||
| dataProvider | string | The provider name of the data | X | ||
| schemaName | string | The name of the schema | X | ||
| schemaVersion | string | The version of the schema | X |
Predicates Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| targets | array | CM Handles to be targeted by the subscription | X | ||
| datastore | string | datastore which is to be used by the subscription | X | ||
| xpath-filter | string | filter to be applied to the CM Handles through this event | X |
DMI Async Request Response Event
Description
DMI Asynchronous Request Response Event
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
DmiAsyncRequestResponse Event | object | The payload for DmiAsyncRequestResponse event | X | Defined by DmiAsyncRequestResponse event object below |
DmiAsyncRequestResponse Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventTarget | string | The target of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSchemaVersion | string | The event schema version for async request response events | X | ||
| eventSource | string | The source of the event | |||
| eventContent | object | The payload of an event | X | Defined by eventContent object below |
EventContent Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| repsonse-data-schema | string | The schema of response data | X | ||
| response-status | string | The status of the response | X | ||
| response-code | string | The code of the response | X | ||
| response-data | object | The data payload | X | contains payload of type object |
NCMP Async Request Response Event
Description
NCMP Asynchronous Request Response Event
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
NcmpAsyncRequestResponse Event | object | The payload for NcmpAsyncRequestResponse event | X | Defined by NcmpAsyncRequestResponse event object below |
NcmpAsyncRequestResponse Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventTarget | string | The target of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSchemaVersion | string | The event schema version for async request response events | X | ||
| event | object | The payload of an event | Defined by event object below | ||
| forwardedEvent | object | The payload of a forwarded event | X | Defined by forwardedEvent object below |
Event Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventTarget | string | The target of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSource | string | The source of the event | X | ||
| response-data-schema | string | The received schema of response data | X | ||
| response-status | string | The received status of the response | X | ||
| response-code | string | The received code of the response | X | ||
| response-data | object | The data payload | X | contains payload of type object |
forwardedEvent Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventTarget | string | The target of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSchemaVersion | string | The event schema version for async request response events | X | ||
| eventSource | string | The source of the event | X | ||
| response-data-schema | string | The received schema of response data | X | ||
| response-status | string | The received status of the response | X | ||
| response-code | string | The received code of the response | X | ||
| response-data | object | The data payload | X | contains payload of type object |
Bulk Response Event
Description
Bulk Response Event, uses event target for topic
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
| BulkResponseEvent | object | The payload for BulkResponse event | X | Defined by BulkResponse event object below |
BulkResponseEvent Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSchemaVersion | string | The event schema version for async request response events | X | ||
| event | object | The payload of an event | java object not defined by schema |
Bulk Response Event - Client Topic
Description
Bulk Response Event, uses client defined topic
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| $schema | JSON schema definition | X | |||
| $id | schema id | X | |||
| $ref | schema | X | |||
| definitions | outline schema | ||||
| BulkResponseEvent | object | The payload for BulkResponse event | X | Defined by BulkResponse event object below |
BulkResponseEvent Object
| Field | Type | Description | Kafka Header | JSON Field | Notes |
|---|---|---|---|---|---|
| eventID | string | The unique id identifying the event generated by DMI | X | ||
| eventCorrelationId | string | The request id passed by NCMP | X | ||
| eventTime | string | The timestamp when original event occurred | X | ||
| eventTarget | string | The target of the event | X | ||
| eventType | string | The type of the event | X | ||
| eventSchema | string | The event schema for async request response events | X | ||
| eventSchemaVersion | string | The event schema version for async request response events | X | ||
| event | object | The payload of an event | java object not defined by schema |