Solace Acknowledge flow-node
2 minute read
Overview
The Solace Acknowledge flow-node sends an application acknowledgment to the Solace event broker.
It is part of the Solace plugin, @axway/api-builder-plugin-ft-solace., and is used along with the Solace Consumer flow-trigger when connected to a queue that is configured with a Client Queue acknowledge mode. If the Queue acknowledge mode is set to Auto, the Solace Consumer flow-trigger will automatically send an application acknowledgment to the Solace event broker and this flow-node is not required.
You can install the Solace plugin from the Plugins page, or execute the following command:
npm install @axway/api-builder-plugin-ft-solace
For additional getting started information, refer to the Getting Started With API Builder.
Methods
The following sections provide details of the available Solace Acknowledge flow-node methods.
Acknowledge
Acknowledge message receipt for Solace queues.
Parameters
| Parameter | Type | Description | Configuration selection | Required |
|---|---|---|---|---|
| Solace Consumer request | Object | The request object from a Solace Consumer flow-trigger where “Queue acknowledge mode” is set to “Client” | Selector | Yes |
Outputs
| Output | Type | Description | Save output value as: |
|---|---|---|---|
| Next | none | Successfully acknowledged Solace message receipt. | |
| Error | Object | Unexpected error when acknowledging Solace message receipt. | $.error |
How to use the Solace Acknowledge flow-node
After the installation of the Solace plugin, you will find the Solace Acknowledge flow-node in the list of available Flow-Nodes > Core in the left-hand panel of the flow editor:
Configure the Solace Acknowledge flow-node in the position of the flow where you are ready to acknowledge the message.