Configuration

This section explains each of the properties in the configuration blade.

General

PropertyDescription

Collection

This associates the Agent to a specific Collection (defaults to that of the current Data Stream).

Visit Collections and Stream Hosts to understand more about Collections.

Broker Connection

PropertyDescription

Use Variables

Tick to select saved variables; or enter the text manually.

Broker Address

The MQTT broker URL.

Use Dynamic Topic

Tick this to send events to different topics based on an event property, rather than sending all events to the same topic. This will also cause events to be sent as individual messages, rather than in bulk.

Topic

The name of the topic to send messages on the broker (applies when Use Dynamic Topic is not ticked).

Dynamic Topic

The event property which will be used as a topic name (applies when Use Dynamic Topic is ticked).

Retain Message

Tick to tell the broker to remember the latest message this agent sends on each topic, and to send that message to any receivers that connect to that topic. Events will be sent as individual messages, rather than in bulk.

Clear Retained Message Flag

An optional Boolean event attribute to monitor the events (applies when Retain Message is ticked).

If the attribute is true for an event, the event will not be sent as a message. Instead, the retained message for that event's topic will be cleared.

Use Advanced Settings

Tick to use Advanced Settings, Channel, and Authentication for the Broker Connection.

Advanced Settings

This applies when Use Advanced Settings is ticked.

PropertyDescription

Port

The listener Port for the MQTT broker.

Defaults to Port 1883 if left blank or Use Advanced Settings is not ticked.

Client ID

The unique Client ID when connecting to the MQTT broker. A temporary GUID is generated if left blank or Use Advanced Settings is not ticked. The MQTT broker does not allow a second connection using the same Client ID.

QoS

The Quality of Service defines the guarantee of delivery of messages to the MQTT broker. The options are:

  • At most once - (QoS 0) Guarantees a best-effort delivery. There is no guarantee of delivery.

  • At least once - (QoS 1) Guarantees that a message is delivered at least one time to the receiver.

  • Exactly once - (QoS 2) Guarantees that each message is received only once by the intended recipients.

Defaults to Exactly Once when Use Advanced Settings is not ticked.

Post as Batch

Tick to publish messages from the received event as a batch. The messages are posted as a batch by default when Use Advanced Settings is not ticked and neither Use Dynamic Topic is ticked, nor a Clear Retained Message Flag attribute is selected.

Channel

TLS and SSL provide a secure communication channel between the client and the MQTT broker. It can be used in the Agent if the MQTT broker is configured to support Certificate-based TLS/SSL. This applies when Use Advanced Settings is ticked.

PropertyDescription

Secure Channel

Tick to use a Secure Channel when connecting to the MQTT broker.

Protocol

The TLS/SSL protocol and version options to use on the Secure Channel are (applies when Secure Channel is ticked):

  • SSL v3

  • TLS v1.0

  • TLS v1.1

  • TLS v1.2

Root Certificate

The Root CA Certificate of the MQTT broker - usually provided by the MQTT broker owner (applies when Secure Channel is ticked).

Client Certificate

The Client Certificate contains the Public/Private Key pair, which verifies the identity of the client (applies when Secure Channel is ticked). The Client Certificate must be generated from the same CA used by the MQTT broker. This is bundled with its Private key into a PFX format and password protected when exporting.

Client Certificate Password

The Password used to export the Public/Private Key pair of the Client Certificate (applies when Secure Channel is ticked).

The client certificate and password are not required if the MQTT broker is configured to not require a client certificate. In this case, the root certificate will suffice.

Authentication

This applies when Use Advanced Settings is ticked.

PropertyDescription

Anonymous?

Tick to use Anonymous authentication.

Username

The Username to authenticate the broker connection (applies when Anonymous? is not ticked).

Password

The Password to authenticate the broker connection (applies when Anonymous? is not ticked).

Payload

PropertyDescription

Payload Type

The published payload options are:

  • Multi-Column JSON - publish a JSON with multiple values from the input payload.

  • Single-Column Text - publish a single value from the input payload.

  • Nested Object - publish a Nested Object with the selected properties inside it.

Payload (Multi-Column)

The columns or attributes of the input payload that will be included in the output payload (applies to Multi-Column JSON Payload Type only). If none are specified, all columns will be returned.

Payload (Single-Column)

The column or attribute of the input payload that will be included in the output payload (applies to Single-Column Text Payload Type only).

Object Field Name

The Field Name of the Object where the selected properties will be nested (applies to Single-Column Text Payload Type only).

As Array

Tick to nest the selected properties on the Object as an Array (applies to Nested Object Payload Type only).

Nested Object Properties (Source, Alias)

The properties that will be nested on the object in the output payload:

  • Source: the column or attribute of the input payload to include.

  • Alias: the field name of the value when nested on the Object (applies when As Array is not ticked).

Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.

Endpoints

NameDescription

Input

This endpoint is used to receive data from the parent Agent.

Output

Events received from the parent Agent are published to the MQTT broker and made available to this endpoint with unchanged attributes and data.

Error

Errors encountered during the execution of this Agent will be published on this endpoint.

Last updated