Versions Compared

Key

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

...

Jira
serverONAP Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyCPS-1431

https://wiki.onap.org/display/DW/CPS+Data+Notifications+Overview - Update Diagram

https://wiki.onap.org/display/DW/CPS-1065+Spike%3A+CM+data+notifications+from+NCMP+to+applications+including+subscriptions

Assumptions

#AssumptionNotes
1All information included in the subscription event will be forwarded
2org.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

...

#IssueNotes Decision
1Is the forwarding being done via an endpoint or an asynchronous kafka message
  1. Doing via endpoint will make it complicated to forward to multiple DMIs
  2. New endpoint will have to be implemented on DMI
  3. Propose org.onap.ncmp:cm-avc-subscription-event.forward


2Extra data needed for forwarded message? What is the schema
        1. ID?
        2. timestamp?
Code Block
titleAVC Subscription Forwarding
collapsetrue
{
"$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event.forward:v1",
"$timestamp": "0000"
"$forwardedSubscriptionEvent":
{
  "$schemaversion": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:v1",
  "$ref": "#/definitions/SubscriptionEvent",
  "definitions": {
    "SubscriptionEvent": {
      "description": "The payload for avc subscription event.",
      "type": "object",
      "properties": {
        "version": {
          "description": "The event type version",
          "type": "string"
        },
        "eventType": {
          "description": "The event type",
          "type": "string",
          "enum": ["CREATE"]
        },
        "1.0",
  "eventType": "subscriptionCreated",
  "event": {
          "$ref": "#/definitions/event"
        }
      },
      "required": [
        "version",
        "eventContent"
      ],
      "additionalProperties": false
    },
    "event": {
      "description": "The event content.",
      "type": "object",
      "properties": {
        "subscription": {
          "description": "The subscription details.",
          "type": "object",
          "properties": {
            "clientID": {
              "description": "The clientID",
              "type": "string"
            }"SCO-9989752",
            "name": {
              "description": "The name of the subscription",
              "type": "string"
            },
            "isTagged": {
              "description": "optional parameter, default is no",
              "type": "boolean",
              "default": false
            }
          },
          "required": [
            "clientID",
            "name"
          ]
        "cm-subscription-001"
    },
        "dataType": {
          "description": "The datatype content.",
          "type": "object",
          "properties": {
            "dataspace": {
              "description": "The dataspace nameALL",
              "type": "string"
            },
            "dataCategory": {
              "description": "The category type of the data",
              "type": "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"
      "typeschemaVersion": "string1.0"
            },
            "schemaVersion"predicates": {
              "description"datastore": "The version of the schema“passthrough-operational",
              "typedatastore-xpath-filter": "string"
            }//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/ 
          }
        },
        "required": [
          "dataspace",
          "dataCategory",
          "dataProvider",
          "schemaName",
          "schemaVersion"
        ],
        "predicates": {_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |
          "description": "Additional values to be added into the subscription",
          "existingJavaType" : "java.util.Map<String,Object>",
          "type" : "object" //_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |
          }
        }
      },
      "required": [
        "subscription",
        "dataType"
      ]  //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”  
 
    }
}
} 	



Code Block
titleAVC Subscription Forwarding
collapsetrue
{
"$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event.forward:v1",
"$timestamp": "0000"
"$forwardedSubscriptionEvent":
{
  "$schemaversion": "https://json-schema.org/draft/2019-09/schema",
  "$id": "urn:cps:org.onap.cps.ncmp.events:avc-subscription-event:v1",
  "$ref": "#/definitions/SubscriptionEvent",
  "definitions": {
    "SubscriptionEvent": {
      "description": "The payload for avc subscription event.",
      "type": "object",
      "properties": {
        "version": {
          "description": "The event type version",
          "type": "string"
        },
        "eventType": {
          "description": "The event type",
          "type": "string",
          "enum": ["CREATE"]
        },
        "1.0",
  "eventType": "subscriptionCreated",
  "event": {
          "$ref": "#/definitions/event"
        }
      },
      "required": [
        "version",
        "eventContent"
      ],
      "additionalProperties": false
    },
    "event": {
      "description": "The event content.",
      "type": "object",
      "properties": {
        "subscription": {
          "description": "The subscription details.",
          "type": "object",
          "properties": {
            "clientID": {
              "description": "The clientID",
              "type": "string"
            }"SCO-9989752",
            "name": {
              "description": "The name of the subscription",
              "type": "string"
            },
            "isTagged": {
              "description": "optional parameter, default is no",
              "type": "boolean",
              "default": false
            }
          },
          "required": [
            "clientID",
            "name"
          ]
        "cm-subscription-001"
    },
        "dataType": {
          "description": "The datatype content.",
          "type": "object",
          "properties": {
            "dataspace": {
              "description": "The dataspace nameALL",
              "type": "string"
            },
            "dataCategory": {
              "description": "The category type of the data",
        "CM",
      "typedataProvider": "string"
            },CM-SERVICE"
            "dataProvider"schemaName": {
              "description": "The provider name of the data",
   "org.onap.ncmp:cm-network-avc-event.rfc8641"
           "typeschemaVersion": "string1.0"
            },
            "schemaNamepredicates": {
              "descriptiondatastore": "The name of the schema",
     “passthrough-operational",
         "typedatastore-xpath-filter": "string"
            },
            "schemaVersion": {//_3gpp-nr-nrm-gnbdufunction:GNBDUFunction/ 
              "description": "The version of the schema",_3gpp-nr-nrm-nrcelldu:NRCellDU/ | //_3gpp-nr-nrm-gnbcuupfunction:GNBCUUPFunction// |
              "type": "string"
            }
          }
        },
        "required": [//_3gpp-nr-nrm-gnbcucpfunction:GNBCUCPFunction/_3gpp-nr-nrm-nrcelldu:NRCellCU// |
          "dataspace",
          "dataCategory",
          "dataProvider",
          "schemaName",
          "schemaVersion"
        ],
        "predicates": {
          "description": "Additional values to be added into the subscription",
          "existingJavaType" : "java.util.Map<String,Object>",
          "type" : "object"
          }
        }
      },
      "required": [
        "subscription",
        "dataType"
      ]
    }
}
}  //_3gpp-nr-nrm-nrsectorcarrier:NRSectorCarrier//”  
 
    }
}
}  


3Error Scenarios
  1. DMI Rejects Predicates
  2. Error Codes

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


4Review Diagram in CPS Data Notifications Overview

...