Page Comparison

Table of Contents

References

Jira Legacy

server	System Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-1431

https://

...

lf-onap.

...

atlassian.

...

net/wiki/display/DW/CPS+Data+Notifications+Overview - Update Diagram

https://

...

lf-onap.

...

atlassian.

...

net/wiki/display/DW/CPS-1065+Spike%3A+CM+data+notifications+from+NCMP+to+applications+including+subscriptions

Assumptions

#	Assumption	Notes
1	All information included in the subscription event will be forwarded
2	org.onap.ncmp:cm-avc-subscription-event.response will be received from the DMI as per CPS-1065 Spike: CM data notifications from NCMP to applications including subscriptions#SubscriptionSteps

Issues & Decisions

#IssueNotes Decision1Is the forwarding being done via an endpoint or an asynchronous kafka message

Doing via endpoint will make it complicated to forward to multiple DMIs
New endpoint will have to be implemented on DMI
Propose org.onap.ncmp:cm-avc-subscription-event.forward

2Extra data needed for forwarded message? What is the schema

1. 1. 1. ID?
    2. timestamp?

Events

Forward Subscription Event

Follow up Implementation Proposal Page: CPS-1431: Forward Subscription Information to DMI Plugin(s)

Jira Legacy

server	System Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-1431

At the moment, it is up to the DMI Plugins to accept or reject
NCMP has to reject if cached dataspace is used (Cached is currently not supported)
Code Block
title AVC Subscription Forwarding

...

collapse true
{ "

...

version": "

...

1.0", "

...

eventType": "

...

subscriptionCreated", "

...

event": {

...

"

...

subscription

...

"

...

: {

...

"

...

clientID":

...

"SCO-9989752",

...

"

...

name": "

...

cm-subscription-001" },

...

"

...

dataType": {

...

"

...

dataspace": "

...

ALL",

...

"

...

dataCategory": "

...

CM",

...

"

...

dataProvider":

...

"

...

CM-SERVICE"

...

"schemaName": "org.onap.ncmp:cm-network-avc-event.rfc8641"
      "

...

schemaVersion": "

...

1.0"

...

},

...

"predicates": {

...

"

...

datastore":

...

“passthrough-operational", "

...

datastore-xpath-filter": "

...

//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/

...

_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |

...

//_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |

...

//_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”

...

}

...

}

Subscription Event Responses

Jira Legacy

server	System Jira
columnIds	issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columns	key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId	4733707d-2057-3a0f-ae5e-4fd8aff50176
key	CPS-1492

NCMP will be aware of the registered DMIs and the CMHandles registered to a given DMI
1. Therefore will know how many DMIs to be waiting for a response from
2. Wait for timeout before sending event outcome? (30s)

Subscription Event Outcome

NCMP is to collate Event Responses from DMI and send.
Wait for timeout,
1. if all DMIs returned send full Event Outcome
2. else partial event outcomes

Component Diagram

Drawio

border	true
diagramName	Untitled Diagram
simpleViewer	false
width	600
links	auto
tbstyle	top
lbox	true
diagramWidth	1321
revision	5

Issues & Decisions

#

Issue

Notes

Decision

1

Is the forwarding being done via an endpoint or an asynchronous kafka message

Doing via endpoint will make it complicated to forward to multiple DMIs
New endpoint will have to be implemented on DMI
Propose org.onap.ncmp:cm-avc-subscription-event.forward

2

Extra data needed for forwarded message? What is the schema

1. 1. 1. ID?
    2. timestamp?

Code Block

title	AVC Subscription Forwarding
collapse	true

{
"$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event.forward:v1",
"$timestamp": "0000"
"$forwardedSubscriptionEvent":
{
  "$schemaversion": "https://json-schema.org/draft/2019-09/schema1.0",
  "$ideventType": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:v1subscriptionCreated",
  "$ref": "#/definitions/SubscriptionEvent",
  "definitions": {
    "SubscriptionEventevent": {

     "description": "The payload for avc subscription event.",
      "type": "object",
      "properties": {
 
      "versionclientID": {
          "description": "The event type version",
"SCO-9989752",
         "typename": "stringcm-subscription-001"
        },
        "eventTypedataType": {

         "descriptiondataspace": "The event typeALL",
   
      "typedataCategory": "stringCM",
          "enumdataProvider": ["CREATE"]
        },
 CM-SERVICE"
      "eventschemaName": {           "$ref": "#/definitions/event"
        }
      },"org.onap.ncmp:cm-network-avc-event.rfc8641"
      "requiredschemaVersion": [
        "version",
        "eventContent"
      ],"1.0"
       "additionalProperties": false
    },
    "eventpredicates": {
    
 "description": "The event content.",       "typedatastore": “passthrough-operational"object",
      "properties": {
        "subscriptiondatastore-xpath-filter": {
          "description": "The subscription details.","//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/ 
             "type": "object",
          "properties": {_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |
            "clientID": {
              "description": "The clientID",//_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |
               "type": "string"//_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”  
 
    }
  }
 },
            "name": {
              "description": "The name of the subscription",
              "type": "string"
            },
            "isTagged": {
              "description": "optional parameter, default is no",
              "type": "boolean",
              "default": false
            }
          },
          "required": [
            "clientID",
            "name"
          ]
        },
        "dataType": {
          "description": "The datatype content.",
          "type": "object",
          "properties": {
            "dataspace": {

Code Block

title	AVC Subscription Forwarding
collapse	true

{
"$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event.forward:v1",
"$timestamp": "0000"
"$forwardedSubscriptionEvent":
{
  "version": "1.0",
  "eventType": "subscriptionCreated",
  "event": {
    "subscription": {
            "description"clientID": "The dataspace name",
       SCO-9989752",
      "typename": "stringcm-subscription-001"
            },
       
    "dataCategorydataType": {
   
          "descriptiondataspace": "The category type of the data",
       ALL",
      "typedataCategory": "string"
            },
  CM",
         "dataProvider": {
              "description": "The provider name of the data",
CM-SERVICE"
             "type": "string"
            },
            "schemaName": {
              "description": "The name of the schema","org.onap.ncmp:cm-network-avc-event.rfc8641"
              "type"schemaVersion": "string"
       1.0"
    },
      
     "schemaVersionpredicates": {

             "descriptiondatastore": "The version of the schema",
    “passthrough-operational",
         "typedatastore-xpath-filter": "string"//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/ 
           }  _3gpp-nr-nrm-nrcelldu:NRCellDU/         }
        },
        "required": [| //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |
          "dataspace",
          "dataCategory",
          "dataProvider",
          "schemaName",
          "schemaVersion"
        ],
        "predicates": {
          "description": "Additional values to be added into the subscription",
          "existingJavaType" : "java.util.Map<String,Object>",
      //_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |
            //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”  
 
 "type" : "object"           }
        }
     
},
      "required": [
        "subscription",
   
    "dataType"
      ]
    } } }

3

Error Scenarios

DMI Rejects Predicates
Error Codes

Not in scope: Future story for notifying clients that subscription failed to be created

4

Review Diagram in CPS Data Notifications Overview

...

Versions Compared

Old Version 1

New Version Current

Key

References

Assumptions

Issues & Decisions

Events

Forward Subscription Event

Subscription Event Responses

Subscription Event Outcome

Component Diagram

Issues & Decisions