Qlik Sense Help Button

This repository provides different solutions for adding a customized help button into the Qlik Sense application toolbar. The help button gives users quick access to context-aware support resources, documentation, bug reporting tools and user feedback forms directly within the Qlik Sense interface.

The bug report and feedback features look like this in action:

Qlik's native help button takes the user to Qlik's online help resources. This is great, but may not be ideal for organizations that want to provide their own custom documentation, corporate wikis, or specific support links. This project provides multiple ways to create a more tailored help and user feedback experience.

Two Installation Methods

You can choose between two different approaches for adding the help button to your Qlik Sense environment, depending on your needs and whether you use Qlik Sense SaaS (Cloud) or Client-Managed. Both approaches yield the same end result.

flowchart TD
    Start[Add Custom Help Button to Toolbar] --> Method1
    Start --> Method2
    
    Method1[Qlik Sense Extension]
    Method1 --> ExtDesc[Drag & Drop inside apps<br>Configure via Property Panel]
    ExtDesc --> ExtEnv[Supports SaaS & Client-Managed]
    ExtEnv --> ExtLink[Go to Extension Docs]
    
    Method2[HTML Injection]
    Method2 --> HTMLDesc[Modify client.html<br>Configure via JS Code]
    HTMLDesc --> HTMLEnv[Client-Managed only]
    HTMLEnv --> HTMLLink[Go to HTML Injection Docs]

Loading

1. Qlik Sense Extension (Recommended)

• Extension Documentation
• A native Qlik Sense extension built using modern Nebula.js hooks.
• Works on both Qlik Sense SaaS (Cloud) and Client-Managed Qlik Sense (Enterprise).
• Easily configured by developers from within the Qlik Sense Property Panel (custom colors, icons, menus).
• Supports three menu item types: outbound links, bug report dialogs, and user feedback dialogs (with star rating and free-text comments).
• Includes a robust Tooltip feature that attaches hover-over information icons and detail dialogs to any Qlik Sense chart object.
• To use, simply drop the extension on a sheet, and it will dynamically inject the button into the global toolbar when the user switches to Analysis mode.

2. HTML Injection (Client-Managed only)

This method injects vanilla JavaScript directly into your client.html file on the Qlik Sense Enterprise on Windows server. It requires zero dependencies and is extremely lightweight, making it ideal for simple, server-wide setups where minimizing complexity is key. The help button will be added to the toolbar of every app for all users, and can be configured via JavaScript code.

Current available variants for HTML injection variant:

• Basic
  • The standard vanilla JavaScript implementation.
• Bug Report
  • Everything in Basic, plus a built-in Bug Report dialog.
  • Clicking "Report a bug" opens a modal pre-populated with Qlik Sense context (user ID, name, Sense version, app ID, sheet ID, URL).
  • The user adds a free-text description and submits — the report is POSTed as JSON to a configurable webhook endpoint.

Shared Features

Template Fields (Context-Aware Links)

Both the Qlik Sense extension and the HTML variants support template fields — dynamic {{…}} placeholders in URLs that are resolved at click time using live Qlik Sense context. This enables context-sensitive help, directing users to app-specific or sheet-specific documentation pages.

Supported fields: {{userDirectory}}, {{userId}}, {{appId}}, {{sheetId}}.

Example Configuration:

menuItems: [
  {
    label: 'Help for this app',
    url: 'https://wiki.example.com/qlik/apps/{{appId}}',
    icon: 'help',
    target: '_blank',
  },
]

See docs/template-fields.md for full documentation including all supported fields, fallback behaviour, and configuration examples.

Multi-Language Support

Both methods support localized interfaces so you can provide menus built for your user's language:

• The Extension typically has its own property panel localization.
• HTML Variants ship with self-contained language folders (English en, Swedish sv, Norwegian no, Danish da, Finnish fi, German de, French fr, Polish pl, Spanish es). Pick the folder that fits your organization and drop it in.

A note on folder names (HTML Variants): Language folders are named using ISO 639-1 language codes, not ISO 3166-1 country codes. For example, Danish is da (not dk), Swedish is sv (not se), and German is de (not the country-code for Germany, which is also de by coincidence).

Demo Server (Bug Report & Feedback Webhook)

Both the extension and the HTML Bug Report variant can submit reports to a configurable webhook endpoint. The extension's Feedback dialog also POSTs data to a webhook. A ready-to-use Express.js demo server is included for local testing and development — see the Demo Server documentation.

The demo server supports both HTTP and HTTPS, logs incoming bug reports and feedback to the console, and includes step-by-step instructions for generating self-signed certificates (required when testing with Qlik Sense Enterprise on Windows).

It also provides a nice dashboard showing what bug reports and feedback have been received:

flowchart LR
    subgraph Qlik Sense
        A[Bug Report Dialog] -->|POST /api/bug-reports| C[Demo Server]
        B[Feedback Dialog] -->|POST /api/feedback| C
    end
    C --> D[Console Log]

Loading

License

This project is licensed under the MIT License - see the LICENSE file for details.