Overview
- CPS-1628Getting issue details... STATUS
- This page gives a description of CPS events including their fields
- Events will be split into events and Kafka headers
Event Overview
# | Description | Source | Destination | Status | Notes | SchemaName Used |
---|---|---|---|---|---|---|
1 | LCM Event | NCMP | External Client Apps | In Use | Life Cycle Management Events, when cmHandles are added or removed | LcmEvent |
2 | DMI Data AVC Event | DMI | NCMP | Implemented, Not in use | Attribute Value Change in configuration management (CM) data. | |
3 | AVC Subscription Create Event | External Client Apps | NCMP - Fwd to DMI | Implemented, Not in use | Create Event Only | SubscriptionEvent |
4 | DMI Async Request Response Event | DMI | NCMP | In Use | DMI passes response onto Kafka topic specified by client. | DmiAsyncRequestResponseEvent |
5 | NCMP Async Request Response Event | NCMP | External Client Apps | In Use | Forward No.4 to client specified topic | NcmpAsyncRequestResponseEvent |
6 | Bulk Response Event | DMI | NCMP | In Progress | Internal Kafka topic | BulkResponseEvent |
7 | Bulk Response Client Topic Event | NCMP | External Client Apps | In Progress | Error Message Reply to be decided | AsyncBulkResponseEvent |
8 | Event | NCMP | All Events in NCMP | In Use | Event is a sub object of all events in NCMP | event |
LCM Event
Description
LCM (Life Cycle Management) Event
AVC Event
Description
AVC Event
AVC Subscription Event
Description
AVC Subscription Event
Subscription Event Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
version | string | The event type version | |||
eventType | object | The event type | Enum: ["CREATE"] | ||
event | object | The payload for an event | Defined by event object below |
Event Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
subscription | object | The subscription details | Defined by subscription object below | ||
dataType | object | The datatype content | Defined by dataType object below | ||
predicates | object | Additional values to be added into the subscription | Defined by predicates object below |
Subscription Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
clientID | string | The client ID | |||
name | string | The name of the subscription | |||
isTagged | boolean | optional parameter, default is false | default: false |
DataType Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
dataspace | string | The dataspace name | |||
dataCategory | string | The category type of the data | |||
dataProvider | string | The provider name of the data | |||
schemaName | string | The name of the schema | |||
schemaVersion | string | The version of the schema |
Predicates Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
targets | array | CM Handles to be targeted by the subscription | |||
datastore | string | datastore which is to be used by the subscription | |||
xpath-filter | string | filter to be applied to the CM Handles through this event |
DMI Async Request Response Event
Description
DMI Asynchronous Request Response Event
DmiAsyncRequestResponse Event Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
eventID | string | The unique id identifying the event generated by DMI | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventTarget | string | The target of the event | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSchemaVersion | string | The event schema version for async request response events | |||
eventSource | string | The source of the event | |||
eventContent | object | The payload of an event | Defined by eventContent object below |
EventContent Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
repsonse-data-schema | string | The schema of response data | |||
response-status | string | The status of the response | |||
response-code | string | The code of the response | |||
response-data | object | The data payload | contains payload of type object |
NCMP Async Request Response Event
Description
NCMP Asynchronous Request Response Event
NcmpAsyncRequestResponse Event Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
eventID | string | The unique id identifying the event generated by DMI | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventTarget | string | The target of the event | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSchemaVersion | string | The event schema version for async request response events | |||
event | object | The payload of an event | Defined by event object below | ||
forwardedEvent | object | The payload of a forwarded event | 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 | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventTarget | string | The target of the event | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSource | string | The source of the event | |||
response-data-schema | string | The received schema of response data | |||
response-status | string | The received status of the response | |||
response-code | string | The received code of the response | |||
response-data | object | The data payload | 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 | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventTarget | string | The target of the event | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSchemaVersion | string | The event schema version for async request response events | |||
eventSource | string | The source of the event | |||
response-data-schema | string | The received schema of response data | |||
response-status | string | The received status of the response | |||
response-code | string | The received code of the response | |||
response-data | object | The data payload | contains payload of type object |
Bulk Response Event
Description
Bulk Response Event, uses event target for topic
BulkResponseEvent Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
eventID | string | The unique id identifying the event generated by DMI | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSchemaVersion | string | The event schema version for async request response events | |||
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
BulkResponseEvent Object
Field | Type | Description | Kafka Header | JSON Field | Notes |
---|---|---|---|---|---|
eventID | string | The unique id identifying the event generated by DMI | |||
eventCorrelationId | string | The request id passed by NCMP | |||
eventTime | string | The timestamp when original event occurred | |||
eventTarget | string | The target of the event | |||
eventType | string | The type of the event | |||
eventSchema | string | The event schema for async request response events | |||
eventSchemaVersion | string | The event schema version for async request response events | |||
event | object | The payload of an event | java object not defined by schema |