Service Order With Slight Updates
- Kevin Scaggs
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
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
Preliminary | A way that can be used by order requester to prioritize orders in Service Order
|
description | String | 1 | OpenModelAttribute
Preliminary | Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place.
|
category | String | 1 | OpenModelAttribute
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
Preliminary | State of the order
|
completionDate | EDate | 1 | OpenModelAttribute
Preliminary | The date on which an interaction is closed or completed.
|
requestedStartDate | EDate | 1 | OpenModelAttribute
Preliminary | The date that was requested to start processing the order.
|
requestedCompletionDate | EDate | 1 | OpenModelAttribute
Preliminary | The date on which an interaction is closed or completed.
|
expectedCompletionDate | EDate | 1 | OpenModelAttribute
Preliminary | The date on which an interaction is expected to be completed.
|
startDate | EDate | 1 | OpenModelAttribute
Preliminary | The date on which an interaction is started.
|
notificationContact | String | 1 | OpenModelAttribute
Preliminary | Contact attached to the order to send back information regarding this order
|
_serviceOrderItem | ServiceOrderItem | 1..* | OpenModelAttribute
| Reference to ServiceOrderItem
|
OrderDate | EDate | 1 | OpenModelAttribute
Preliminary | The date the order was placed.
|
StartDate | DateTime | 1 | Experimental OpenModelAttribute
| Date interaction initiated
|
endDate | DateTime | 1 | Experimental OpenModelAttribute
| The date on which an interaction is closed or completed.
|
Status | String | 0..1 | Experimental OpenModelAttribute
| The current condition of an interaction, such as open, in research, closed, and so forth
|
name | String | 0..1 | OpenModelAttribute
Preliminary | 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).
|
description | String | 0..1 | OpenModelAttribute
Preliminary | Defines a textual free-form description of the object.
|
id | Identifier | 1 | OpenModelAttribute
Preliminary | Identifier of this information element. This attribute shall be globally unique. Unambiguously distinguishes different object instances. It is the naming attribute of the object.
|
1.2.8 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 | OpenModelAttribute
Preliminary | Identifier of the line item (generally it is a sequence number 01, 02, 03, ...).
|
action | Action | 1 | OpenModelAttribute
Preliminary | The action to take for an InteractionItem, such as add, change, remove.
|
state | OrderState | 1 | OpenModelAttribute
Preliminary | State of the order item: described in the state machine diagram. This is the requested state.
|
Quantity | Integer | 1 | OpenModelAttribute
Preliminary | Quantity of an interaction item involved in an interaction.
|
1.2.9 Value
Applied stereotypes:
Preliminary
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
value | String | 1 | OpenModelAttribute
Preliminary | The value of a given ServiceCharacteristic The value of a given ServiceCharacteristic
|
1.3 Data Types
1.4 Enumerations
1.4.1 Action
Contains Enumeration Literals:
ADD:
MODIFY:
DELETE:
NO_CHANGE:
1.4.2 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:
1.4.3 OrderState
Contains Enumeration Literals:
ACKNOWLEDGED:
IN_PROGRESS:
PENDING:
HELD:
CANCELLED:
COMPLETED:
FAILED:
PARTIAL:
REJECTED: