EMS Request Reply Activity

The EMS Request Reply is an asynchronous activity that is used to send a request to an EMS destination and wait for a response from the EMS client.

Note: This activity uses temporary destinations to ensure that reply messages are received only by the process that sent the request. However, the user can use preexisting EMS destinations.

Settings

On the Settings tab, configure the following settings:

Field Required Description
EMS Connection Yes Name of the connection.
Destination Type No The following options are available for the destination type:
  • Queue
  • Topic
Destination   Name of the destination.
Reply to Destination  

The destination to use for replies for the EMS Request Reply activity.

Note: If more than one job has the same value for the Reply To Destination field, each job may not receive the correct reply. Ensure to specify an expression in this field that assigns a different Reply To Destination to each process instance.
Delivery Delay   Delivery Delay is the minimum length of time, in milliseconds that must elapse after a message is sent before the JMS provider may deliver the message to a consumer.
Request Timeout   This field specifies the amount of time, in milliseconds that the EMS Request Reply activity waits before it times out.

Input

The Input tab has the following fields:

Field Required Description
Message Yes The option available for the message format is string.
Destination The destination to which a message is sent. This input item overrides the Destination field on the Settings tab.
Headers 

correlationID: This ID is used to link a response message with its related request message. This is usually the message ID of a request message when this field is found in a reply message. The default value is empty.

replyTo: The EMS destination where the reply message is sent. The default value is empty.

You can set this on the Settings tab by entering the value for the Reply to Destination field. The value entered here under the Headers has more priority if this is entered in both the places.

deliveryMode: The delivery mode of the message. It can be one of the following:

  • PERSISTENT: It signifies the messages are stored and forwarded.

  • NONPERSISTENT: In this mode, messages are not stored and may be lost due to failures in transmission.

  • reliable: This mode is only available when using the TIBCO Enterprise Message Service. For more information, see the TIBCO Enterprise Message Service documentation.

The default value is PERSISTENT.

expiration: It establishes the expiration time of the message. The time is expressed as the amount of time, in milliseconds since midnight, January 1, 1970, UTC. If set to 0, the message does not expire. The default value is 0.

priority: The priority of the message. Priority is a value from 0 to 10. Higher numbers signify a higher priority (that is, 8 is a higher priority than 7). The default value is 4.

Output

The Output tab has the following fields:

Field Required Description
replyMessage Yes The reply message is a string. It is the body of the reply message.
Headers 

destination: The EMS destination from where the flow starter receives the message.

replyTo: The EMS destination where the reply message is sent. The default value is empty.

deliveryMode: The delivery mode of the message. It can be one of the following:

  • PERSISTENT: It signifies the messages are stored and forwarded.

  • NONPERSISTENT: In this mode, messages are not stored and may be lost due to failures in transmission.

  • reliable: This mode is only available when using the TIBCO Enterprise Message Service. For more information, see the TIBCO Enterprise Message Service documentation.

messageID: The unique ID of the message.

timestamp: The time a message was handed off to an EMS provider to be sent. The time is expressed as the amount of time, in milliseconds, since midnight, January 1, 1970, UTC.

expiration: The expiration time of the message. The time is expressed as the amount of time, in milliseconds since midnight, January 1, 1970, UTC. If set to 0, the message does not expire. The default value is 0.

redelivered: Typically, this item is set when the EMS provider has delivered the message at least once before.

priority: The priority of the message. Priority is a value from 0 to 10. Higher numbers signify a higher priority (that is, 8 is a higher priority than 7). The default value is 4.

correlationID: This ID is used to link a response message with its related request message. This is usually the message ID of a request message when this field is found in a reply message. The default value is empty.

Loop

If you want this activity to iterate multiple times within the flow, enter an expression that evaluates the iteration details. Select a type of iteration from the Type menu. The default type is None, which means the activity does not iterate. For more information, see the Using the Loop Feature in an Activity section in the Flogo® app documentation.