Skip to main content
The OASIS Message Queuing Telemetry Transport (MQTT) connector supports publishing MQTT messages and subscribing to MQTT topics.

​
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

双方向TLS 認証が必要な場合のクライアント認証に関する設定です。

設定説明
Private CertificateTLS クライアント認証時に提示されるプライベート証明書です。
Certificate PasswordTLS クライアント証明書にアクセスするために必要なパスワードです。

​
Advanced Settings

Settings not included in the previous categories.

​
Logging

ログの作成と保存を制御する設定です。

設定説明
Log Levelコネクタが生成するログの詳細度です。サポートを依頼する際は、これをDebug に設定してください。
Log Subfolder Scheme選択した間隔に従って、コネクタがLogs フォルダ内のファイルをグループ化するよう指示します。Weekly オプション（デフォルト）は、コネクタが毎週新しいサブフォルダを作成し、その週のすべてのログをそのフォルダに保存するよう指示します。この設定を空白のままにすると、コネクタはすべてのログをLogs フォルダに直接保存します。多数のトランザクションを処理するコネクタでは、サブフォルダを使用することでログを整理しやすくなり、パフォーマンスが向上します。
Log Messages処理したファイルのログエントリにファイル自体のコピーを含めるには、これをオンにします。これを無効にすると、Transactions タブからファイルのコピーをダウンロードできなくなる場合があります。

​
Miscellaneous

Miscellaneous 設定は、特定のユースケース向けの設定です。

設定説明
Other Settings非表示のコネクタ設定をセミコロン区切りのリストで設定できます（例：setting1=value1;setting2=value2）。通常のコネクタのユースケースや機能では、これらの設定の使用は必要ありません。

​
Automation Tab

​
Automation Settings

Settings related to the automatic processing of files by the connector.

​
Performance

コネクタへのリソースの割り当てに関する設定です。

設定説明
Max Workersこのコネクタでファイルを処理するためにスレッドプールから消費されるワーカースレッドの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。
Max Filesコネクタに割り当てられた各スレッドが送信するファイルの最大数です。設定すると、Advanced Settings ページのPerformance Settings 部分にあるデフォルト設定が上書きされます。

​
Alerts Tab

​
SLAs Tab

​
ログタブ

ログタブには、このコネクタが生成したサービスログが一覧表示されます。各行はログファイルを表し、更新日時、ファイル名、サイズ、ステータスが表示されます。特定のログを検索するには検索バーまたはステータスフィルタを使用し、ファイル名をクリックしてプレビューまたはダウンロードするか、すべてのログをダウンロードをクリックしてすべてのログを単一のzipファイルとしてダウンロードします。

​
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.
In the Advanced Settings portion of the Advanced tab, you can set Republish Interval to the number of seconds that you want the connector to wait for acknowledgements to messages that require them. If this time elapses without receiving an acknowledgement, the connector republishes the message. Republished messages reuse the packet Id from the original message, and automatically set the Duplicate flag on the message. Specifying a value of 0 for Republish Interval prevents the connector from automatically republishing messages.

​
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”
You can use Last Will Message and Last Will Topic on the Advanced tab to specify the message that the server should publish, and the topic it should publish that message to, in the event of an ungraceful disconnection.

​
Macros

​
Examples