Service Order

Diagrams

../../../_images/ServiceOrder.png

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.

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.

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: