Key Capabilities
- Bidirectional IoT message queuing with multiple QoS levels
- TLS encryption and client certificate authentication with configurable keep-alive intervals
- Topic-based filtering with wildcard support and Last Will message handling
Overview
Sending data through an MQTT connector publishes the data to the configured topic, and messages that are received on any of the topics that the connector is subscribed to are placed in the Transactions tab.Connector Configuration
This section contains all of the configurable connector properties.Settings Tab
Host Configuration
Settings related to the remote MQTT server connection.Client Authentication
Settings related to authenticating against the remote MQTT server.TLS Settings
Settings related to establishing a secure connection via TLS.Publish
Settings related to publishing MQTT messages.Subscribe
Settings related to subscribing to MQTT messages.Advanced Tab
TLS Client Authentication
Settings related to client authentication when two-way TLS authentication is required.
| Setting | Description |
|---|---|
| Private Certificate | The private certificate presented during TLS client authentication. |
| Certificate Password | The password required to access the TLS client certificate. |
Advanced Settings
Settings not included in the previous categories.Message
Message settings determine how the connector searches for messages and manages them after processing.
Note: The settings below are deprecated and hidden by default. They appear only on connectors where they were previously enabled or configured to a non-default value. To retain copies of successfully processed files, right-click the connector in the flow, choose Show Success Path, and connect the success path to a File connector.
| Setting | Description |
|---|---|
| Save to Sent Folder (Deprecated) | Copies files processed by the connector to the Sent folder. Disabled by default. Files saved to the Sent folder are not covered by Encryption at Rest. |
| Sent Folder Scheme (Deprecated) | Groups files in the Sent folder by the selected time interval. Only relevant when Save to Sent Folder is enabled. |
Logging
Settings that govern the creation and storage of logs.
| Setting | Description |
|---|---|
| Log Level | The verbosity of logs generated by the connector. When you request support, set this to Debug. |
| Log Subfolder Scheme | Instructs the connector to group files in the Logs folder according to the selected interval. The Weekly option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance. |
| Log Messages | Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the Transactions tab. |
Miscellaneous
Miscellaneous settings are for specific use cases.
| Setting | Description |
|---|---|
| Other Settings | Enables you to configure hidden connector settings in a semicolon-separated list (for example, setting1=value1;setting2=value2). Normal connector use cases and functionality should not require the use of these settings. |
Automation Tab
Automation Settings
Settings related to the automatic processing of files by the connector.Performance
Settings related to the allocation of resources to the connector.
| Setting | Description |
|---|---|
| Max Workers | The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
| Max Files | The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the Performance Settings portion of the Advanced Settings page. |
Alerts Tab
SLAs Tab
Logs Tab
The Logs tab lists the service logs generated by this connector. Each row represents a log file and shows its date modified, file name, size, and status. Use the search bar or the status filter to find a specific log, click a file name to preview or download it, or click Download All Logs to download all of them as a single zip file.
Establishing a Connection
At a minimum, set Remote Host on the Settings tab to the domain name or IP address of the MQTT server. If you are using a non-standard port, set Remote Port. If authentication is required, set Username and Password. If you require a secure connection, check Use TLS, and optionally set the TLS Server Certificate to the server’s public certificate, or choose Any Certificate to accept any certificate presented by the server. If this field is used improperly, it creates a security risk. Use extreme caution when setting this field.Publishing
To publish data, set Topic in the Publish section to the topic where the connector should publish messages. QoS values range from 0 to 2 and have the following meanings:- 0 — At most once. The published message is sent once, and if it does not arrive it is lost.
- 1 — At least once. Guarantees that the published message arrives, but there might be duplicates.
- 2 — Exactly once. Guarantees that the published message arrives and that there are no duplicates.
Subscribing
In the Subscribe section of the settings page, you can check Enable MQTT Receiver to indicate that the connector should also receive data. When checked, the connector subscribes to the topics you specify in Topic Filters, and incoming messages are automatically placed on the Transactions tab, named based on the value specified in Local File Scheme in the Advanced Settings portion of the Advanced tab. By default, the connector names files with the topic and packet Id of the message, using%topic%_%packetid%.data as the Local File Scheme value.
You can supply a comma-separated list of topic filters that the connector should subscribe to in Topic Filters. The following characters have special meanings in a topic filter:
- / — The topic level separator
- # — The multi-level wildcard (zero or more levels)
- + — The single-level wildcard (exactly one level)
- Leading $ — Denotes a “system topic”