Open APIs

We have a use case where the commercial order is to be kept on Hold (for a certain period) because a Cancel intent is raised by the Customer. During the hold period, the delivery manager will discuss with the customer regarding the cancellation.

The commercial order status will be "Assess Cancellation"

This hold also needs to be informed to Service Order Management (SOM) system as the associated service order is progressing at SOM. This is not a cancellation request to SOM but just a request to hold all the further provisioning activities until further communication.

i have below queries

1. how can we add any hold reason if we need to pass it to downstream? I can't find any placeholder in the order resource 
2. Do we also send the service item status or service status in this case? Or status at service order is fine for SOM to put all the activities for that service order on hold.
3. Kindly suggest if there is any other better option to inform hold to SOM? P.S: TMF688 is currently not supported by our system

Suggest if something like the below would work?

1. Using TMF641 PATCH request with status = Held

{

  "state": "held",

  "note" / "Reason" : [

    {

      "text": "Commercial Order on hold due to cancel intent. Pause all service activities."

    }

  ],

And if the cancel intent was withdrawn then can we use the below to communication to SOM?

PATCH /serviceOrder/{id}

{

  "state": "inProgress",

  "note" / "Reason" : [

    { "text": "Cancel intent withdrawn. Resume service execution." }

  ]

}

------------------------------
Nilesh Bawiskar
Infosys
------------------------------

Hi Nilesh 

Regarding your questions, I give you my opinion.

1. how can we add any hold reason if we need to pass it to downstream? I can't find any placeholder in the order resource 
   • I think you can also consider not to hold but cancel the provisioning until you can resolve the "Cancel intent". If you have a "possitive" answer you can consider triggering a provisioning action at that moment. During this period of time, you can manage status of the transaction (event) in order to have the traceability.
2. Do we also send the service item status or service status in this case? Or status at service order is fine for SOM to put all the activities for that service order on hold.
   • The status is very important for this kind of event. If there are other activities generated (SOM), these must be cancelled and reactivated when you have a "positive" responde after the period of Cancel intent.

Regards

Raul

Hi Nilesh,

The 'held' requested state is certainly an option. In most order processes there is the concept of 'holding' (not proceeding any activities associated with it) across multiple industries. It should - probably be associated (or might trigger) the 'suspend' of all processes - e.g. in BPMN processes there is the concept of suspending the process, which means no activity (automated or manual) can be completed.

With 'held' you also need to consider the eventual outcome:

1. The order might proceed - in which case you need to think about modifying the order to change the state to provide/amend/cancel (whatever it was before the 'held' commenced) - as outlined in your example.
2. The order might be cancelled - in which case you are in the more complicated domain of rolling back any activities in the provide process that had completed before 'held' was initiated and/or cancelling any sub-services that might have been created as part of a decomposition.