Root Hierarchy Final Update (From R5)

Owned by Kevin Scaggs
Last updated: Feb 06, 2020
3 min read



This is simply an update from the Root Hierarchy agreed to in R5 (Root) with the temporary classes removed, being replaced with the actual classes from the various submodels.





1         Root

1.1        Overview

Qualified Name: Common::Root

Description:

A set of common business entities that collectively serve as the foundation of the ONAP Information Model.. This set of root classess enable the entities in different domains of the Information Model to be associated with each other, providing greater overall coherence.



1.2        Diagrams

1.2.1        Overview

Qualified Name: Common::Root::Diagrams

Description:

1.2.1.1         Diagrams







Figure 1‑1: Diagram Root4





1.3        RootObjectClasses

1.3.1        Overview

Qualified Name: Common::Root::RootObjectClasses

1.3.1.1         Classes

1.3.1.1.1        DesignEntity class

Qualified Name: Common::Root::RootObjectClasses::DesignEntity

Description:

A template which describes an OperationalEntity in terms of deployment and operational behavior requirements.

This class is abstract.

Parent class: Entity

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary

Table 1‑1 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

validFor

TimePeriod

1

The period during which the design entity is valid.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





status

String

1

The condition of the specification, such s active, inactive, or planned.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





name

String

1

Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





description

String

1

Defines a textual free-form description of the object.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





id

Identifier

1

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary













1.3.1.1.2        Domain class

Qualified Name: Common::Root::RootObjectClasses::Domain

Description:

Defines a collection of entities that share a common purpose. In addition, each constituent Entity in an Domain is both uniquely addressable and uniquely identifiable within that Domain

Parent class: RootEntity

Applied Stereotypes:

  • Experimental

  • OpenModelClass

  • support: MANDATORY



1.3.1.1.3        Entity class

Qualified Name: Common::Root::RootObjectClasses::Entity

Description:

This is an abstract class that extends the RootEntity class and represents characteristics and behaviors of concepts that pertain to the NFV managed environment.

This class is abstract.

Parent class: RootEntity

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary



1.3.1.1.4        ManagedEntity class

Qualified Name: Common::Root::RootObjectClasses::ManagedEntity

Description:

A ManagedEntity is used to specify that an Entity is manageable by electronic means.

Applied Stereotypes:

  • Experimental

  • OpenModelClass

  • support: MANDATORY

Table 1‑2 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

managementMethodCurrent

Integer

1

This is an enumerated integer that defines the particular type of management method that is currently being used.

Permitted Values:
0: Unknown
1: None
2: CLI
3: SNMP
4: TL1
5: CMIP
6: Proprietary





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY





managementMethodSupported

Integer

1..*

This is an array of integers that define the different management methods that are supported by this object.

Permitted Values:

0: Unknown
1: None
2: CLI
3: SNMP
4: TL1
5: CMIP
6: Proprietary





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY









1.3.1.1.5        OperationalEntity class

Qualified Name: Common::Root::RootObjectClasses::OperationalEntity

Description:

An OperationalEntity is a deployment in a NFV environment of a DesignEntity.

This class is abstract.

Parent class: Entity

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary







1.3.1.1.6        RootEntity class

Qualified Name: Common::Root::RootObjectClasses::RootEntity

Description:

This is the top of the ONAP class hierarchy. The purpose of the RootEntity is to define a set of attributes that are common to all entities that derive from it. These properties enable us to name, describe, and identify all objects in the environment.

This class is abstract.

Applied Stereotypes:

  • OpenModelClass

  • support: MANDATORY

  • Preliminary

Table 1‑3 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

name

String

0..1

Represents a user-friendly identifier of an object. It is a (possibly ambiguous) name by which the object is commonly known in some limited scope (such as an organization) and conforms to the naming conventions of the country or culture with which it is associated. It is NOT used as a naming attribute (i.e., to uniquely identify an instance of the object).





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





description

String

0..1

Defines a textual free-form description of the object.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary





id

Identifier

1

Unambiguously distinguishes different object instances. It is the naming attribute of the object.

Identifier of this information element.   This attribute shall be globally unique.





OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



Preliminary