Generic Information Element Template
- Andy Mayer
This template should be copied in the Parent Page (CNF Modeling Workspace) for each Information Element to be defined.
Information Element Template (one table for each Information Element)
Section | Description |
|---|---|
Information Element Name | Name of the Information Element |
Points of Contact | Authors and maintainers of the Information Element Information Element Main Contact (typically Use Case SME) Information Modeling Contact Schema Definition Contact |
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 | Please provide link to related JIRA item |
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 |