Create a dashboard handbook from dashboard IDs [Windows]
This guide explains how to use the Dashboard Handbook Creator script for Sisense on Windows (tested version: 20.25.3.10026) to automatically generate a Word document containing dashboard names, widget names, descriptions, and images. Ideal for documentation or knowledge sharing.
Step-by-Step Guide
1. Prepare the Config File
Before running the script, edit the settings.yml file with your Sisense server information and dashboard IDs you want to process.
Example settings.yml:
username: [email protected]
password: Test12345!@#$%
url: http://localhost:8081
dashboard_ids:
- 68526ec76704160c3c34fd77
- 685a79a130f47d228cb66e40This configuration file instructs the script on which dashboards to process and how to connect to your Sisense server.
2. Understand Script Behavior
The Dashboard Handbook Creator script:
- Creates a Word document with the dashboard name, widget name, description, and widget images.
- Searches the local folder for widget images.
- Downloads missing widget images from your Sisense server.
- Skips already downloaded widgets for speed.
Important: Generating widget images consumes server resources and may impact performance if multiple dashboards are processed simultaneously. It’s recommended to:
- Run the script for a few dashboards at a time.
- Run it during off-hours to reduce load.
3. Run the Script
- Place the script and settings.yml in the same folder.
- Execute the script by running doc.exe.
Screenshot:
4. Access the Generated Document
Once complete, the script creates a .docx file in the folder containing:
- Dashboard names
- Widget names
- Widget descriptions
- Widget images
Screenshot:
Limitations:
- Does not work with reverse proxy setups.
- Compatible only with Sisense for Windows (tested on version 20.25.3.10026).
Conclusion
The Dashboard Handbook Creator is a useful tool to generate comprehensive dashboard documentation automatically. By configuring your settings and understanding the resource requirements, you can streamline your documentation process and improve knowledge sharing within your organization.
References/Related Content
Disclaimer: This post outlines a potential custom workaround for a specific use case or provides instructions regarding a specific task. The solution may not work in all scenarios or Sisense versions, so we strongly recommend testing it in your environment before deployment. If you need further assistance with this, please let us know.
