6 UIM – Class attribute definitions

28.6203GPPFixed Mobile Convergence (FMC) Federated Network Information Model (FNIM) Umbrella Information Model (UIM)Release 17Telecommunication managementTS

6.1 Attribute properties

Attribute Name

Documentation and Allowed Values

Properties

direction

Represents the flow of traffic within the LT.

allowedValues: The allowed values are:

  • Client-Server: Signal flows down the LT, e.g. traffic is taken from a number of low rate clients and multiplexed into a higher rate server.
  • Server-Client: Signal flows up the LT.
  • Bidirectional; Signal flow is both Client-Server and Server-Client.

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

dnPrefix

It carries the DN Prefix information or no information. See Annex C of 32.300 [2] for one usage of this attribute.

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: F

isUnique: T

defaultValue: None

isNullable: False

id

An attribute whose class name and value can be used as an RDN when naming an instance of the object class. This RDN uniquely identifies the object instance within the scope of its containing (parent) object instance.

allowedValues: format of allowed values to be conformant with TS 32.300 [3].

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

index

Provides any relevant indexing of the LT (channel number, e.g. ‘3’)

allowedValues: N/A

type: Integer

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

layerProtocolNameList

Name(s) and additional descriptive information such as version number for the protocol(s)/layer(s) used for the associated communication link. Syntax and semantic is not specified.

allowedValues: allowed value examples: “X2AP”, “LR Optical Channel”

type: String

multiplicity: 1..*

isOrdered: F

isUnique: T

defaultValue: None

isNullable: True

locationName

The physical location (e.g. an address) of an entity represented by a (derivative of) ManagedElement_. It may contain no information to support the case where the derivative of ManagedElement_ needs to represent a distributed multi-location NE.

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

ltType

The name of the specification that describes the internal construction of the LT, indicating for example that it possesses a G.805 CP but no G.805 TCP (see [11]).

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: F

isUnique: T

defaultValue: None

isNullable: False

managedElementTypeList

It is a multi-valued attribute with one or more unique elements. Thus, it may represent one ME functionality or a combination of more than one functionality.

The actual syntax and encoding of this attribute is Solution Set specific.

allowedValues:

1) The allowed values of this attribute are the names of the IOC(s) that are (a) derived/subclassed from ManagedFunction and (b) directly name-contained by ManagedElement IOC (on the first level below ManagedElement), but with the string “Function” excluded.

2) If a ManagedElement contains multiple instances of a ManagedFunction this attribute will not contain repeated values.

3) The capitalisation (usage of upper/lower case) of characters in this attribute is insignificant. Thus, the NodeB should be case insensitive when reading these values.

4) Two examples of allowed values are:

  • NodeB;
  • HLR, VLR.

type: String

multiplicity: 1..*

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

tpeType

The name of the specification that describes the construction of the TPE emphasising for example the access to the TPE and whether it is associated with a physical port directly or not (see [11]).

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

userDefinedNetworkType

Textual information indicating network type, e.g. “UTRAN”. It may contain no information if there is no appropriate network type can be used.

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

userLabel

A user-friendly (and user assignable) name of this object.

allowedValues: N/A

type: String

multiplicity: 1

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

Attribute related to role

aEnd

The value of this attribute shall be a list of Distinguished Name of the alphabetically first instance in the Link subclass name to which this link/relation is associated (i.e., pointing to the instance of <X> as described in the definition of Link IOC in the present document).
As an example, with Link_As_Slf, aEnd would contain the Distinguished Name of the AsFunction instance, and the zEnd would contain the Distinguished Name of SlfFunction instance.

allowedValues:

1) For the instance whose class is defined by 3GPP, the format of the allowed values would be in conformant with that defined in TS 32.300 [3].

2) See Note1.

type: DN

multiplicity: *

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

passedById: True

managedBy

This relates to the role played by ManagementSystem_ in the relation between ManagedSystem_ and ManagedElement_. This attribute contains a list of the DN(s) of the related subclasses of ManagementSystem_ instance(s).

allowedValues: N/A

type: DN

multiplicity: *

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

passedById: True

managedElements

This relates to the role played by ManagedElement_ in the relation between ManagedSystem_ and ManagedElement_. This attribute contains a list of the DN(s) of the related subclasses of ManagedElement_ instance(s).

allowedValues: N/A

type: DN

multiplicity: *

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

passedById: True

zEnd

The value of this attribute shall be a list of Distinguished Name of the alphabetically second instance in the Link subclass name to which this link/relation is associated (i.e., pointing to the instance of <Y> as described in the definition of Link IOC in the present document).

As an example, with Link_As_Slf, aEnd would contain the Distinguished Name of the AsFunction instance, and the zEnd would contain the Distinguished Name of SlfFunction instance.

allowedValues:

1) For the instance whose class is defined by 3GPP, the format of the allowed values would be in conformant with that defined in TS 32.300 [3].

2)See Note1.

type: DN

multiplicity: *

isOrdered: False

isUnique: True

defaultValue: None

isNullable: False

passedById: True

Note 1: For the instance whose class is defined by TM Forum, the format of the allowed values would be in conformant with that defined in TM Forum MTOSI SD1-25_objectNaming [16].

Annex A (informative): Void

Annex B (informative): Void

Annex C (informative): Rationale and Usage of TPE/LT

This Annex provides the rationale and the usage of LT in conjunction with TPE.

Rational

A TPE is capable of encapsulating multiple transport functions (G.805 [19] termination functions, adapters, points etc.) at many different layers where the encapsulated transport functions are all related to the same signal flow. See Figure 11: UIM related to TM Forum model and ITU-T concepts.

The TPE is used to both reduce the instances of objects required to represent a given transport assembly and to also simplify the translation from traditional environments where layering is not fully represented.

The encapsulation may be opaque, i.e. not exposing the layering, or semi-transparent, exposing the explicit layering but compacted into a single TPE instance. In the former case, TPE instance does not need to name-contain any LT. In the latter case, TPE instance needs to name-contain instances of LT.

The TPE deals equivalently with unidirectional and bidirectional flows. A bidirectional flow is where pairings of unidirectional flows have some shared fate or are considered as related in some way such that all entities associated with the whole bidirectional flow will be encapsulated in one TPE. Where a bidirectional flow is encapsulated it is possible to connect to only one of the two directions of flow and this can be represented through parameters of the TPE.

Usage

The TPE provides a place against which to raise alarms, display parameters and set attributes associated with the signal flow.

The TPE can be related:

– Directly to one or more physical ports (i.e. that the signal is associated directly with an externally visible connector)

– Note that a physical port could also be related to more than one TPE;

– To logical functions that anchor the signal flow (i.e. it is floating between flexible functions in the equipment with no externally visible connector);

– To another supporting TPE to represent a client signal of the supporting TPE where there may be many instances of client;

– Note that there may be many instances of server TPE that feed a single client (e.g., in the case of VCAT)

For background see SD1-18 Functional Modelling Concepts [11] and naming refer to SD1-25 Object Naming [16].

Figure 11: UIM related to TM Forum model and ITU-T concepts

Annex D (informative):
Change history

Change history

Date

TSG #

TSG Doc.

CR

Rev

Subject/Comment

Old

New

2013-03

Approved version

2.0.0

11.0.0

2014-09

–

–

–

–

Update to Rel-12 version (MCC)

11.0.0

12.0.0

2016-01

–

–

–

–

Update to Rel-13 version (MCC)

12.0.0

13.0.0

2017-03

SA#75

–

–

–

Promotion to Release 14 without technical change

13.0.0

14.0.0

Change history

Date

Meeting

TDoc

CR

Rev

Cat

Subject/Comment

New version

2017-06

SA#76

SP-170507

0007

1

A

Remove Editor notes and correct references

14.1.0

2018-06

–

–

–

–

–

Update to Rel-15 version (MCC)

15.0.0

2019-09

SA#85

SP-190744

0014

2

F

Update class definition with inheritance information

15.1.0

2020-07

–

–

–

–

–

Update to Rel-16 version (MCC)

16.0.0

2022-03

–

–

–

–

–

Update to Rel-17 version (MCC)

17.0.0