Hide If | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
|
Show If | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
Managed Entity and Task Resource ModelsProductOrder lifecycleHere is the state machine diagram for a product order. Each order states are described in the tab below.
ProductOrderHere under a product order composed of 4 order lines (orderItems) :
|
...
Here is the state machine diagram for a product order. Each order states are described in the tab below.
The order item states are the same as the order ones. Note that the order and order item states are tightly linked and need to be consistent, for example :
- Order, state : InProgress
- Order item 1, state : InProgress (Valid)
- Order item 2, state : Pending (Valid)
- Order item 3, state : Held (Valid)
- Order item 4, state : Completed (Valid until there is another order item which is NOT completed)
- Order item 5, state : Cancelled (Not valid : if an order item is cancelled, maybe the whole order should be cancelled too)
...
Acknowledged
...
The Acknowledged state is where an order has been received and has passed message and basic business validations.
...
In Progress
...
The In Progress state is where an order has passed the Order Feasibility check successfully and service delivery has started.
...
Cancelled
...
The Cancelled state is where an In-Flight Order has been successfully cancelled.
...
Completed
...
The Completed state is where an order has complete provision and the service is now active.
...
Rejected
...
The Rejected state is where:
- An order failed the Order Feasibility check
- Invalid information is provided through the order request
- The order request fails to meet business rules for ordering.
...
Pending
...
Held
...
The Held state is used when an order cannot be progressed due to an issue. SP has temporarily delayed completing an order to resolve an infrastructure shortfall to facilitate supply of order. Upon resolution of the issue, the order will continue to progress.
...
Failed
...
All Order items have failed which results in the entire Order has Failed.
...
Partial
...
Some Order items have failed and some have succeeded so the entire Order is in a Partial state. This provides support for partial Failure of an Order
...
Here under a product order composed of 4 order lines (orderItems) :
- Line "1" : Purchasing of a new simple product that needs a physical delivery place and an appointment to be delivered
- Line "2" : Modification of a characteristic value of an already owned product, and change the user associated to this Product
- Line "3" : Purchasing of a new simple product that needs (is supported by) another already owned product (in this case for example a new product that relies on the owned mobile access product to be installed)
- Line "4" : Purchasing of a bundled product composed of two atomic products
...
|
...
|
...
|
...
|
...
Five notification types are defined :
- orderCreationNotification
- orderRemoveNotification
- orderStateChangeNotification
- orderValueChangeNotification
- orderInformationRequiredNotification
...
Used to notify that a new order has just been created.
{ "eventId":"00001", "eventTime":"2013-04-19T16:42:25-04:00", "eventType":"orderCreationNotification", "event":{ "productOrder":{ "id":"42", "href":"http://serverlocation:port/orderManagement/productOrder/42", "externalId":"NiceNameForTheConsumer_42", "priority":"1", "description":"A wonderful 42 order for brand new products", "category":"residential", "state":"InProgress", "orderDate":"2013-04-12T16:42:23-04:00", "completionDate":"2013-04-19T16:42:23-04:00", "requestedStartDate":"2013-04-12T16:42:23-04:00", "requestedCompletionDate":"2013-04-19T16:42:23-04:00", "expectedCompletionDate":"2013-04-19T16:42:23-04:00", "notificationContact":"[email protected]", |
...
Used to notify that an order was deleted.
{ "eventId":"00002", "eventTime":"2013-04-19T16:42:25-30:00", "eventType":"orderRemoveNotification", "event":{ "productOrder":{ "id":" 42", |
...
Used to notify that an order state is evolving.
{ "eventId":"00003", "eventTime":"2013-04-19T16:42:25-30:00", "eventType":"orderStateChangeNotification", "event":{ "productOrder":{ "id":" 42", |
...
Used to notify that any data in an order has just changed.
{ "eventId":"00004", "eventTime":"2013-04-19T16:42:25-30:00", "eventType":"orderValueChangeNotification", "event":{ "productOrder":{ "id":" 42", |
...
Used to notify that some data in the order needs to be filled / is missing.
- "resourcePath" allows to precise if it is a data at order level or at orderItem level (and which one of them) that is missing
- "fieldPath" details which field is missing, its structure is quite similar to GET filter criteria
- "missing=" points at the missing field
- "&<criteria>" can be used to identify a specific element in lists
Simple example : notification contact is missing
{ "eventId":"00005", "eventTime":"2013-04-19T16:42:25-30:00", "eventType":"orderInformationRequiredNotification", "resourcePath":"/order/42 ", "fieldPath":"missing=notificationContact", "event":{ "productOrder":{ "id":" 42", "href":"http://serverlocation:port/orderManagement/productOrder/42", "externalID":"NiceNameForTheConsumer_42" }}} |
...
|
© TM Forum 2015. All Rights Reserved.
...