Page Comparison

Image Removed

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

Image Added

1.1.2 Service Order State Flow

Image Added

1.1 Classes

1.1.1 OrderItemRelationship

Enables specifying any kind of relastionships between ServiceOrderItems

Applied stereotypes:

OnapModelLifecycleOpenModelClass
- statesupport: INPUTMANDATORY
OpenModelClass

Attribute Name

Type

Mult.

Stereotypes

Description

id

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

type

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

isInvariant: false
valueRange:

no

no range constraint
support:

MANDATORY

Unique identifier for Interaction.

href

MANDATORY

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

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

valueType

String

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

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

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

Constant identifier of the service model.

priority

uuid

String

Uuid

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Versioned identifier of the service model (this uuid is changed for every major version of the service)

name

String

1

OpenModelAttribute

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The name of the service model designed.

description

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The description of the service model designed.

category

String

1..*

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

Narrative that explains the interaction and details about the interaction, such as why the interaction is taking place

A predefined list which identifies the construct's category. There is a predefined list of service categories.

category

version

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The service model version.

serviceType

String

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

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

OrderState

String

0..1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".

icon

String

1

OpenModelAttribute

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

State

The icon path of the

order

service.

completionDate

serviceComponentUuid

EDate

Uuid

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The service component descriptor UUIDs that the service includes (relationhip to Service Component).

_serviceDescriptor

ServiceDescriptor

0..*

OpenModelAttribute

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The date on which an interaction is closed or completed.

_serviceInstance

ServiceInstance

0..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

requestedStartDate

_serviceComponentDescriptor

EDate

ServiceComponentDescriptor

1

OnapModelLifecycle

state: INPUT

..*

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

attachment

Attachment

0..*

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

requestedCompletionDate

EDate

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

no range constraint
support: MANDATORY

The date that was requested to start processing the order.

1.1.5 ServiceDescriptor

Applied stereotypes:

OpenModelClass
- support: MANDATORY

Attribute Name

Type

Mult.

Stereotypes

Description

id

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

href

String

1

OpenModelAttribute

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The date on which an interaction is closed or completed.

name

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

expectedCompletionDate

dscription

invalid

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

type

String

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The date on which an interaction is expected to be completed.

category

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

startDate

serviceType

EDate

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

serviceRole

String

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The date on which an interaction is started.

notificationContact

version

invalid

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

resourcedescriptor

ResourceDescriptor

0..*

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

_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

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

Constant identifier of the service model.

OrderDate

uuid

EDate

Uuid

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Versioned identifier of the service model (this uuid is changed for every major version of the service)

name

String

1

OpenModelAttribute

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The

date the order was placed

name of the service model designed.

baseType

description

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

version

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

serviceinstance

ServiceInstance

0..*

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

type

serviceType

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

An optional string field for shortcode that defines the function that the service is providing. E.g. "MISVPN" or "AIM".

schemaLocation

icon

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The icon path of the service.

serviceComponentUuid

Uuid

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

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
- state: INPUT
OpenModelClass

...

- support: MANDATORY

Attribute Name

Type

Mult.

Stereotypes

Description

id

String

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

Unique identifier for Interaction.

externalId

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

no range constraint
support: MANDATORY

A way that can be used by order requester to prioritize orders in Service Order

action


description	String	1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

no range constraint
support: MANDATORY

The action to take for an InteractionItem, such as add, change, remove

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

String

OrderState

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

State of the order

completionDate

EDate

1

OpenModelAttribute

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support: MANDATORY

The date on which an interaction is closed or completed.

Quantity

Integer

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant


requestedStartDate	EDate	1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	The date that was requested to start processing the order.
requestedCompletionDate	EDate	1	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	The date on which an interaction is closed or completed.
expectedCompletionDate	EDate	1	OpenModelAttribute isInvariant: false valueRange:

no

no range constraint
support: MANDATORY

Quantity of an interaction item involved in an interaction

The date on which an interaction is expected to be completed.

startDate

EDate

1

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

The date on which an interaction is started.

type

notificationContact

String

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

isInvariant

OpenModelAttribute

isInvariant: false
valueRange: no range constraint
support: MANDATORY

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

no range constraint
support: MANDATORY

The date the order was placed.

1.1.8 ServiceOrderItem

...

schemaLocation

...

String

...

1

OnapModelLifecycle

state: INPUT

OpenModelAttribute

...

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 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	OpenModelAttribute isInvariant: false valueRange: no range constraint support: MANDATORY	The action to take for an InteractionItem, such as add, change, remove.
state	OrderState	1	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	OpenModelAttribute isInvariant: false valueRange:

no

no range constraint
support: MANDATORY

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

isInvariant

isInvariant: false
valueRange:

no

no range constraint
support:

MANDATORY

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:

Versions Compared

Old Version 1

New Version Current

Key

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.2 Service Order State Flow

1.1 Classes

1.1.1 OrderItemRelationship

1.1.2 OrderRelationship

1.1.3 ServiceCharacteristic

1

.1.4 ServiceDescriptor

1.1.5 ServiceDescriptor

1.

1.6 ServiceDescriptor

ServiceOrderItem

1.1.7 ServiceOrder

1.1.8 ServiceOrderItem

1.1

.9 Value

1.2 Data Types

1.3 Enumerations

1.3.1 Action

1.3.2 OrderPriority

1.3.3 OrderState