Welcome to the Butler documentation

Butler is an open source add-on tool for Qlik Sense, extending that platform with various features, most of which are focused on integrating Sense with other systems.
Butler makes it easy to hook up Sense to systems like Slack or MQTT, and use these tools to send alerts when something important/interesting/urgent happen in a Sense cluster.

Sample use cases:

  • Information about all failing tasks can be sent to a Slack channel. This gives sysadmins real-time insight into what's happening with respect to task execution.
  • Trigger Sense tasks from a reload script. This makes it possible to start different Sense tasks based on what data has been read from a database, for example.
  • Any messages sent to Slack can include full formatting (web links, text formatting etc), as well as "poking" users. I.e. notifying specific Slack users that they have a new message. Can for example be used to notify user(s) that an app has reloaded with new data, or that some error condition has occured.
  • Send and receive MQTT publish-subscribe messages. MQTT (and the pubsub concept in general) is a great way for systems to communicate reliably with each other.
  • Modify the Operations Monitor app to send a daily summary of daily/weekly/monthly active users, # of failed tasks etc to a Slack channel
  • ... Butler is open and extensibleby in its nature, it is thus possible to integrate it with most other systems.
  • Real-time monitoring of active users. This data is posted to MQTT, from where it can be plotted by various tools, see below.

alt text
Real-time view of # of active users.

All project files are found on GitHub.

Use the menu to the left to access the different parts of the Butler documentation.

Throughout this documentation the words "Qlik Sense" and "Sense" are used, both referring to the product Qlik Sense from the company Qlik.

Updates to Butler will be published through GitHub and descried on Ptarmigan Labs' site.

Good luck and have fun!

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. Or fork the project and contribute with enhancements.

Author

Göran Sander
Web: Ptarmigan Labs
Twitter: @themountaindude

License

Copyright © 2016 Göran Sander. Released under the MIT license.