OrderLine Action Change

In this amendment type, the fulfillment action in an order line can be changed as part of the amendment request. E.g. action was PROVIDE in an order line in the original order request and changed to UPDATE in the amendment request. Since CANCEL can also be passed as the action in one or all the order lines in the amendment request, order line cancellation and entire order cancellation are the sub-types of this amendment type.

OrderLine Cancellation

In order to cancel a particular order line, CANCEL must be passed as action in the amendment request. The PENDING plan items associated to the order line are directly CANCELLED. Execution Plan Modification Rules are applied on the plan items that were COMPLETE or SUSPENDED before the amendment so as to compensate them, as per the EPMR action defined in the product model. Once all the associated plan items are either cancelled or compensated, the order line is marked as cancelled by changing its status to CANCELLED.

Entire Order Cancellation

In order to cancel the entire order, CANCEL must be passed as action in all the order lines in the amendment request. All the PENDING plan items in the execution plan are directly CANCELLED. Execution Plan Modification Rules are applied on the plan items that were COMPLETE and SUSPENDED before the amendment to compensate them, as per the EPMR action defined in the product model. Once all the plan items are either cancelled or compensated, all the order lines and also the order is marked as cancelled by changing the statuses to CANCELLED. The Execution Plan Modification Rules are applied in case of order line or entire order cancellation, based on the boolean value (true/false) of the rollback UDF passed in the order header. The modification rules will be applied if the rollback UDF's value is true, otherwise it will not be applied.

Note:

The default behavior is always to rollback, that is, if the rollback UDF is not passed in the order header, it will be considered to be true.

An order can also be cancelled using the CancelOrderRequest SOAP service and from OMS UI.

Preconditions for Action change

Following are the preconditions for the order line action change amendment type.

  1. The number of order lines in the amendment request must match with those in the original order request.
  2. The lineID, productID, requiredByDate, and UDFs in all the order lines in the amendment request must match with those in the original order request.

When the fulfillment action in an order line is changed, the plan items associated with that order line in the existing plan are handled in different ways.

  1. The action in the amendment request is set as the fulfillment action in all PENDING plan items.
  2. Execution Plan Modification Rules (EPMR) are applied to all SUSPNEDED or COMPLETE plan items to take the appropriate actions on these plan items such as compensating the earlier tasks and/or redoing the tasks from beginning.

For any action change in the amendment request other than CANCEL, the EPMR characteristic corresponding to the action in the original plan item, from the product being fulfilled by that plan item, is considered while applying the modification rule.

OrderLine Action in Original Request OrderLine Action in Amendment Request EPMR Characteristic Considered
PROVIDE Any, except for CANCEL and PROVIDE EPMR_ACTION_PROVIDE
UPDATE Any, except for CANCEL and UPDATE EPMR_ACTION_UPDATE
CEASE Any, except for CANCEL and CEASE EPMR_ACTION_CEASE

On the other hand, if CANCEL is passed as the order line action in the amendment request, the EPMR_ACTION_WITHDRAW characteristic from the product being fulfilled by the corresponding plan item is considered always, regardless of the action in the original request.

Based on the value of the EPMR characteristic that was considered, the modification rules will be applied on the required plan items. See topic Execution Plan Modification Rules (EPMR) to understand the effect of each action.

Note: If the EPMR characteristic to be considered (e.g. EPMR_ACTION_PROVIDE) is not present in the corresponding product model, COMPENSATE_RESTART will be considered as the default EPMR action, only if the flag CompensateRestartForNoEPMRChar is set in AOPD configurations. See the topic Amendment Configuration Flags to understand the significance of each flag.

Once the EPMR action is applied on all the required plan items and the compensatory and/or redo plan items are generated, the dependencies in the parent plan items will be updated appropriately. See topic Impact on Dependencies to understand how the dependencies are modified. The amendment plan is sent out to Orchestrator so as to fulfil the order sent in the amendment request.