Parameter

Description

Broker URLs

A comma delimited list of broker URLs, expressed as follows:

<protocol>://<host>:<port>

The supported protocols are:

• TCP

• SSL

You can either enter the broker URL, or click to open the Environment Variables List. Here, you can select an environment variable to use as a broker URL.

Clean Session

Determines the client's behavior if it is disconnected from the broker for any reason. Select one of the following from the drop-down list:

• Yes (default): After a disconnection, all information from the previous session is discarded and a new session is started.

• No: After a disconnection, the information from the previous session is retained for use in a new session.

User Name

The user name for broker authentication.

Password

The password for broker authentication.

Use LWT

Enables the "last will and testament" functionality. If the client is disconnected from the broker, the broker will publish a message to itself using the supplied LWT details. Select one of the following from the drop-down list:

• No (default)

• Yes

LWT Topic

The topic that you want to publish.

You can either enter the topic, or click to open the Environment Variables List. Here, you can select an environment variable to use as a topic.

This parameter is available only if the Use LWT parameter (above) is set to Yes.

LWT Message

The message that you want to send to the topic.

You can either enter the message, or click to open the Environment Variables List. Here, you can select an environment variable to use as a message.

This parameter is available only if the Use LWT parameter (above) is set to Yes.

LWT QoS

The Quality of Service when sending the message. Select one of the following from the drop-down list:

• 0 (default): At most once.

• 1: At least once.

• 2: Exactly once.

This parameter is available only if the Use LWT parameter (above) is set to Yes.

LWT Retained

The message retain value. This determines whether the broker will hold onto a message after it has been sent. Select one of the following from the drop-down list:

• No (default): The broker will not hold onto a message after it was sent, and subscribers will not be able to see it.

• Yes: The broker will hold onto a message after it was sent, and subscribers will be able to see it.

This parameter is available only if the Use LWT parameter (above) is set to Yes.

MQTT Connection TImeout

The connection timeout in seconds when connecting to the broker. The default is 30.

A value of 0 disables timeout processing. Then, the client will wait until the network connection is either made successfully or fails.

You can either enter the timeout value, or click to open the Environment Variables List. Here, you can select an environment variable to use as a timeout value.

MQTT Keep Alive Interval

The connection keep alive interval in seconds. This lets the client detect if the broker is no longer available without having to wait for the TCP/IP timeout. A value of 0 disables keep alive processing in the client.

You can either enter the keep alive value, or click to open the Environment Variables List. Here, you can select an environment variable to use as a keep alive value.

MQTT Publish Timeout

The publish timeout in milliseconds.

You can either enter the publish timeout value, or click to open the Environment Variables List. Here, you can select an environment variable to use as a publish timeout value.

Server Certificate File

When the Broker URLs property (above) is set to SSL, this property should hold the path to the broker certificate (in PEM format). The MQTT connector will use the server certificate to determine whether it can trust the broker.

You can either enter the path to the broker certificate, or click to open the Environment Variables List. Here, you can select an environment variable to use as the path.

Security Protocol

The security protocol to use when the Broker URLs parameter (above) is set to SSL. Select one of the following from the drop-down list:

• TLSv1.2 (default)

• TLSv1.1

• TLSv1

Client Certificate File

When the Broker URLs property (above) is set to SSL, and mutual authentication is required, this property should hold the path to the client certificate and the private key archive (in PKCS #12 format).

Client Certificate Password

The password for the client certificate.

You can either enter the password, or click to open the Environment Variables List. Here, you can select an environment variable to use as the password.

Button

Description

Validate

Click this button to verify that the connection to the MQTT broker is valid. You will receive a message indicating that the connection is established, or an error message if the connection failed.

Since version:

4.5