Page History

...

#	Description	Source	Destination	Status	Notes	Full SchemaName Used
1	LCM Event	NCMP	External Client Apps	In Use	Life Cycle Management Events, when cmHandles are added or removed	LcmEvent cps:org.onap.ncmp.cmhandle.lcm-event:v1"
2	DMI Data AVC Event	DMI	NCMP	Implemented, Not in use	Attribute Value Change in configuration management (CM) data.	cps:org.onap.cps.ncmp.events:avc-event-schema:v1
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	NcmpAsyncBulkResponseEvent

...

Expand

title	LCM Event Details

Current LCM Event Object

Field	Type	Description	Kafka Header	Notes
eventID	string	The unique id identifying the event	x	M
eventCorrelationId	string	The id identifying the event	x	O
eventTime	string	The timestamp when original event occurred	x	M
eventSource	string	The source of the event	x	O
eventType	string	The type of the event	x	M
eventSchema	string	The schema that this event adheres to	x	O
eventSchemaVersion	string	The version of the schema that this event adheres to	x	O
event	objectEvent	The payload of an event		cps:org.onap.ncmp.cmhandle.lcm-event:v1 Defined by event object below ekiemcc : Suggest to add the full schema name for the LCM event body and the eventSchemaVersion

Type:Event

Object

Field Type Description Kafka Header Event Payload Field Notes
cmHandleId string cmHandle id
x
oldValues objectValues
Values that represents the state of a cmHandle

x Defined by values object below
newValues objectValues Values that represents the state of a cmHandle
x Defined by values object below

Type:Values

Object

Field Type Description Kafka Header Event Payload 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

DMI AVC Event

Expand

title	AVC Event Details

AVC Event Object

Field	Type	Description	Kafka Header	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	objectEvent	The payload of an eventjava object not defined by schema		cps:org.onap.cps.ncmp.events:avc-event-schema:v1

TODO : add table describing Type:Event

AVC Subscription Event

Description

...

Expand

title	AVC Subscription Event

Subscription Event Object

Field

Type

Description

Kafka Header

Event Payload Field

Notes

version

string

The event type version

ekiemcc : What is this version? This should be covered in the header now?

eventType

object

The event type

ekiemcc : This is now covered by the header? Is this needed any longer in the body?

Enum:

["CREATE"]

event

object

The payload for an event

Defined by event object below

Event Object

Field	Type	Description	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	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
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
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

...

Expand

title	NCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

Field	Type	Description	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	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	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

...

Space shortcuts

Page tree

Versions Compared

Old Version 29

New Version 30

Key

Current LCM Event Object

Type:Event

Field Type Description Kafka Header Event Payload Field Notes
cmHandleId string cmHandle id
x
oldValues objectValues
Values that represents the state of a cmHandle

x Defined by values object below
newValues objectValues Values that represents the state of a cmHandle
x Defined by values object below

Type:Values

Field Type Description Kafka Header Event Payload 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 Subscription Event

Description

Event Object

Subscription Object

DataType Object

Predicates Object

Event Object

forwardedEvent Object

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 29

New Version 30

Key

Current LCM Event Object

Type:Event

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotescmHandleIdstringcmHandle idxoldValuesobjectValuesValues that represents the state of a cmHandlexDefined by values object belownewValuesobjectValuesValues that represents the state of a cmHandlexDefined by values object below

Type:Values

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotesdataSyncEnabledstringcmHandle idxcmHandleStatestringState of cmHandlexEnum: ["ADVISED", "READY", "LOCKED", "DELETING", "DELETED"]cmHandlePropertiesobjectcmHandle propertiesxList of Java <String, String> Maps

AVC Event

Description

AVC Subscription Event

Description

Event Object

Subscription Object

DataType Object

Predicates Object

Event Object

forwardedEvent Object

Field Type Description Kafka Header Event Payload 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