Configuration
This section explains each of the properties in the configuration blade.
General
| Property | Description |
|---|---|
Collection | This associates the Agent to a specific Collection (default to that of the current Data Stream). |
Refer to Collections and Stream Hosts to understand more about Collections.
Broker Connection
| Property | Description |
|---|---|
Use Variables | Tick to select saved variables; or enter the text manually. |
Broker Address | The MQTT broker URL. |
Clean Session | Tick to have the MQTT broker keep undelivered messages for a short period in the event of connection issues, which will be delivered to the listener when connection is re-established; otherwise, any messages that arrive during a connection issue will not be received. |
Client ID | A string to uniquely identify this stream object among the listeners on the topic (applies when Clean Session is not ticked). |
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.
| Property | Description |
|---|---|
Port | The listener Port for the MQTT broker. Defaults to Port 1883 if left blank or Use Advanced Settings is not ticked. |
QoS | The Quality of Service defines the guarantee of delivery of messages to the MQTT broker. The options are:
Defaults to Exactly Once when Use Advanced Settings is not ticked. |
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.
| Property | Description |
|---|---|
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):
|
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. Anonymous authentication will be used if these values are not provided.
| Property | Description |
|---|---|
Username | The Username to authenticate the broker connection. |
Password | The Password to authenticate the broker connection. |
Topic
| Property | Description |
|---|---|
Group ID | The unique identifier assigned to a set of devices with similar characteristics, facilitating organized and targeted communication within an industrial IoT system. |
Message Type | The classification of messages exchanged between devices in an industrial IoT system, this includes:
|
Edge Node ID | The identifier of the specific device at the edge of an industrial IoT network. |
Device ID | Identifier assigned to a device within an industrial IoT. |
Payload Definition
| Property | Description |
|---|---|
Payload Type | Defines the presentation or type of the data presented in the output.
|
Endpoints
| Endpoint | Description |
|---|---|
Output | An event per received message is made available to this endpoint, with attributes as specified by the Payload configuration. |
Error | Errors encountered during the execution of this Agent will be published on this endpoint. |
Last updated
