Classes

OrderItemRelationship

Enables specifying any kind of relationships between ServiceOrderItems

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
type String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The type of relationship such as contains, relies on.

OrderRelationship

An association between two ServiceOrders.

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
type String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
A categorization of the relationship, such as bulk, parent/child, and so forth.

ServiceAtomicDescriptor

Parent class: ServiceDescriptor

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
_serviceAtomicInstance ServiceAtomicInstance 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An implementation of atomic Service corresponding to a ServicecAtomicDescriptor.
_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Resource components of constituting a serivce descriptor.
serviceInvariantId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Constant identifier of the service model.
serviceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Versioned identifier of the service model (this uuid is changed for every major version of the service)
name String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The name of the service model designed.
description String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The description of the service model designed.
category String 1..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
A predefined list which identifies the construct’s category. There is a predefined list of service categories.
version String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The service model version.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
icon String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The icon path of the service.

ServiceAtomicInstance

Parent class: ServiceInstance

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
_resourceInstance ResourceInstance 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Resource instance components of constituting a service instance.
serviceInstanceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Uniquely identifies this instance of a service.
serviceInstanceName String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: OPTIONAL
The name assigned to the service-instance.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
selfLink Uri 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
URL to endpoint where more details can be gotten.
orchestrationStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Orchestration status of the service instance.
nsStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status).

ServiceCharacteristic

A quality or distinctive feature that defines an entity, including the name of this feature (attribute), and the type of the actual value.

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
name String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Name of dynamic characteristic (attribute).
valueType String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Type of the dynamic characteristic value.

ServiceCompositeDescriptor

ServcieCompositeDescriptor is used to model the design time representation of a service component or network service.

Parent class: ServiceDescriptor

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
_serviceDescriptor ServiceDescriptor 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Describe the nested relationship between multiple Service Descriptors.
_serviceCompositeInstance ServiceCompositeInstance 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An implementation of composite Service corresponding to a ServiceCompositeDescriptor.
_resourceDesc (resourcespecification) ResourceDesc (ResourceSpecification) 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Resource components of constituting a serivce descriptor.
serviceInvariantId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Constant identifier of the service model.
serviceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Versioned identifier of the service model (this uuid is changed for every major version of the service)
name String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The name of the service model designed.
description String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The description of the service model designed.
category String 1..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
A predefined list which identifies the construct’s category. There is a predefined list of service categories.
version String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The service model version.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
icon String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The icon path of the service.

ServiceCompositeInstance

Parent class: ServiceInstance

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
_resourceInstance ResourceInstance 0..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Resource instance components of constituting a service instance.
serviceInstanceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Uniquely identifies this instance of a service.
serviceInstanceName String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: OPTIONAL
The name assigned to the service-instance.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
selfLink Uri 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
URL to endpoint where more details can be gotten.
orchestrationStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Orchestration status of the service instance.
nsStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status).

ServiceDescriptor

ServiceDescriptor is used to model the design time representation of a service.

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
serviceInvariantId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Constant identifier of the service model.
serviceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Versioned identifier of the service model (this uuid is changed for every major version of the service)
name String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The name of the service model designed.
description String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The description of the service model designed.
category String 1..*

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
A predefined list which identifies the construct’s category. There is a predefined list of service categories.
version String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The service model version.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
icon String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The icon path of the service.

ServiceInstance

ServiceInstance is used to model the run time representation of a service.

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
serviceInstanceId Identifier 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Uniquely identifies this instance of a service.
serviceInstanceName String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: OPTIONAL
The name assigned to the service-instance.
serviceType String 0..1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field defining a generic type (like category) of the service. E.g. this field can be used for defining the service as “TRANSPORT”.
serviceRole String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
An optional string field for shortcode that defines the function that the service is providing. E.g. “MISVPN” or “AIM”.
selfLink Uri 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
URL to endpoint where more details can be gotten.
orchestrationStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Orchestration status of the service instance.
nsStatus String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Describe NS instance staus: instantiating(creating the Networek Service instance), active(the existed Network Service instance is under using), terminating(the existed Network Service instance stops using) or etc(healing and other possible status).

ServiceOrder

A type of Request that represents a Customer Order’s products decomposed into the services through which the products are realized.

Parent class: Request

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
id String 1

OpenModelAttribute

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

Preliminary

Unique identifier for Interaction.
externalId String 1

OpenModelAttribute

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

Preliminary

ID given by the order requester and only understandable by him (to facilitate his searches afterwards). It could an order number reference from the triggering system (OM)
priority OrderPriority 1

OpenModelAttribute

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

Preliminary

A way that can be used by order requester to prioritize orders in Service Order
description String 1

OpenModelAttribute

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

Preliminary

Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place.
category String 1

OpenModelAttribute

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

Preliminary

Used to categorize the order - Requester valued it and this category can be useful for the Service Order Management system and/or requester (e.g. “broadband”, “TV option”,).
state OrderState 1

OpenModelAttribute

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

Preliminary

State of the order
completionDate EDate 1

OpenModelAttribute

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

Preliminary

The date on which an interaction is closed or completed.
requestedStartDate EDate 1

OpenModelAttribute

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

Preliminary

The date that was requested to start processing the order.
requestedCompletionDate EDate 1

OpenModelAttribute

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

Preliminary

The date on which an interaction is closed or completed.
expectedCompletionDate EDate 1

OpenModelAttribute

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

Preliminary

The date on which an interaction is expected to be completed.
startDate EDate 1

OpenModelAttribute

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

Preliminary

The date on which an interaction is started.
notificationContact String 1

OpenModelAttribute

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

Preliminary

Contact attached to the order to send back information regarding this order
_serviceOrderItem ServiceOrderItem 1..*

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Reference to ServiceOrderItem
OrderDate EDate 1

OpenModelAttribute

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

Preliminary

The date the order was placed.

ServiceOrderItem

The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service.

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
id String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Identifier of the line item (generally it is a sequence number 01, 02, 03, …).
action Action 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The action to take for an InteractionItem, such as add, change, remove.
state OrderState 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
State of the order item: described in the state machine diagram. This is the requested state.
Quantity Integer 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
Quantity of an interaction item involved in an interaction.

Value

Applied stereotypes:

  • Preliminary
  • OpenModelClass
  • support: MANDATORY
Attribute Name Type Mult. Stereotypes Description
value String 1

Preliminary

OpenModelAttribute

  • isInvariant: false
  • valueRange: no range constraint
  • support: MANDATORY
The value of a given ServiceCharacteristic.

Enumerations

Action

Contains Enumeration Literals:

  • ADD:
  • MODIFY:
  • DELETE:
  • NO_CHANGE:

OrderPriority

A way that can be used by order requester to prioritize orders in Service Order Management system (from 0 to 4: 0 is the highest priority, and 4 the lowest). It could be for example valued by BSS based on customer order requested priority.

Contains Enumeration Literals:

  • 0:
  • 1:
  • 2:
  • 3:
  • 4:

OrderState

Contains Enumeration Literals:

  • ACKNOWLEDGED:
  • IN_PROGRESS:
  • PENDING:
  • HELD:
  • CANCELLED:
  • COMPLETED:
  • FAILED:
  • PARTIAL:
  • REJECTED: