Managing Qlik Sense applications can be challenging, especially when it comes to documentation. Enter DocuGen, a tool by Denisas Kuak and Podos Chakis, designed to automate documentation creation using Qlik Application Automation. This guide explores how to leverage DocuGen to streamline your documentation process for Qlik Sense applications.
What is DocuGen?
DocuGen automatically generates detailed documentation for Qlik Sense applications, covering key areas:
- General Application Information: Name, description, memory usage.
- Data Models: Tables, fields, and distinct values.
- Master Items: Measures, dimensions, variables.
- Sheets and Visualizations.
- Load Scripts.
The output is a shareable HTML file, perfect for archival and collaboration.
Key Features
1. Interactive Documentation
- Hyperlinks allow seamless navigation between sheets and visualizations.
- Integrates with the Qlik Sense Single Integration API for in-app navigation.
2. Customization
- Choose specific components to document, such as load scripts or master items.
- Enable optional screenshots for visualizations.
3. Integration
- Export documentation to SharePoint, S3, or custom storage solutions.
Installation Steps
1. Download DocuGen
- Access DocuGen from the Qlik Community.
- Download the
docugen_v1.json
file containing the automation logic.
2. Set Up in Qlik Application Automation
- Log in to your Qlik Sense tenant.
- Navigate to Create > Application Automation.
- Upload the
docugen_v1.json
file as a Blank Automation. - Right-click the workspace and select Upload Workspace.
3. Configure SharePoint Integration
- Locate the SharePoint block in the automation.
- Set up a SharePoint connection:
- Click Connection > Create New Connection.
- Save and apply the connection to all SharePoint blocks.
4. Run the Automation
- Define input parameters:
- Application space (e.g., “App Development”).
- Components to document (e.g., data models, measures).
- Enable screenshots if required.
- Execute the automation to generate HTML documentation.
Customizing DocuGen
Modifying CSS
- Retrieve the CSS file from the GitHub repository.
- Make desired changes, minify, and paste into the CSS block of the automation.
Editing the Python Script
- Modify the script directly within the custom code block or download it from GitHub.
- Adjust output destinations, such as saving to S3 instead of SharePoint.
How DocuGen Works
Input Collection
- Users specify application preferences and components for documentation.
Data Extraction
- Extracts application details such as data models and visualizations.
Processing
- Passes extracted data to a Python script for structured HTML generation.
- Optionally includes screenshots as Base64 images.
Output Generation
- Creates an HTML file with hyperlinks and structured content.
- Saves the file to a specified location (e.g., SharePoint).
Demo Walkthrough
- Input Configuration
- Select application space (e.g., “App Development”).
- Choose components to document (e.g., load script, data model).
- Enable or disable screenshots.
- Generated Documentation
- General Information: App name, reload stats, memory footprint.
- Data Models: Table details, fields, distinct values.
- Master Items: Measures and dimensions.
- Sheets and Visualizations: Previews with object details.
- Load Script: Organized with comments.
Future Enhancements
- Template Integration: Potential inclusion as a built-in Qlik template.
- Additional Outputs: Support for Google Drive or other storage locations.
DocuGen revolutionizes Qlik Sense application documentation. With its automation capabilities, interactive features, and customization options, maintaining organized documentation is now effortless.
Download DocuGen today to simplify your documentation process. For support, visit the Qlik Community or check out the GitHub repository for advanced configurations.