You are here:
Settings to Support Canceling Orders
When installing or upgrading CME, you can create a remote site setting to support such actions as canceling orders, and accessing the streaming API. Once you have created the remote site setting, you do not need to do it again for subsequent CME upgrades.
There are three parts that support canceling orders:
-
A streaming channel, which is automatically installed.
-
A remote site setting, which you must add.
-
Interfaces and implementations, specifically:
-
XOMSupplementalOrderLifeCycle implementation: Before CME Winter '20, this was the only implementation to handle the full life cycle of a supplemental order when only Cancel was implemented. There was no unified interface to submit a simple order and assetize it.
For CME Winter '20, the OdinAPIHandler (ODIN) interface was introduced to deal with the life cycle for any kind of order (such as Simple, MACD, or Supplemental) between CPQ and Order Management (OM). In OM Standard, this interface was directly implemented with XOMOMStandardOdinAPIHandler instead of using the default OdinStandardAPIHandler. This release also kept the other implementation, XOMSupplementalOrderLifecycleImpl, to deal with Supplemental order calls during cancellation.
As of CME Spring '20, only the OMOMStandardOdinAPIHandler is used and XOMSupplementalOrderLifecycleImpl is no longer used. OM Plus uses the standard implementation to deal with extra interfaces, such as SendSubmitToOM, SendFreezeToOM, SendUnfreezeToOM, and OdinSubmitOrderExtraFields.
-
SupplementalOrderService interface: This interface is used within the OdinAPIHandler interface, specifically within the OdinAPIAutoAssetizeHandler implementation. When the
preValidateAPI orunfreezeOrderAPI call is made from the client, the call uses the implementation configured for the OdinAPIHandler. If OdinAPIAutoAssetizeHandler is the active implementation of the OdinAPIHandler interface, then it internally calls the SupplementalOrderService interface. The only out-of-box implementation for SupplementalOrderService is SupplementalOrderServiceImplementation. -
XOMSupplementalOrderLifecycleImpl implementation: This interface is used from SupplementalOrderServiceImplementation. When the OdinAPIHandler interface is configured with OdinAPIAutoAssetizeHandler as the active implementation, any call to the preValidate API or unfreezeOrder API call is handled through SupplementalOrderService. The only out-of-box implementation for SupplementalOrderService is SupplementalOrderServiceImplementation. This interface (XOMSupplementalOrderLifeCycle) helps SupplementalOrderServiceImplementation freeze and unfreeze orders.
-
XOMSupplementalOrderLifeCycle interface: This implementation is for the XOMSupplementalOrderLifeCycle interface. It provides a stub for the freezeOrder and unfreezeOrder API calls. This interface is invoked only when the OdinAPIHandler interface has OdinAPIAutoAssetizeHandler as the active implementation and SupplementalOrderService interface has SupplementalOrderServiceImplementation as the active implementation.
-
To support canceling orders, you must add your Salesforce org base URL to the remote site settings.
To create a remote site setting:
- From Setup, in the Quick Find box, enter Remote Site.
- Click Remote Site Settings.
- Click New Remote Site.
-
On the Remote Site Edit page, enter
the following information:
-
Remote Site Name is StreamingAPI.
-
Remote Site URL is the base URL of the CPQ cart. To determine this URL, go to an order and navigate to the CPQ cart, which will have a URL such as
https://cmt-106-vlocity-cmt.na72.visualforce.com/apex/hybridcpq?id=8011H000FEZ84RA5. It should include the namespace. The value for the corresponding Remote Site URL ishttps://cmt-106-vlocity-cmt.na72.visual.force.com.For new Installations, the StreamingAPI should be set as the Remote Site Name.
You need to switch to Salesforce Classic before you invoke the Cart to see that version of the URL.
-
- Do not select Disable Protocol Security. Leave it set to false.
- Select Active.
- Click Save.
