The MQTT Listener for MQ messages using the MQTT protocol.
On the Basic tab configuration you can specify:
MQTT Version: version of MQTT to use (v.3.1.1 or v.3.1)
Polling interval (in seconds, minutes, hours, days or weeks): how to often the Listener checks the status of the broker connection. If the value is set with enhanced properties, the unit are seconds
The Advanced tab allows you to specify whether or not you should only run the Listener when it is triggered externally, how many elements should be serialized and whether or not to also scan sub-folders.
Also you can set:
Initialize on trigger only: If enabled, the Listener doesn’t start up until a trigger initializes it.
Allow command-line invocation: If enabled, the listener can be invoked using the CLI client application.
Restart on listening error: If enabled, the listener will be restarted after an error occurs.
FIFO Queue Name: The FIFO field enables a “First In, First Out” queuing mechanism between Listeners and Transports. If a “FIFO Queue Name” is provided, that name will be used as a key for a queue Transactions & will be pushed into before reaching a transport. They’ll be ordered in this queue according to when the Listener created them.
FIFO Queue Delay: It is the interval between updates/checks against that queue. Providing a queue name guarantees that a given Transport sends transactions in the same order the Listener created them in.
Transaction Logging – This tab allows us to enable transaction events logging. That data can be logged by a TransactionEventListener.
The Transaction Logging Enable checkbox allows transaction events originating from this listener to be logged by a TransactionEventListener.
Log Transaction Data – if enabled, logs transaction data body.
Log Transaction Data Base64 – if enabled, logs transaction data body as Base64.
Log Transaction Attribute – if enabled, logs transaction attributes.
Log All Attributes: if enable, no attributes will be filtered
Allowed Attributes: attributes which are allowed to be logged
On the Connection tab you can specify:
MQTT Broker: MQTT broker to subscribe to
Topic(s): topics to interact with
Client ID: Unique Identifier for the client on the MQTT broker
Connection Timeout Interval: time to wait for the client to connect to the broker. If the value is set with enhanced properties, the units are seconds.
Enable Keep Alive: when enable, allows the listener to detect if a broker is unavailable without waiting on TCP/IP timeout.
Keep Alive Interval: max time between received messages
Max Inflight Messages: limit to number of messages
Topic Received Attribute: attribute which topic a message was received from
On the Persistence tab you can specify:
Is Clean Session: creates a clean session which ignores persistence
Persistence Type: method of persistence (Memory Persistence/File Persistence)
File Persistence Location: location of file persistence
On the Last Will and Testament tab you can specify:
Enable Last Will and Testament: enables Last Will and Testament settings
LWT Topic Name: topic to send Last Will and Testament message to
LWT Message: Last Will and Testament message
LWT QoS: Quality of Service method for Last Will and Testament message
Retain LWT Message: whether or not a Last Will and Testament message should be retained