Service Order
- Kevin Scaggs
Following is an update to the ServiceOrder class diagram and associated classes. Please note that there are 3 ServiceDescriptor classes that need to be reconciled.
1.0 Diagrams
1.1.1 Service Order
1.1.2 Service Order State Flow
1.1 Classes
1.1.1 OrderItemRelationship
Enables specifying any kind of relastionships between ServiceOrderItems
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
type | String | 1 | OpenModelAttribute
| The type of relationship such as contains, relies on.
|
1.1.2 OrderRelationship
An assocation between two ServiceOrders.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
type | String | 1 | OpenModelAttribute
| A categorization of the relationship, such as bulk, parent/child, and so forth.
|
1.1.3 ServiceCharacteristic
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
name | String | 1 | OpenModelAttribute
|
|
valueType | String | 1 | OpenModelAttribute
|
|
1.1.4 ServiceDescriptor
ServiceDescriptor is used to model the design time representation of a service.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
invariantUuid | Uuid | 1 | OpenModelAttribute
| Constant identifier of the service model.
|
uuid | Uuid | 1 | OpenModelAttribute
| Versioned identifier of the service model (this uuid is changed for every major version of the service)
|
name | String | 1 | OpenModelAttribute
| The name of the service model designed.
|
description | String | 1 | OpenModelAttribute
| The description of the service model designed.
|
category | String | 1..* | OpenModelAttribute
| A predefined list which identifies the construct's category. There is a predefined list of service categories.
|
version | String | 1 | OpenModelAttribute
| The service model version.
|
serviceType | String | 1 | OpenModelAttribute
| 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
| An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
|
icon | String | 1 | OpenModelAttribute
| The icon path of the service.
|
serviceComponentUuid | Uuid | 1 | OpenModelAttribute
| The service component descriptor UUIDs that the service includes (relationhip to Service Component).
|
_serviceDescriptor | ServiceDescriptor | 0..* | OpenModelAttribute
|
|
_serviceInstance | ServiceInstance | 0..* | OpenModelAttribute
|
|
_serviceComponentDescriptor | ServiceComponentDescriptor | 1..* | OpenModelAttribute
|
|
attachment | Attachment | 0..* | OpenModelAttribute
|
|
1.1.5 ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
id | String | 1 | OpenModelAttribute
|
|
href | String | 1 | OpenModelAttribute
|
|
name | String | 1 | OpenModelAttribute
|
|
dscription | String | 1 | OpenModelAttribute
|
|
type | String | 1 | OpenModelAttribute
|
|
category | String | 1 | OpenModelAttribute
|
|
serviceType | String | 1 | OpenModelAttribute
|
|
serviceRole | String | 1 | OpenModelAttribute
|
|
version | String | 1 | OpenModelAttribute
|
|
resourcedescriptor | ResourceDescriptor | 0..* | OpenModelAttribute
|
|
1.1.6 ServiceDescriptor
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
invariantUuid | Uuid | 1 | OpenModelAttribute
| Constant identifier of the service model.
|
uuid | Uuid | 1 | OpenModelAttribute
| Versioned identifier of the service model (this uuid is changed for every major version of the service)
|
name | String | 1 | OpenModelAttribute
| The name of the service model designed.
|
description | String | 1 | OpenModelAttribute
|
|
version | String | 1 | OpenModelAttribute
|
|
serviceinstance | ServiceInstance | 0..* | OpenModelAttribute
|
|
serviceType | String | 1 | OpenModelAttribute
| 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
| An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".
|
icon | String | 1 | OpenModelAttribute
| The icon path of the service.
|
serviceComponentUuid | Uuid | 1 | OpenModelAttribute
| The service component descriptor UUIDs that the service includes (relationhip to Service Component).
|
1.1.7 ServiceOrder
A type of Request that represents a Customer Order's products decomposed into the services through which the products are realized.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
id | String | 1 | OpenModelAttribute
| Unique identifier for Interaction.
|
externalId | String | 1 | OpenModelAttribute
| 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
| A way that can be used by order requester to prioritize orders in Service Order
|
description | String | 1 | OpenModelAttribute
| Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place.
|
category | String | 1 | OpenModelAttribute
| 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
| State of the order
|
completionDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is closed or completed.
|
requestedStartDate | EDate | 1 | OpenModelAttribute
| The date that was requested to start processing the order.
|
requestedCompletionDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is closed or completed.
|
expectedCompletionDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is expected to be completed.
|
startDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is started.
|
notificationContact | String | 1 | OpenModelAttribute
| Contact attached to the order to send back information regarding this order
|
_serviceOrderItem | ServiceOrderItem | 1..* | OpenModelAttribute
| Reference to ServiceOrderItem
|
OrderDate | EDate | 1 | OpenModelAttribute
| The date the order was placed.
|
1.1.8 ServiceOrderItem
The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service.
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
id | String | 1 | OpenModelAttribute
| Identifier of the line item (generally it is a sequence number 01, 02, 03, ...).
|
action | Action | 1 | OpenModelAttribute
| The action to take for an InteractionItem, such as add, change, remove.
|
state | OrderState | 1 | OpenModelAttribute
| State of the order item: described in the state machine diagram. This is the requested state.
|
Quantity | Integer | 1 | OpenModelAttribute
| Quantity of an interaction item involved in an interaction.
|
1.1.9 Value
Applied stereotypes:
OpenModelClass
support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
value | String | 1 | OpenModelAttribute
| The value of a given ServiceCharacteristic
|
1.2 Data Types
1.3 Enumerations
1.3.1 Action
Contains Enumeration Literals:
ADD:
MODIFY:
DELETE:
NO_CHANGE:
1.3.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.3.3 OrderState
Contains Enumeration Literals:
ACKNOWLEDGED:
IN_PROGRESS:
PENDING:
HELD:
CANCELLED:
COMPLETED:
FAILED:
PARTIAL:
REJECTED: