Versions Compared

Old Version 14

changes.mady.by.user Sean Beirne

Saved on

compared with

New Version 15

changes.mady.by.user Sean Beirne

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • This page gives a description of CPS events including their fields
  • Events will be split into events and Kafka headers

Events

In UseImplementedImplemented
#DescriptionSourceDestinationStatusNotes
1LCM EventNCMPExternal Client AppsIn UseLife Cycle Management Events, when cmHandles are added or removed
2DMI Data AVC EventDMINCMPImplemented, Not in useAttribute Value Change in configuration management (CM) data.
3AVC Subscription Create EventExternal Client AppsNCMP - Fwd to DMIImplemented, Not in useCreate Event Only
4DMI Async Request Response EventDMINCMPIn UseDMI passes response onto Kafka topic specified by client.
5NCMP Async Request Response EventNCMPExternal Client AppsIn UseForward No.4 to client specified topic
6Bulk Response EventDMINCMPIn ProgressInternal Kafka topic
7Bulk Response Client Topic EventNCMPExternal Client AppsIn ProgressError Message Reply to be decided

LCM Event

Description

LCM (Life Cycle Management) Event

...

...

LCM Event

...

The payload for LCM event

...

LCM Event Object

XXXXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event


eventCorrelationIdstringThe id identifying the event


eventTimestringThe timestamp when original event occurred


eventSourcestringThe source of the event


eventTypestringThe type of the event


eventSchemastringThe schema that this event adheres to


eventSchemaVersionstring

The version of the schema that this event adheres to




eventobjectThe payload of an eventX

Defined by event object below

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
cmHandleIdstringcmHandle idX


oldValuesobject

Values that represents the state of a cmHandle

X

Defined by values object below
newValuesobjectValues that represents the state of a cmHandle

Defined by values object below

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
dataSyncEnabledstringcmHandle idX


cmHandleStatestring

State of cmHandle

X

Enum: 

["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]

cmHandlePropertiesobjectcmHandle properties

List of Java <String, String> Maps

...

XXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition 


$id
schema id


$ref
schema 


definitions
outline schema


AVC Eventobject

The payload for AVC event

X

Defined by AVC event object below

...

XXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the eventX


eventCorrelationIdstringThe id identifying the event


eventTimestringThe timestamp when original event occurredX


eventSourcestringThe source of the eventX


eventTypestringThe type of the event


eventSchemastringThe schema that this event adheres to


eventSchemaVersionstring

The version of the schema that this event adheres to




eventobjectThe payload of an event

java object not defined by schema

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition X


$id
schema idX


$ref
schema X


definitions
outline schema


Subscription Eventobject

The payload for avc subscription event



Defined by Subscription event object below

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
versionstringThe event type versionX


eventTypeobject

The event type

X

Enum: 

["CREATE"]

eventobjectThe payload for an event

Defined by event object below

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
subscriptionobjectThe subscription detailsX

Defined by subscription object below
dataTypeobject

The datatype content

X

Defined by dataType object below
predicatesobject

Additional values to be added into the subscription



Defined by predicates object below

...

XX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
clientIDstring

The client ID




namestring

The name of the subscription

X


isTaggedboolean

optional parameter, default is false



default: false

DataType Object

XXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
dataspacestring

The dataspace name




dataCategorystring

The category type of the data




dataProviderstring

The provider name of the data




schemaNamestring

The name of the schema




schemaVersionstring

The version of the schema

X


Predicates Object

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
targetsarray

CM Handles to be targeted by the subscription




datastorestring

datastore which is to be used by the subscription

X


xpath-filterstring

filter to be applied to the CM Handles through this event

X


DMI Async Request Response Event

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition X


$id
schema id


$ref
schema X


definitions
outline schema


DmiAsyncRequestResponse Event

object

The payload for 

DmiAsyncRequestResponse

event

X

Defined by DmiAsyncRequestResponse event object below

...

XXXXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP




eventTimestringThe timestamp when original event occurred


eventTargetstringThe target of the event


eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSchemaVersionstring

The event schema version for async request response events




eventSourcestringThe source of the event


eventContentobjectThe payload of an eventX

Defined by eventContent object below

...

XX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
repsonse-data-schemastring

The schema of response data

X


response-statusstring

The status of the response




response-codestring

The code of the response




response-dataobjectThe data payloadX

contains payload of type object

...

XXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition 


$id
schema id


$ref
schema 


definitions
outline schema


NcmpAsyncRequestResponse

 Event		object

The payload for NcmpAsyncRequestResponse event



Defined by NcmpAsyncRequestResponse event object below

...

XXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP




eventTimestringThe timestamp when original event occurred


eventTargetstringThe target of the eventX


eventTypestringThe type of the eventX


eventSchemastring

The event schema for async request response events

X


eventSchemaVersionstring

The event schema version for async request response events




eventobjectThe payload of an event

Defined by event object below
forwardedEventobjectThe payload of a forwarded event

Defined by forwardedEvent object below

...

XXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP




eventTimestringThe timestamp when original event occurredX


eventTargetstringThe target of the eventX


eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSourcestring

The source of the event

X


response-data-schemastring

The received schema of response data




response-statusstring

The received status of the response

X


response-codestring

The received code of the response

X


response-dataobject

The data payload

X

contains payload of type object

...

XXXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP

X


eventTimestringThe timestamp when original event occurredX


eventTargetstringThe target of the event


eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSchemaVersionstring

The event schema version for async request response events




eventSourcestring

The source of the event

X


response-data-schemastring

The received schema of response data

X


response-statusstring

The received status of the response




response-codestring

The received code of the response

X


response-dataobject

The data payload

X

contains payload of type object

...

XXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition 


$id
schema id


$ref
schema X


definitions
outline schema


BulkResponseEventobject

The payload for BulkResponse event



Defined by BulkResponse event object below

...

XXXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMI


eventCorrelationIdstring

The request id passed by NCMP




eventTimestringThe timestamp when original event occurred


eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSchemaVersionstring

The event schema version for async request response events




eventobjectThe payload of an event

java object not defined by schema

...

X
FieldTypeDescriptionKafka HeaderJSON FieldNotes
$schema
JSON schema definition X


$id
schema idX


$ref
schema X


definitions
outline schema


BulkResponseEventobject

The payload for BulkResponse event



Defined by BulkResponse event object below

...

XXXXX
FieldTypeDescriptionKafka HeaderJSON FieldNotes
eventIDstringThe unique id identifying the event generated by DMIX


eventCorrelationIdstring

The request id passed by NCMP

X


eventTimestringThe timestamp when original event occurred


eventTargetstringThe target of the event


eventTypestringThe type of the event


eventSchemastring

The event schema for async request response events




eventSchemaVersionstring

The event schema version for async request response events




eventobjectThe payload of an event

java object not defined by schema

...