Order Editor Amendable Tab

Use the Order editor Amendable tab to configure the order to allow amendment processing. The following table describes the options on the Order editor Amendable tab.

Options Use

Not Amendable

Select to indicate that there can be no amendment processing against this order.

Amendable

Select to allow amendment processing against this order.

Key

Specify an order key as an XPath to a node that will uniquely match an amended order to its corresponding OSM order.

For example, you might specify a customer reference ID as an XPath using the following expression:

_root/Cust_Ref_ID

Alternatively, you can select a data node from the Data Element view and drag the selected data node into the XPath Expressions field to define the XPath expression. To drag a data node into the XPath Expressions field, press and hold the Alt key before you select and drag the data node to the field.

Note: XPath uses path expressions to select data nodes in XML documents. A path expression with a single dot (.) represents the current node. Two dots (..) represents the parent of the current node. A slash (/) represents the root node.

XPath and XQuery fields are limited to 4000 characters.

Version

Specify the version as an XPath to a node that will return a numeric value representing the version of an amended order.

Amendments with higher versions are considered to be more recent than amendments with lower versions. If there are multiple queued amended orders for the same original order, OSM processes only the most recent amendment version.

You can select and drag a data node from the Data Element view into the XPath Expressions field to define the XPath expression. To drag a data node into the XPath Expressions field, press and hold the Alt key before you select and drag the data node to the field.

Note: XPath uses path expressions to select data nodes in XML documents. A path expression with a single dot (.) represents the current node. Two dots (..) represents the parent of the current node. A slash (/) represents the root node.

XPath and XQuery fields are limited to 4000 characters.

Events

Select one or more events to be published at run time for this order type. OSM events are sent to the JMS destination OrderStateChange.Event queue and are published as topics. External systems can subscribe to this queue and retrieve the published events.

Amendment Abandoned

Select to publish this event when multiple amendments have been sent to OSM and an amendment has rendered an earlier version of amendment unnecessary.

If an amendment is in progress, OSM puts any subsequent amendments in a queue for processing. If multiple amendments have been sent to OSM, the server processes the next amendment in the queue by selecting the highest version (optionally defined in the Version field) or the amendment with the most recent timestamp if no version has been defined. When multiple amendments are queued, the OSM server processes only the most recent amendment.

Amendment Completed

Select to publish this event when amendment processing has completed.

Amendment Started

Select to publish this event when amendment processing begins for any revision order.

Amendment Queued

Select to publish this event when amendment processing for a revision order is queued.

Amendment Terminating

Select to publish this event when amendment processing for a revision order is in the process of getting terminated.

Amendment Terminated

Select to publish this event when amendment processing for a revision order is terminated.

State Change

Select to publish this event when the order transitions from one state to another.

Order Created

Select to publish this event when the order is created in OSM.

Order Removed

Select to publish this event when the order has been deleted.