This contribution was previously accepted, a suggestion was made to further refine ParameterSpecValue, separating discrete values from ranges, which has been accepted, with the result as follows.


1         Introduction


This document contains the Word presentation of the model generated from the ONAP Eclipse Papyrus UML Information model  using gendoc.  This format is provided to assist the reader that does not use UML or has no access to UML tools.


2         Root

2.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.

2.2        Diagrams

2.2.1        Overview

Qualified Name: Common::Root::Diagrams

Description:

2.2.1.1         Diagrams







Figure 2‑1: Diagram Dynamic Parameters

2.3        RootObjectClasses

2.3.1        Overview

Qualified Name: Common::Root::RootObjectClasses

2.3.1.1         Classes



2.3.1.1.1        DiscreteValueSpec class

Qualified Name: Common::Root::RootObjectClasses::DiscreteValueSpec

Description:

DiscreteValueSpec represents a specific valid value that a given Parameter can take on.

Parent class: ParmSpecValue

Applied Stereotypes:

Table 2‑1 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

value

String

1

A discrete value that the Parameter can take on.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary






2.3.1.1.2        Parameter class

Qualified Name: Common::Root::RootObjectClasses::Parameter

Description:

Some parameter that is part of a ParameterGroup.    If parameter can only hold certain values, those values are specified via ParameterSpecValue (design time).   The actual value is specified via ParameterValue (runtime).

Applied Stereotypes:

Table 2‑2 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

parameterName

String

1

Name of parameter.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



IsInput

Boolean

1

Boolean that specifices if this parameter is an input parameter.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



paramvalue

ParameterValue

0..*

Parameter can have some number of runtime ParameterValues.   Each ParameterValue is also associated with some OperationalEntity (VnfInstance, ServiceInstance, ...).



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



isModifiable

Boolean

1

Bolean that specifices if the value can be modified or changed during the life of this parameter.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



valueType

String

1

The type of this parameter (integer, string, ...).



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



unitOfMeasure

String

0..1

A length, surface, volume, dry measure, liquid measure, money, weight, time, and the like. In general, a determinate quantity or magnitude of the kind designated, taken as a standard of comparison for others of the same kind, in assigning to them numerical values, as 1 foot, 1 yard, 1 mile, 1 square foot.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



description

String

1

Description of the parameter.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary





2.3.1.1.3        ParameterGroup class

Qualified Name: Common::Root::RootObjectClasses::ParameterGroup

Description:

A group of parameters that somehow relate or work together.

Applied Stereotypes:

Table 2‑3 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

parameterGroupName

String

1

Name of ParameterGroup



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



parameterGroupDescription

String

1

Description of ParameterGroup.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



parameterGroupId

Identifier

1

ID of ParameterGroup.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary





2.3.1.1.4        ParameterValue class

Qualified Name: Common::Root::RootObjectClasses::ParameterValue

Description:

The actual value of Parameter (runtime).

Applied Stereotypes:

Table 2‑4 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

parameter

Parameter

1

Runtime ParameterValue is associated with exactly one Parameter.    Parameter can have some number of runtime ParameterValues.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY



value

String

1

The actual value of Parameter (runtime).



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary





2.3.1.1.5        ParmSpecValue class

Qualified Name: Common::Root::RootObjectClasses::ParmSpecValue

Description:

A valid value of parameter (design time).   Values can be either a range (RangeValueSpec) or discrete (DiscreteValueSpec).

Applied Stereotypes:


2.3.1.1.6        RangeValueSpec class

Qualified Name: Common::Root::RootObjectClasses::RangeValueSpec

Description:

RangeValueSpec generally should have a valueType of either integer or real.   valueFrom, valueTo, and rangeStep should all be of the same valuetype for some Parameter.

valueTo should be greater than valueFrom

rangeStep should be greater than zero.

Parent class: ParmSpecValue

Applied Stereotypes:

Table 2‑5 Attributes for Package RootObjectClasses

 

Attribute Name

Type

Mult.

Description

Stereotypes

valueMin

String

1

The minimum value that a Parameter can take on.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



valueMax

String

1

The maximum value that the parameter can take on.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary



rangeStep

String

0..1

The specification that a range of values increases in steps, such as a range from 0 to 100 in steps of 5 with the resulting permitted values being 0, 5, 10, 15,...100. This complements the valueFrom and  valueTo attributes.



OpenModelAttribute

·         partOfObjectKey:  0

·         uniqueSet:

·         isInvariant:  false

·         unsigned:  false

·         counter: NA

·         support: MANDATORY


Preliminary