Properties View Correlation Tab

Use the Correlation tab to specify how an in-bound response from an external system correlates back to the original outbound message that initiated the communication with the external system.

The Properties view Correlation tab appears only for Automator and Sender plug-in types defined as external event receivers. The Correlation parameter is mandatory and defaults to Message Property, which in turn defaults to JMSCorrelationID.

Field	Use
Correlation	Select the method for correlating responses from external systems with the originating response: Based on a Message Property. Message property correlation provides the ability to correlate the incoming message with the appropriate automated task, based on a message property defined in the message header. Message property correlation is the simplest and most commonly used form of correlation. The default message property is JMSCorrelationID, which is a JMS-generated number that is placed in the header of all OSM outbound messages. You have the option to change the message property to something other than JMSCorrelationID, and being responsible for setting the value on all outbound messages that expect an in-bound response. Based on an element in the XML Body XML body correlation provides the ability to correlate a response message based on a message property defined in the message body, such as particular data field. If used, the XML Body field is defined as an XPath. The Correlation parameter is mandatory and defaults to Message Property, and the system sets the corresponding default value for the Message Property field to JMSCorrelationID.
Message Property or XML Body	This field is conditional to the selection that you make in the Correlation field. If you selected Message Property in the Correlation field, the system supplies the standard JMS correlation property JMSCorrelationID. The OSM order correlates with incoming events from external systems when the JMSCorrelationID on the order and on the message matches. If you selected XML Body in the Correlation field, you can enter an XPath expression to point to an element in the XML body of the message. The value for this element in the OSM order must match the value for the same element on the incoming message. Note: XPath and XQuery fields are limited to 4000 characters.

Field

Use

Correlation

Select the method for correlating responses from external systems with the originating response:

Based on a Message Property.

Message property correlation provides the ability to correlate the incoming message with the appropriate automated task, based on a message property defined in the message header. Message property correlation is the simplest and most commonly used form of correlation. The default message property is JMSCorrelationID, which is a JMS-generated number that is placed in the header of all OSM outbound messages. You have the option to change the message property to something other than JMSCorrelationID, and being responsible for setting the value on all outbound messages that expect an in-bound response.
Based on an element in the XML Body

XML body correlation provides the ability to correlate a response message based on a message property defined in the message body, such as particular data field. If used, the XML Body field is defined as an XPath.

The Correlation parameter is mandatory and defaults to Message Property, and the system sets the corresponding default value for the Message Property field to JMSCorrelationID.

Message Property or XML Body

This field is conditional to the selection that you make in the Correlation field. If you selected Message Property in the Correlation field, the system supplies the standard JMS correlation property JMSCorrelationID. The OSM order correlates with incoming events from external systems when the JMSCorrelationID on the order and on the message matches.

If you selected XML Body in the Correlation field, you can enter an XPath expression to point to an element in the XML body of the message. The value for this element in the OSM order must match the value for the same element on the incoming message.

Note: XPath and XQuery fields are limited to 4000 characters.