Page Comparison

Table of Contents

...

Expand

title	LCM Event Details

Current LCM Event Object

Field	Type	Description	Kafka Header	Notes (M=Mandatory, O=Optional)	CloudEvents Mapping
eventID	string	The unique id identifying the event	x	M	standard (id)
eventCorrelationId	string	The id identifying the event. In LCMEvent this is always a cmhandleId	x	M O ( extension fields will be optional now )	extension(correlationid)
eventTime	string	The timestamp when original event occurred	x	M	standard ( time )
eventSource	string	The source of the event	x	M	standard ( source )
eventType	string	The type of the event	x	M	standard ( type )
eventSchema	string	The schema that this event adheres to.	x	M E.g. cps:org.onap.ncmp.cmhandle.lcm-event:1.0.0	standard (dataschema)
eventSchemaVersion	string	The version of the schema that this event adheres to	x	M e.g v1.0	N/A included in 'datascemadataschema'
event	Event	The payload of an event		M	standard ( data )

Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)

Field	Type	Description	Event Payload Field	Notes
cmHandleId	string	cmHandle id	x
oldValues	Values	Values that represents the state of a cmHandle	x	Defined by values object below
newValues	Values	Values that represents the state of a cmHandle	x	Defined by values object below

Type:Values

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

...

Expand

title	DMI Data AVC Event

AVC Event Object

Field	Type	Description	Kafka Header	Event Payload Field	Notes (M=Mandatory, O=Optional)	CloudEvents Mapping
eventID	string	The unique id identifying the event	x		M	standard (id)
eventCorrelationId	string	The id identifying the event	x	M	eventTime		O	extension(correlationid)
eventTime	string	The timestamp when original event occurred	x		O	standard (time)
eventSource	string	The source of the event	x		O Needs clarification, see issue #8	standard (source)
eventType	string	The type of the event	x		M (e.g. cps:org.onap.cps.ncmp.events:avc-event)	standard (type)
eventSchema	string	The schema that this event adheres to	x		M (e.g. cps:org.onap.cps.ncmp.events:avc-event-schema)	standard (dataschema)
eventSchemaVersion	string	The version of the schema that this event adheres to	x		M (e.g. v1.0 orv2.0)	N/A included in 'dataschema'
event	Event	The payload of an event			M	standard (data)

Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)

Field	Type	Description	Kafka Header	Event Payload Field	Notes
No Properties defined (entire event treated as single object) See open issue #1 Priyank Maheshwari This is how the event will look like. CPS-1065 Spike: CM data notifications from NCMP to applications including subscriptions#EventPayloadExample

...

AVC Subscription Event (External Clients Apps → NCMP) : ON HOLD - kieran mccarthy to analyze further

Priyank Maheshwari We need to revisit this schema and include the cloud events fields. ( At the moment this doesnt have proper fields )

Expand

title	AVC Subscription Event

Subscription Event Object

Field

Type

Description

Kafka Header

Event Payload Field

Notes

CloudEvents Mapping

version

string

The event type version

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

eventType

string

The event type

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

Enum:

["CREATE"]

standard ( type )

event

Event

The payload for an event

Defined by event object below

standard ( data )

Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)

Field	Type	Description	Event Payload Field	Notes
subscription	Subscription	The subscription details	x	Defined by subscription object below
dataType	DataType	The datatype content	x	Defined by dataType object below
predicates	Predicates	Additional values to be added into the subscription	x	Defined by predicates object below

Type: Subscription

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

Type: DataType

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

Type: Predicates

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

...

Expand

title	DMI Async Request Response Event

DmiAsyncRequestResponse Event Object

Field	Type	Description	Kafka Header	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI	x		standard ( id )
eventCorrelationId	string	The request id passed by NCMP	x		extensions ( correlationid )
eventTime	string	The timestamp when original event occurred	x		standard ( time)
eventTarget	string	The target of the event	x		extensions ( target )
eventType	string	The type of the event	x		standard ( type )
eventSchema	string	The event schema for async request response events	x		standard ( dataschema )
eventSchemaVersion	string	The event schema version for async request response events	x		N/A included in 'dataschema'
eventSource	string	The source of the event	x		standard ( source )
eventContent	EventContent	The payload of an event		The name of this fields is inconsistent with all other event schemas, see issue #6	standard ( data )

Type: EventContent (cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1)

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

...

Expand

title	NCMP Async Request Response Event

NcmpAsyncRequestResponse Event Object

Field	Type	Description	Kafka Header	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	Event	The payload of an event		Defined by event object below
forwardedEvent	ForwardedEvent	The payload of a forwarded event		Relation to Event field unclear, do we need 2 events at all see issue #7

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Field	Type	Description	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	x	Only in payload in v1 of the payload schema. To be removed in v2 version (will be in the header only)
eventCorrelationId	string	The request id passed by NCMP	x	as above
eventTime	string	The timestamp when original event occurred	x	as above
eventTarget	string	The target of the event	x	as above
eventType	string	The type of the event	x	as above
eventSchema	string	The event schema for async request response events	x	as above
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

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Field	Type	Description	Event Payload Field	Notes
eventID	string	The unique id identifying the event generated by DMI	?	Can NCMP put these in the header and remove them from the 'forwardedEvent'
eventCorrelationId	string	The request id passed by NCMP	?	as above
eventTime	string	The timestamp when original event occurred	?	as above
eventTarget	string	The target of the event	?	as above
eventType	string	The type of the event	?	as above
eventSchema	string	The event schema for async request response events	?	as above
eventSchemaVersion	string	The event schema version for async request response events	?	as above
eventSource	string	The source of the event	?	as above
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

Proposed New Schema:
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-1660

Field	Type	Description	NotesNotes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI		standard (id)
eventCorrelationId	string	The request id passed by NCMP		extensions(correlationid)
eventTime	string	The timestamp when original event occurred		standard (time)
eventSource	string	The source of the event	What value should contain in this? Needs clarification, see issue #8	standard (source)
eventType	string	The type of the event		standard (type)
eventSchema	string	The event schema for async request response events		standard (dataschema)
eventSchemaVersion	string	The event schema version for async request response events		N/A included in 'dataschema'
event	Event	The payload of an event	Defined by event object below	standard (data)

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Field	Type	Description	Notes
eventCorrelationId	string	The request id passed by NCMP	as above @Toine asked to add this property.
responseStatus	string	The received status of the response
responseCode	string	The received code of the response
responseData	object	The data payload	contains payload of type object

...

Before	After	CloudeEvent builder method	Example Value	Notes
eventId	id	.withId()		Mandatory
eventSource	source	.withSource()		Mandatory
N/A	specversion (default 1.0)	.v1()	1.0	Mandatory - This is the version of the cloud events
eventType	type	.withType()		Mandatory
eventTime	time	.withTime()		Optional
eventSchema	dataschema	.withDataSchema()		Optional includes the version of the schema
	datacontenttype	withDataContentType()	application/json	Optional
eventCorrelationId	correlationid	.withExtension()		( O ) This will be part of the extensions field in the cloud events and all the restrictions of the attribute field naming applies to it. i.e these fields will be in the small case. This is marked as optional as it applies to the event which has this field.
event	data	.withData(json TBC)		( M ) actual event/payload now would be under "data" field.

...

Versions Compared

Old Version 93

New Version 94

Key

Current LCM Event Object

Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)

Type:Values

AVC Event Object

Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)

Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)

Type: Subscription

Type: DataType

Type: Predicates

Type: EventContent (cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1)

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Proposed New Schema:
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-1660

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Page Comparison

Versions Compared

Old Version 93

New Version 94

Key

Current LCM Event Object

Type:Event (cps:org.onap.ncmp.cmhandle.lcm-event:v1)

Type:Values

AVC Event Object

Type: Event (cps:org.onap.cps.ncmp.events:avc-event-schema:v1)

Event Object (cps:org.onap.cps.ncmp.events:avc-subscription-event:v1)

Type: Subscription

Type: DataType

Type: Predicates

Type: EventContent (cps:org.onap.cps.ncmp.events:dmi-async-request-response-event-schema:v1)

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Type: forwardedEvent (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Proposed New Schema: Jira LegacyserverSystem JiraserverId4733707d-2057-3a0f-ae5e-4fd8aff50176keyCPS-1660

Type: Event (cps:org.onap.cps.ncmp.events:ncmp-async-request-response-event-schema:v1)

Proposed New Schema:
Jira Legacy
server System Jira
serverId 4733707d-2057-3a0f-ae5e-4fd8aff50176
key CPS-1660