Boomi Atom Queue operation - Legacy

important

Atom Queues are now Legacy. We recommend using Event Streams for your event-based and messaging use cases.

The Boomi Atom Queue operation defines what you want to do (Get, Send, or Listen) with a Runtime message queue.

The Boomi Atom Queue operation supports three types of actions:

• Get — Used to retrieve messages from a message queue.

• Send — Used to send messages to a message queue.

• Listen — Used for event-driven retrieval of messages from a message queue.

Options tab, Get action

Set up the Get action to retrieve documents from an Atom Queue with precise control over timing, message quantity, and error recovery.

1. Set the Timeout (ms) to control the amount of time, in milliseconds, that the operation waits to receive documents. The default is 10,000.

• 10,000 (default): Waits up to 10 seconds to receive documents.

• 0: The operation does not wait and receives only the documents in a single message if one is immediately available.

  note

  Resultant behavior cannot be guaranteed when the Timeout (ms) value is set to 0.

• -1: The operation waits for an infinite amount of time to receive documents.

2. Enter the number for the Minimum number of documents field to receive within the Receive Timeout (ms) period. The default is 3. Upon receipt of the specified number of documents, execution of the process proceeds without waiting for the period to expire.

3. Enable the Consume from Dead Letter Queue? (Point-to-Point Only) option, if the connector has to retrieve a list of dead letters from a Point-to-Point message queue.

• Dead letters are messages that cannot be delivered successfully to subscribers due to any variety of issues.

• Programmatic retrieval of dead letters allows you to process these failed messages as you see fit.

• For example, resubmitting the dead letter to an active queue is an expected use case of this feature.

  • When this option is turned on, only dead letters are consumed from the Point-to-Point queue; regular messages are not consumed.
  • When this option is turned off (default), the connector consumes message from the regular queue without checking for dead letters.

note

Get action leaves messages on the queue if the main JVM/SQS memory is insufficient to retrieve all the messages.

Options tab, Send action

If the operation is configured with a Send action, document processing concludes with the execution of the Boomi Atom Queue connector step. When you configure a Send action, the following field appears on the Options tab:

1. Enter the number for Batch Size field to set the number of documents to batch in each outgoing message. The default is 5. A value of 0 means all documents will be sent in a single message.

Options tab, Listen action

tip

You can view the status of listener processes that are deployed to a Runtime, Runtime cluster, or runtime cloud to retrieve messages from a message queue by going to the Listeners panel in Manage > Runtime Management. In that panel, you can also pause, resume, and restart listeners.

1. Set the Known issue field as the LISTEN operation always fails the first document of every batch if any document in the batch fails. The GET operation fails only the offending document but does not affect others in the batch.

2. Enable the Consume from Dead Letter Queue? (Point-to-Point Only) option if the connector retrieves a list of dead letters from a Point-to-Point message queue.

   • Dead letters are messages that cannot be delivered successfully to subscribers due to any variety of issues.
   • Programmatic retrieval of dead letters allows you to process these failed messages as you see fit.
   • For example, resubmitting the dead letter to an active queue is an expected use case of this feature.
     • When this option is turned on, only dead letters are consumed from the Point-to-Point queue; regular messages are not consumed.
     • When this option is turned off (default), the connector consumes message from the regular queue without checking for dead letters.

3. Set the Maximum Concurrent Executions value to to limit the number of concurrent Boomi Atom Queue listener processes. If you send hundreds of messages to the queue, hundreds of processes are executed. This could cause the Runtime to run out of memory and crash.

For Runtime clusters, this limit is per node in a cluster.

• If you set this field to a value less than or equal to zero, an unlimited number of Boomi Atom Queue listener processes can be executed in parallel and messages are not sent to the Dead Letter Queue.

• If you set this field to a value greater than zero, then up to that many Boomi Atom Queue listener processes can be run simultaneously. The listener starts this number of Boomi Atom Queue listener instances, all listening on the same queue. The listeners wait until a process completes before consuming the message. If a process fails, the message is not consumed and the process is retried six times; the process is placed in the Dead Letter Queue on the seventh failed retry. You should not set this value to a large number because doing so consumes additional messaging resources.

note

For performance reasons, listeners will reserve messages. This may result in reading less messages at once than the value you set in Maximum Concurrent Executions. For example, if 2 out of 20 messages are being processed, the remaining 18 messages are unavailable to other listeners. This occurs when the same listeners currently processing messages are reserving the remaining messages.

4. Select the Exclusive Consumer? checkbox if only a single listener node in a Runtime cluster or runtime cloud processes messages. If that node fail, a new listener automatically begins processing messages on a different node.

To receive first-in, first-out (FIFO) processing of messages across nodes, set the Maximum Concurrent Executions value to 1. FIFO is not guaranteed on Runtime clusters and runtime clouds.

This check box is disabled if Maximum Concurrent Executions is set to a value other than 1.

note

Test mode does not support real-time triggering and, therefore, cannot be used with listener processes.

Archiving tab

See the topic Connector operation’s Archiving tab for more information.

Tracking tab

See the topic Connector operation’s Tracking tab for more information.

Caching tab

See the topic Connector operation’s Caching tab for more information.