Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Following is some initial draft material on some abstract root conceptsNote - a separate contribution has since been made on the topic of a root hierarchy.   Portions of this contribution therefore need to be updated, but the lower level detail regarding onboarding and platform concepts still need to be discussed.



Diagrams



Figure 1 - RootEntity



Figure 2 - Descriptor (basis for all design time classes)

...

Figure 3 - Onboarding and Platform Class Interrelationships



Classes

RootEntity class

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

...

  

Attribute Name

  
  

Type

  
  

Mult.

  
  

Description

  
  

Stereotypes

  

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

description

String

1

Defines a textual free-form description of the object.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 



Descriptor (EntitySpecification) class

Qualified Name: Common::Root::RootObjectClasses::Descriptor (EntitySpecification)

...

  

Attribute Name

  
  

Type

  
  

Mult.

  
  

Description

  
  

Stereotypes

  

validFor

TimePeriod

1

The period during which the descriptor is valid.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

status

String

1

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

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

descriptorVersion

String

1

Identifies the version of the descriptor.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

description

String

1

Defines a textual free-form description of the object.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 



Entity class

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

...

  

Attribute Name

  
  

Type

  
  

Mult.

  
  

Description

  
  

Stereotypes

  

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

description

String

1

Defines a textual free-form description of the object.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 


OnboardingNfDescriptor class

Qualified Name: Common::Network::NetworkObjectClasses::OnboardingNfDescriptor

...

  

Attribute    Name

  
  

Type

  
  

Mult.

  
  

Description

  
  

Stereotypes

  

ProviderName

String

1

Provider of   the NF and of the NFD being onboarded.
 
 

 

 

OpenModelAttribute

  •   isInvariant:   false
  •   valueRange:  no range constraint  
  •   support:  MANDATORY

 

 

productInfoName

String

0..1

Human readable name   for   the NF Product. Can change during the NF Product lifetime.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

softwareVersion

String

1

Software version of   the   NF. This is changed when there is any change to the software that is   included in the NF Package.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

localizationLanguages

String

0..*

Information about localization languages of   the NF (includes e.g. strings in the NFD).
 
  NOTE: This allows to provide one or more     localization languages to support selecting a specific localization   language   at NF instantiation time.
 
 

valueRange: refer to ISO936   https://www.iso.org/iso-639-language-codes.html
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

productInfoDescription

String

0..1

Human readable   description   of the NF Product. Can change during the NF Product lifetime.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

defaultLocalizationLanguage

String

0..1

valueRange: refer to ISO936 https://www.iso.org/iso-639-language-codes.html

condition: Shall be present if     "localizationLanguage" is present and shall be   absent otherwise.
 
 

Default localization language that is   instantiated if no information about   selected localization language is     available.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

_onboardingcpdescriptor

OnboardingCpDescriptor

0..1

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

_onboardingvldescriptor

OnboardingVLDescriptor

0..1

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

validFor

TimePeriod

1

The period during which the descriptor is valid.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

status

String

1

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

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

descriptorVersion

String

1

Identifies the version of the descriptor.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

description

String

1

Defines a textual free-form description of the object.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

id

Identifier

1

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

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

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 



PlatformDescriptor (InternalModel) class

Qualified Name: Common::Network::NetworkObjectClasses::PlatformDescriptor (InternalModel)

...

  

Attribute Name

  
  

Type

  
  

Mult.

  
  

Description

  
  

Stereotypes

  

invariantID

Identifier

1

ID that spans multiple versions of the same descriptor.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

classification


1

Type/Role/Function (a datatype).   Classification may be a base type.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

validFor

TimePeriod

1

The period during which the descriptor is valid.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

status

String

1

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

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

descriptorVersion

String

1

Identifies the version of the descriptor.
 
 

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

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

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

description

String

1

Defines a textual free-form description of the object.

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 

id

Identifier

1

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

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

 

 

OpenModelAttribute

  •   isInvariant: false
  •   valueRange:  no   range constraint  
  •   support:  MANDATORY

 

 


PlatformNfDescriptor class

Qualified Name: Common::Network::NetworkObjectClasses::PlatformNfDescriptor

...