Skip to main content
Version: 4.17.3

Recipient component

The Recipient component allows you to route messages to multiple dynamically specified recipients.

Configuration

The Recipient component has the following configuration options:

Exchange pattern

Specify when the message is send to the next recipient route.

Options

  • One way
  • Request reply (default)
order

Messages are always routed sequentially in the order (1, 2, 3, etc), as specified on the connection labels.

Request reply

With this option, the component sends the message to one recipient at a time, waiting for each to finish processing before moving to the next. This ensures that the first recipient processes the message before it is sent to the second recipient, and so on.

In a flow that's completely configured as Request reply, the response that is sent back is the result from the last recipient in the sequence. This is indicated by a blue-colored label.

caution

If an error occurs in any recipient route, subsequent routes will not be executed.

One way

This option allows messages to be processed by multiple recipients simultaneously without waiting for one to finish before sending to the next. While the specified order is still respected, this improves performance as recipients can process messages concurrently.

In a flow that's completely configured as Request reply, the response that is sent back is the message that entered the Recipient component.

note

If an error occurs in one recipient route, it does not affect the execution of others.

Using Recipient

Each recipient receives a copy of the same message. The component sends messages sequentially, adhering to the configured Exchange Pattern option. Each recipient connection has a label indicating the order in which messages will be sent.

Example usage of Recipient component
Re-arranging outputs

When disconnecting / reconnecting recipient outputs, their order may change. Verify the order is correct or disconnect all outputs and reconnect them in the desired sequence.

Last update on Jan 8, 2024