Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

1 Introduction

2 Requirements of the Information Model

2.1 Guideline for Using OpenModelAttributes

2.2 Requirements of Defining the Classes

A Class in ONAP shall have the following properties: 

  • Name: in alignment with IISOMI TR 514, Name follows Upper Camel Case style (UCC). Each class in the model has a unique name.
    • Example: Qualified Name: Common::Location::ObjectClasses::Place
  • Documentation: in alignment with IISOMI TR 514, Contains a short definition. The documentation is carried in the “Applied comments” field in Papyrus; i.e., the “Owned comments” field shall not be used. The complete documentation should be written in a single comment; i.e., at most one “Applied comment”.
    •  Example: .....
  • Superclass(es): in alignment with IISOMI TR 514, Inheritance and multiple inheritance may be used to deal with shared properties.
    • Example: Parent class: RootEntity
    • TBV: is multiple inheritance supported in ONAP ? 
  • Applied Steoreotypes: Following stereotypes needs to be identified
    •  Example:
             - Experimental
             - OpenModelClass
                   support: MANDATORY
             - Reference: From TMF SID
  • Abstract : in alignemnt with IISOMI TR 514, Indicates if the object class can be instantiated or is just used for inheritance; i.e., abstract classes will not be instantiated.
    • Example: .


Following properties are not mandatory in ONAP: 

  • Is Leaf : Indicates that the object class must not be extended (Is Leaf = true); default = false

2.3 Requirements of Defining the Associations


  • Name: in alignment with IISOMI TR 514, Name follows Upper Camel Case (UCC) style and is unique across all relationship names defined in the whole model.
    The format for associations is "<Class1Name><VerbPhrase><Class2Name>" where the verb phrase creates a sequence that is readable and meaningful. In case of a long class name, it is also allowed to use a short form of the name.
    •  Example:
  • Documentation: in alignment with IISOMI TR 514, it contains a short definition. The documentation is carried in the “Applied comments” field in Papyrus; i.e., the “Owned comments” field shall not be used. The complete documentation should be written in a single comment; i.e., at most one “Applied comment”.
  • Type: in alignment with IISOMI TR 514,The following types are used: simple association, composition association, aggregation, association, generalization, dependency, usage dependency, abstraction dependency, realization dependency.


Following properties are optional in ONAP: 

  • Direction/Navigable in Papyrus

2.4 Requirements of Defining the Data Types

2.5 Requirements of Defining the Enumerations

3 Requirements of Using Gendoc


  • No labels