Multi-Site Message Received

This tool is the initiator for a handler that will send a specific message.

Initiator Properties

Label

The label that is displayed for this tool step on the main ID screen. The default label is "Multi-Site Message Received."

Object ID

A string value that matches the Object ID set in Multi-Site Send Event or Multi-Set Send Request.

Notification Event

A string Value that matches the Object ID set in Multi-Site Send Event or Multi-Set Send Request.

Outputs

Message Handle

The handle of the incoming message from which the data elements are to be read. The message handle is a value that is required as input for all tools that operate on the message.

Response Correlation ID

A unique identifier for this message if the message was sent synchronously. Otherwise, this value will be zero. If the message requires a response, the value of the variable will contain a non-zero value. This value must be passed unchanged o the Multi-Site Send Response tool.

Response Destination ID

A value that identifies the source of the request if the message was sent synchronously. If the message was sent asynchronously, this value will be an empty string. This value must be passed unchanged to the Multi-Site Send Response tool.

Note

The values in Response Correlation ID and Response Server ID should not be changed by the handler.