Classes
ServiceOrder
...
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 Classes
1.1.1 OrderItemRelationship
Enables specifying any kind of relastionships between ServiceOrderItems
Applied stereotypes:
- OnapModelLifecycleOpenModelClass
- statesupport: INPUT
- MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
idtype | String | 1 OnapModelLifecycle
OpenModelAttribute isInvariant | 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
| Unique identifier for Interaction.
| hrefA 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 OnapModelLifecycle state: INPUT | OpenModelAttribute
|
|
valueType | String | 1 | OpenModelAttribute
|
externalId |
...
1
...
OnapModelLifecycle
- state: INPUT
OpenModelAttribute
...
.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.
| ||||
priorityuuid | StringUuid | 1 OnapModelLifecycle
OpenModelAttribute isInvariant | 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 | OnapModelLifecycle state: INPUTOpenModelAttribute
| The description of the service model designed.
| ||||
category | String | 1..* | OpenModelAttribute
| Narrative that explains the interaction and details about the interaction, such as why the interaction is taking placeA predefined list which identifies the construct's category. There is a predefined list of service categories.
| ||||
categoryversion | String | 1 OnapModelLifecycle state: INPUT | 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".
orderState | ||||
serviceRole | OrderStateString | 0..1 OnapModelLifecycle
OpenModelAttribute isInvariant | 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
| State The icon path of the orderservice.
| ||||
completionDateserviceComponentUuid | EDateUuid | 1 | OnapModelLifecycle
OpenModelAttribute isInvariantOpenModelAttribute
| The service component descriptor UUIDs that the service includes (relationhip to Service Component).
| ||||
_serviceDescriptor | ServiceDescriptor | 0..* | OpenModelAttribute
| The date on which an interaction is closed or completed.
| ||||
_serviceInstance | ServiceInstance | 0..* | OpenModelAttribute
|
requestedStartDate | ||||
_serviceComponentDescriptor | EDateServiceComponentDescriptor | 1 OnapModelLifecycle state: INPUT..* | OpenModelAttribute
|
| ||||
attachment | Attachment | 0..* | OpenModelAttribute
| The date that was requested to start processing the order.
| requestedCompletionDate | EDate | 1 | OnapModelLifecycle
OpenModelAttribute isInvariant
|
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
|
| |
expectedCompletionDatedscription | invalidString | 1 | OnapModelLifecycle state: INPUTOpenModelAttribute
|
| |
type | String | 1 | OpenModelAttribute
|
| |
category | String | 1 | OpenModelAttribute
|
| |
startDateserviceType | EDateString | 1 | OnapModelLifecycle state: INPUTOpenModelAttribute
|
| |
serviceRole | String | 1 | OpenModelAttribute
|
| |
notificationContactversion | invalidString | 1 OnapModelLifecycle state: INPUT | OpenModelAttribute
|
| |
resourcedescriptor | ResourceDescriptor | 0..* | OpenModelAttribute
|
| _serviceOrderItem | ServiceOrderItem
1.
...
OnapModelLifecycle
- state: INPUT
OpenModelAttribute
...
1.6 ServiceDescriptor
Applied stereotypes:
- OpenModelClass
- support: MANDATORY
Attribute Name | Type | Mult. | Stereotypes | Description |
invariantUuid | Uuid | 1 | OpenModelAttribute
| Constant identifier of the service model.
|
OrderDateuuid | EDateUuid | 1 OnapModelLifecycle
OpenModelAttribute isInvariant | OpenModelAttribute
| Versioned identifier of the service model (this uuid is changed for every major version of the service)
|
name | String | 1 | OpenModelAttribute
| The date the order was placedname of the service model designed.
baseType |
description | String | 1 | OpenModelAttribute
|
|
version | String | 1 | OnapModelLifecycle state: INPUTOpenModelAttribute
|
|
serviceinstance | ServiceInstance | 0..* | OpenModelAttribute
|
|
typeserviceType | String | 1 | OnapModelLifecycle
OpenModelAttribute isInvariantOpenModelAttribute
| 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".
|
schemaLocationicon | String | 1 | OnapModelLifecycle state: INPUTOpenModelAttribute
| The icon path of the service.
|
serviceComponentUuid | Uuid | 1 | OpenModelAttribute
| The service component descriptor UUIDs that the service includes (relationhip to Service Component).
|
ServiceOrderItem
The purpose for the ServiceOrder expressed in terms of a ServiceSpecification or a Service.
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:
- OnapModelLifecycleOpenModelClass
- statesupport: INPUTMANDATORY
- OpenModelClass
Attribute Name | Type | Mult. | Stereotypes | Description | ||||
id | String | 1 OnapModelLifecycle
OpenModelAttribute isInvariant | 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
| ||||
actiondescription | String | 1 | OnapModelLifecycle
OpenModelAttribute isInvariantOpenModelAttribute
| Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place.
| ||||
category | String | 1 | OpenModelAttribute
| The action to take for an InteractionItem, such as add, change, removeUsed 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 | StringOrderState | 1 OnapModelLifecycle state: INPUT | OpenModelAttribute
| State of the order
| ||||
completionDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is closed or completed.
| Quantity | Integer | 1 | OnapModelLifecycle
OpenModelAttribute isInvariant
|
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
| Quantity of an interaction item involved in an interactionThe date on which an interaction is expected to be completed.
| ||||
startDate | EDate | 1 | OpenModelAttribute
| The date on which an interaction is started.
| ||||
typenotificationContact | String | 1 OnapModelLifecycle
OpenModelAttribute isInvariant | 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.
| schemaLocation | String | 1 | OnapModelLifecycle
OpenModelAttribute isInvariant |
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.
baseType String |
1.1
...
OnapModelLifecycle
...
.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 ACKNOWLEDGED: InProgress
- IN_PROGRESS:
- Pending PENDING:
- Held HELD:
- Cancelled CANCELLED:
- Completed COMPLETED:
- Failed FAILED:
- Partial PARTIAL:
- Rejected REJECTED: