...
Section | Description | ||
|---|---|---|---|
Use Case Title | ONAP/3GPP & O-RAN Alignment-Standards Defined Notifications over VES | ||
Actors (and System Components)DC | DCAE VES Event Listener, DCAE-SDK, SchemaBroker, xNF | ||
Description | This contribution introduces a new domain in VES, stndDefined, which indicates that the event contains data that conforms to format/schema defined by a separate standards organization. In addition we propose one new field in the VES Common Header to enable further classification of such events, e g to support routing of these events to appropriate DMaaP topics. An optional second stage validation is proposed in DCAE prior to acknowledging the event to enhance trouble shooting. | ||
| Points of Contact | Information Element Main Contact - Marge Hillis Oskar Malm Information Modeling Contact - Marge Hillis Schema Definition Contact - Damian Nowak | ||
Preconditions | Preconditions for a system (xNF & ONAP) before a xNF sends a stndDefined VES event: the xNF has been onboarded (artifacts in the onboarding package describe the VES events that the xNF supports). xNF has gone through registration with ONAP. e.g. in the case of a PNF, it has gone through Plug and Play and sent pnfRegistration event. ONAP system that supports VES 7.2 or later. | ||
Triggers / Begins when | xNF emits a VES notification that contains data which follows the schema defined by a standards body with a VES Common Header where the domain field is populated with the stndDefined value which is destined for the DCAE Collector. | ||
Steps / Flows (success) | Describes the sequence of steps and interactions that occur during the Use Case (may include: description, data exchanges, functionality, state changes) Interaction diagrams may be included or referenced |
| |
Post-conditions | DCAE sends the stndDefined VES events to a Kafka topic. | Post-conditions | The expected results of the execution of the Use Case Includes description of Information Produced |
Alternate / Exception Paths | Description of any exceptions or special process that could occur during Use Case | ||
Related Use Cases | List of the Use Cases referenced by this Use Case | ||
Assumptions | Describes any assumptions that are made for this use case | ||
Tools / References / Artifacts | List of any tools or reference material associated with this Use Case as well as any JIRA trace-ability. List of any associated diagrams or modelling artifacts associated with the Use Case |
...
This table is taken from the generic information template: Generic Information Element Template
Information Element NameName of the | VES Information ElementModel | ||||||||
| Points of ContactAuthors and maintainers of the Information Element | Information Element Main Contact - Marge Hillis Oskar Malm Information Modeling Contact - Marge Hillis Schema Definition Contact - Damian Nowak | ||||||||
| Related Use Cases Use Cases that have interactions using this Information Element.Please provide a point of contact for each related Use Case. | |||||||||
Participating ONAP Components | The list of ONAP Components that are stakeholders for the Information Element | ||||||||
| Related JIRA |
| ||||||||
Description | Overview and description of the Information Element. | ||||||||
Related Standards & Industry Activities | Please refer to any standards or industry activities that should be taken into account when defining the Information Model related to this Information Element. Please provide links to relevant material. | ||||||||
Attributes | Attributes: Name and describe each attribute of this Information Element. Please include the datatype of the attribute if possible. Is this attribute read-only, read-write? Are there any default values? | ||||||||
Relationships | Relationships: Describe how this Information Element is related to other Information Elements. Also describe nature of the relationship: association, inheritance, dependency, etc. and multiplicity. | ||||||||
Originator | Where does this information come from? (What component initially creates it) | ||||||||
| Consumers | Who uses this information inside & outside of ONAP? How do they use it? Includes description of information consumed (whole class, specific attributes, etc.) | ||||||||
Producers | Who updates this information inside & outside of ONAP? Under what conditions do they update it? Includes description of information produced (whole class, specific attributes, etc.) | ||||||||
Steward | Where will this information stored and maintained in ONAP? | ||||||||
| Impacted APIs & Schemas | Identify impacted ONAP schemas & APIs Are there existing schemas be used or extended? | ||||||||
Information Modeling Status | What is the status of ONAP Information Modeling activities associated with this Information Element. Please provide links to relevant wiki pages & JIRA. | ||||||||
Schema Definition Status | What is the status of ONAP Schema Definition activities associated with this Information Element. Please provide links to relevant wiki pages & JIRA. | ||||||||
ONAP Release Priority | Prioritization for ONAP Releases |
...