Reply To Message
Reply To Message responds to a request that arrived through JMS Receiver. It is the responder half of a JMS request/reply exchange — the counterpart to JMS Request Reply on the requester side.
Where the reply goes is resolved in order: the input replyTo if set, otherwise the
incoming request's replyTo header, otherwise the Reply Destination configured here.
Mapping the receiver's output into requestMessage is what supplies the second of those,
along with the correlation identifiers.
The activity has four tabs: Configuration, Advanced, Input, and Output.
Configuration
| Field | Required | Description |
|---|---|---|
| Name | Optional | Name of the component. |
| Description | Optional | Description of the component. |
| JMS Connection | Optional | The JMS connection resource used to send the reply. |
| Reply Message Type | Optional | How the reply payload is serialized into the outbound JMS response message: Text, Byte, Object, Stream, or Map. Defaults to Text. |
| Reply Destination | Optional | Used when the input replyTo is blank. For standard JMS request/reply, map replyTo from the receiver's jmsOutput.messageHeaders.replyTo, or configure a fixed reply destination here. |
Advanced
| Field | Required | Description |
|---|---|---|
| Fallback Reply Type | Optional | Queue or Topic. Defaults to Queue. |
| Correlate With Request Message ID | Optional | If the request has no JMSCorrelationID, set the reply JMSCorrelationID to the request JMSMessageID. Defaults to selected. |
| Acknowledge Source On Reply | Optional | Acknowledge the source message when the reply is sent. Defaults to selected. |
Acknowledge Source On Reply applies only when the input contains a manual JMS ack token from JMS Receiver.
Input
| Field | Data Type | Description |
|---|---|---|
| payload | Any | Reply payload sent as the JMS body. |
| replyTo | String | Reply destination override. When blank, the activity uses requestMessage.messageHeaders.replyTo, then the configured Reply Destination. |
| requestMessage | Object | Original JMS request message metadata. Usually map the receiver's jmsOutput here. |
| replyMessageHeaders | Object | Standard JMS headers to set on the outgoing reply. Usually leave blank; correlation is copied from requestMessage by default. |
payload follows Reply Message Type: Text sends a plain string when mapped from a
string, or JSON text for objects and arrays, and Map requires an object and sends a JMS
MapMessage.
requestMessage
| Field | Data Type | Description |
|---|---|---|
| ackToken | String | Manual acknowledgement token from JMS Receiver when its mode is Manual / early acknowledge. |
| messageHeaders.replyTo | String | Original request JMSReplyTo destination. The reply is sent here when present. |
| messageHeaders.correlationId | String | Original request JMSCorrelationID. Reused on the reply when present. |
| messageHeaders.messageId | String | Original request JMSMessageID. Used as the reply JMSCorrelationID when correlationId is blank. |
replyMessageHeaders
| Field | Data Type | Description |
|---|---|---|
| correlationId | String | Reply JMSCorrelationID override. |
| type | String | Reply JMSType value. |
| priority | Integer | Reply JMSPriority override. |
| deliveryMode | Integer | Reply JMSDeliveryMode override: 1 is non-persistent, 2 is persistent. |
Output
The activity returns a replyToMessageOutput object.
| Field | Data Type | Description |
|---|---|---|
| messageSent | Boolean | True when the message was sent to the JMS destination. |
| replyDestination | String | Queue or topic that received the reply. |
| payload | Object | Decoded JMS payload. |
| messageHeaders | Object | Standard JMS headers plus configured and custom JMS properties. |
| properties | Object | Configured JMS application properties. |