| Broker Name | The name of the broker. This is used by the Call to select the correct broker. |
| Broker Hostname | Hostname of the broker IPv4 OR hostname! |
| Port | The port, the broker is running on (1883 is standard for TCP and 8883 is standard for SSL). |
| TLS | TLS Encryption. Not yet available! |
| Keep-Alive | The number of seconds the client should be kept alive if no activity takes place. |
| Clean-Session | Determines whether the session is cleaned after a reconnection. |
| Last will topic | The topic for which a message is sent if the client dies (testament). |
| Last will payload | The message for the testament. |
| Last will retained | Flag to decide whether the message should be retained by the broker. |
| Last will QoS (Quality of Service) |
Flag to decide how often the message will be sent. |
| Allow multiple executions in reordering | If you send the “order” list to rearrange the given operations, you can decide with the flag whether operations should be executed several times. |
| Continue after an exception | Flag to decide whether the next operation should be executed after an error or whether the execution completely stops. |
How to use a MQTT Connector in a REST-Client
You can choose between 2 operations: PUBLISH and SUBSCRIBE.
Build the payload like this:
| Parameter | Description |
|---|---|
| operationType | Type of the operation, PUBLISH or SUBSCRIBE. |
| brokerName | The name of the broker, as it is specified in the Connector Details. If no name is given, the default broker is selected. |
| returnSet (for SUBSCRIBE operations) | Option which information the incoming messages contain. “STANDARD”: Only the payload and the topic are displayed. “WITH_QUALITY_INFORMATION”: Equivalent to the “STANDARD” but additionally with information whether the message is duplicated / withheld and QoS. “VERBOSE”: As before but with Client ID as well as message ID. |
|
Parameter for the Object “clientInformation” |
|
| clientId | The ID of the client. Since no two clients can connect with identical ID on the same broker, caution is advised. Dropping this parameter causes a random ID to be generated by the program. |
| forceReconnection | Setting whether the client should reconnect. |
|
Parameter for the Object “messages” |
|
| qos | The Quality of Service settings: “AT_LEAST_ONCE”, the message is sent at least once. “ONCE”, the message is sent exactly once. “AT_MOST_ONCE”, the message is sent 0 or 1 time. |
| topic | The topic for which the message is published. |
| retain | Setting whether to keep the message in the broker. |
| payloadInformation | Meta information for the payload. ***Is not being used at the moment.*** |
| payload | The payload as a String. |
Publish
If you want to publish 1 message:
"operations": [{"operationType":"PUBLISH","brokerName":"testBroker","clientInformation": {"clientId":"client1","forceReconnection":"true"},"messages": [{"qos":"AT_LEAST_ONCE","topic":"myTopic","retain":"true","payloadInformation":"JustMetaInformation","payload":"PayloadA"}]}]
If you want to publish n messages:
"operations": [{"operationType":"PUBLISH","brokerName":"testBroker","clientInformation": {"clientId":"client1","forceReconnection":"true"},"messages": [{"qos":"AT_LEAST_ONCE","topic":"myTopic","retain":"true","payloadInformation":"JustMetaInformation","payload":"PayloadA"},{"qos":"AT_LEAST_ONCE","topic":"myTopic2","retain":"true","payloadInformation":"JustMetaInformation2","payload":"PayloadB"}]},]
Publish with multiple operations (publish + publish)
"operations": [{"operationType":"PUBLISH","brokerName":"testBroker","clientInformation": {"clientId":"client1","forceReconnection":"true"},"messages": [{"qos":" AT_LEAST_ONCE ","topic":"myTopic","retain":"true","payloadInformation":"JustMetaInformation","payload":"PayloadA"}]},{"operationType":"PUBLISH","brokerName":"testBroker","clientInformation": {"clientId":"client1","forceReconnection":"true"},"messages": [{"qos":"AT_LEAST_ONCE","topic":"myTopic","retain":"true","payloadInformation":"JustMetaInformation","payload":"PayloadA"},{"qos":"AT_LEAST_ONCE","topic":"myTopic2","retain":"true","payloadInformation":"JustMetaInformation2","payload":"PayloadB"}]}]
Subscribe
If you want to subscribe for n topics:
{"operationType":"SUBSCRIBE","returnSet":"VERBOSE","brokerName":"testBroker","clientInformation": {"clientId":"clientSubscribe","forceReconnection":"true"},"topics": ["test","myFancyTopic"]}
