Service Order With Slight Updates
Following is a republish of the Service Order contribution that was accepted in R3 with a couple of spelling errors corrected and missing definitions added.
1.1.1 Service Order
1.1.2 Service Order State
1.2 Classes
1.2.1 OrderItemRelationship
Enables specifying any kind of relationships between ServiceOrderItems
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
type | String | 1 | OpenModelAttribute
Preliminary | The type of relationship such as contains, relies on.
|
1.2.2 OrderRelationship
An association between two ServiceOrders.
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
type | String | 1 | OpenModelAttribute
Preliminary | A categorization of the relationship, such as bulk, parent/child, and so forth.
|
1.2.3 OrderState
Applied stereotypes:
OpenModelClass
support: MANDATORY
1.2.4 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 | OpenModelAttribute
Preliminary | Name of dynamic characteristic (attribute).
|
valueType | String | 1 | OpenModelAttribute
Preliminary | Type of the dynamic characteristic value.
|
1.2.5 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 | OpenModelAttribute
Preliminary | Constant identifier of the service model.
|
serviceId | Identifier | 1 | OpenModelAttribute
Preliminary | Versioned identifier of the service model (this uuid is changed for every major version of the service)
|
name | String | 1 | OpenModelAttribute
Preliminary | The name of the service model designed.
|
description | String | 1 | OpenModelAttribute
Preliminary | The description of the service model designed.
|
category | String | 1..* | OpenModelAttribute
Preliminary | A predefined list which identifies the construct's category. There is a predefined list of service categories.
|
version | String | 1 | OpenModelAttribute
Preliminary | The service model version.
|
serviceType | String | 0..1 | OpenModelAttribute
Preliminary | 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 | OpenModelAttribute
Preliminary | An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
|
icon | String | 1 | OpenModelAttribute
Preliminary | The icon path of the service.
|
attachment | Attachment | 0..* | OpenModelAttribute
Preliminary |
|
1.2.6 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 | OpenModelAttribute
Preliminary | Uniquely identifies this instance of a service.
|
serviceInstanceName | String | 0..1 | OpenModelAttribute
Preliminary | The name assigned to the service-instance.
|
serviceType | String | 0..1 | OpenModelAttribute
Preliminary | 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 | OpenModelAttribute
Preliminary | An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
|
selfLink | Uri | 1 | OpenModelAttribute
Preliminary | URL to endpoint where more details can be gotten.
|
orchestrationStatus | String | 1 | OpenModelAttribute
Preliminary | Orchestration status of the service instance.
|
nsStatus | String | 1 | Experimental OpenModelAttribute
| 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).
|
1.2.7 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
Preliminary | Unique identifier for Interaction.
|
externalId | String | 1 | OpenModelAttribute |