Setting up MQTT messaging
These settings are optional.
If you don’t need the MQTT feature, just disable it and leave the default values in the config as they are.
Do note though that Butler expects the configuration properties below to exist in the config file, but will ignore their values if the related features are disabled.
MQTT is a light weight messaging protocol based on a publish-subscribe metaphore. It is widely for example Internet of Things and telecom sectors.
MQTT has features such as guaranteed delivery of messages, which makes it very useful for communicating between Sense and both up- and downstream source/destination systems.
Butler can be configured to forward events from Sense (reload task failures, aborted reload tasks, user session start/stop etc) as MQTT messages.
Butler’s REST API also has an endpoint that makes it possible to send MQTT messages from the Sense load script.
Settings in main config file
The settings are of two kinds:
- Defining what MQTT broker/server to connect to
- What MQTT topics should be used when forwarding Qlik Sense events to MQTT.
--- Butler: ... ... mqttConfig: enable: false # Should Qlik Sense events be forwarded as MQTT messages? brokerHost: <FQDN or IP of MQTT server> brokerPort: 1883 taskFailureSendFull: true taskAbortedSendFull: true subscriptionRootTopic: qliksense/# # Topic that Butler will subscribe to taskStartTopic: qliksense/start_task # Topic for incoming messages used to start Sense tasks. Should be subtopic to subscriptionRootTopic taskFailureTopic: qliksense/task_failure taskFailureFullTopic: qliksense/task_failure_full taskFailureServerStatusTopic: qliksense/butler/task_failure_server taskAbortedTopic: qliksense/task_aborted taskAbortedFullTopic: qliksense/task_aborted_full sessionStartTopic: qliksense/session/start sessionStopTopic: qliksense/session/stop connectionOpenTopic: qliksense/connection/open connectionCloseTopic: qliksense/connection/close sessionServerStatusTopic: qliksense/butler/session_server activeUserCountTopic: qliksense/users/active/count activeUsersTopic: qliksense/users/active/usernames ... ...
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.