MQTT Action Agent

Description

Posts data to a MQTT channel to which a device might have subscribed for instructions or control commands.

Configuration

To add the MQTT Action Agent to a stream, follow the steps below:

1. Ensure you have a use case open in the stream designer, this can be a new use case or an existing use case
2. From the toolbox on the left expand the Action Agents option and scroll down until you can see “MQTT”
   • You can also use the search in the header to find the agent quickly
3. Click and drag the MQTT Action Agent from the toolbox onto the canvas
4. Rename the action agent by clicking into the text area to the right of the icon
5. Save the Stream by clicking the save button in the action bar
6. Hover over the icon for the action agent until it turns orange and then double click to open the configuration page
   • You can optionally use the configure option on the action bar once you have selected the specific agent and then clicking this option
7. Configuration options
   • The Collection drop-down allows you to associate this agent with a specific collection. The selected option would be, by default, the same as the collection that was selected for the use case. If you do need to change it to another collection, select a different collection from the drop-down.
8. Settings
   • Specify the address of the Broker you wish to connect to
   • If you would like to use a Dynamic topic, select the checkbox and then select the field you would like to use as your dynamic topic, or
   • If you would like to use a static topic, specify the name of your topic in the Topic textbox.
   • If you would like to retain messages, select the checkbox and select a field that could be used as a flag in the “Clear Retained Message Flag” drop-down.
   • Specify which fields should be included in the payload by selecting the checkboxes under the Payload header.
9. Click Apply on the action bar, and then save the stream using the save button

Release Notes

Version:	1.62
Released:	07-May-2019
Release Notes:	Added option to clear retained messages based on new drop-down option to specify an input column that contains a Boolean value.