You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 27
Next »
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
| # | 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 | DmiAsyncBulkResponseEvent |
| 7 | Bulk Response to Client Topic Event | NCMP | External Client Apps | In Progress | Error Message Reply to be decided | |
LCM Event
Description
LCM Event Details
LCM Event Object
| Field | Type | Description | Kafka Header | Event Payload 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 |
|
|
|
| eventSource | string | The source of the event |
|
|
|
| eventType | string | The type of the event |
|
|
|
| eventSchema | string | The schema that this event adheres to |
|
|
|
| eventSchemaVersion | string | The version of the schema that this event adheres to |
|
|
|
| event | object | The payload of an event |
|
| Defined by event object below |
Event Object
| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| cmHandleId | string | cmHandle id |
|
|
|
| oldValues | object | Values that represents the state of a cmHandle |
|
| Defined by values object below |
| newValues | object | Values that represents the state of a cmHandle |
|
| Defined by values object below |
Values Object
| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| dataSyncEnabled | string | cmHandle id |
|
|
|
| cmHandleState | string | State of cmHandle |
|
| Enum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"] |
| cmHandleProperties | object | cmHandle properties |
|
| List of Java <String, String> Maps |
AVC Event
Description
AVC Event
AVC Event Details
AVC Event Object
| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event |
|
|
|
| eventCorrelationId | string | The id identifying the event |
|
|
|
| eventTime | string | The timestamp when original event occurred |
|
|
|
| eventSource | string | The source of the event |
|
|
|
| eventType | string | The type of the event |
|
|
|
| eventSchema | string | The schema that this event adheres to |
|
|
|
| eventSchemaVersion | string | The version of the schema that this event adheres to |
|
|
|
| event | object | The payload of an event |
|
| java object not defined by schema |
AVC Subscription Event
Description
AVC Subscription Event
AVC Subscription Event
Subscription Event Object
| Field | Type | Description | Kafka Header | Event Payload 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 | Event Payload 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 | Event Payload 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 | Event Payload 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 | Event Payload 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
DMI Async Request Response Event
DmiAsyncRequestResponse Event Object
| Field | Type | Description | Kafka Header | Event Payload 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 | Event Payload 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
NCMP Async Request Response Event
NcmpAsyncRequestResponse Event Object
| Field | Type | Description | Kafka Header | Event Payload 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 | Event Payload 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 | Event Payload 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
Bulk Response Event
BulkResponseEvent Object
| Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| eventID | string | The unique id identifying the event generated by DMI |
|
|
|
| eventCorrelationId | string | The request id passed by NCMP |
|
|
|
| eventTarget | string | The destination topic of the client |
|
|
|
| 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
Bulk Response Event - Client Topic
BulkResponseEvent Object
| Field | Type | Description | Kafka Header | Event Payload 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 |
