Skip to content

Supported Versions ​

Butler Sheet Icons is regularly tested against various versions of Qlik Sense to ensure compatibility and reliability.

Qlik Sense Enterprise on Windows (QSEoW) ​

Butler Sheet Icons supports multiple QSEoW versions using the --sense-version parameter to handle version-specific differences in the web interface.

Two different questions

Which values are accepted is decided by the code, and the complete list is in the --sense-version row of the QSEoW command reference — that table is generated from the command definitions, so it cannot fall behind.

Which versions have been tested is what the table below records. A value can be accepted without having a test date here.

Currently Supported Versions ​

QSEoW VersionBSI VersionLast TestedCommand ParameterStatus
2026-May SR25.0.02026-Aug-11--sense-version 2026-May✅ Supported
2025-Nov IR3.9.02025-Nov-24--sense-version 2025-Nov✅ Supported
2025-May IR3.9.02025-Nov-22--sense-version 2025-May✅ Supported
2024-Nov IR3.8.02025-Jan-6--sense-version 2024-Nov✅ Supported
2024-May IR3.8.02024-Dec-6--sense-version 2024-May✅ Supported
2024-Feb IR——--sense-version 2024-Feb✅ Accepted
2023-Nov patch 33.6.42024-Nov-6--sense-version 2023-Nov✅ Supported
2023-Aug patch 33.6.02024-Jan-4--sense-version 2023-Aug✅ Supported
2023-May patch 63.5.02023-Oct-6--sense-version 2023-May✅ Supported
2023-Feb IR3.4.02023-Jul-24--sense-version 2023-Feb✅ Supported
2022-Nov patch 23.2.02023-Jan-3--sense-version 2022-Nov✅ Supported
2022-Aug patch 53.1.02023-Jan-2--sense-version pre-2022-Nov⚠️ Legacy Support
2022-May IR3.0.02022-Sep-30--sense-version pre-2022-Nov⚠️ Legacy Support

Version Selection ​

--sense-version defaults to 2026-May, so a run against a current server needs no version option at all. Set it explicitly when your server is older:

bash
# Against a 2025-Nov server
butler-sheet-icons qseow create-sheet-thumbnails \
  --sense-version 2025-Nov \
  # ... other options

# Against a 2023-Nov server
butler-sheet-icons qseow create-sheet-thumbnails \
  --sense-version 2023-Nov \
  # ... other options

The same value can be given through BSI_QSEOW_CST_SENSE_VERSION, which is usually the better choice for a scheduled task.

The default changed in BSI 5.0.0

Earlier versions defaulted to an older release. If you relied on the default rather than setting --sense-version explicitly, check that it still matches your server — and set it explicitly if it does not, which is worth doing anyway on a server you do not upgrade often.

What the version is used for ​

--sense-version tells Butler Sheet Icons which Qlik Sense hub layout to expect. In practice it now affects one thing: finding the logout control in the hub user menu, and only as a fallback.

Logging out normally goes through the Qlik Proxy Service session, which does not depend on the hub's page structure at all — so a changed menu, or a user with different permissions, is far less likely to affect a run than it once was. The hub user menu is used only if the proxy request is not accepted, and even then the stable logout hook is tried before the version-specific selector.

A failed logout does not discard thumbnails that were already created. The browser and engine sessions are still closed, processing continues, and the log says what happened:

error: QSEOW: Could not log out of Qlik Sense - both the proxy session API and the hub's user menu failed.
error: QSEOW: Thumbnail generation completed, but logout was skipped. Processing will continue; if upload and sheet updates complete, only logout will have failed.

If you see that, the log also names the --sense-version you ran with and asks you to report it. Include the Qlik Sense release and service-release information — that is what identifies the layout Butler Sheet Icons needs to learn.

Finding Your QSEoW Version ​

  1. QMC Method:

    • Log into the Qlik Management Console (QMC)
    • Version is displayed in lower right corner
  2. Hub Method:

    • Log into Qlik Sense Hub
    • Click your profile menu → About
    • Version information is displayed in the popup window

Version-Specific Notes ​

2024-Nov and Later:

  • Enhanced security features
  • Updated web interface elements
  • Improved performance for large apps

2024-May:

  • New sheet navigation patterns
  • Updated selection bar styling
  • Enhanced mobile responsiveness

2023 Releases:

  • Modernized web interface
  • New authentication flows
  • Updated navigation elements

2022 and Earlier:

  • Legacy web interface
  • Different authentication patterns
  • Use pre-2022-Nov for versions before November 2022

Qlik Sense Cloud ​

Qlik Sense Cloud is continuously updated by Qlik. Butler Sheet Icons adapts to these changes and is regularly tested against the latest cloud environments.

Compatibility Status ​

Test DateBSI VersionStatusNotes
2025-Nov-223.9.0✅ WorkingAll features functional
2025-Sep-83.8.0✅ WorkingAll features functional
2025-Jan-63.8.0✅ WorkingAll features functional
2024-Dec-63.7.0✅ WorkingLatest cloud features supported
2024-Nov-63.6.4✅ WorkingNo issues detected
2024-Aug-233.6.3✅ WorkingFull compatibility
2024-Jun-33.6.2✅ WorkingNew API endpoints supported
2024-Apr-243.5.0✅ WorkingLogin page updates handled
2024-Apr-223.4.1❌ Login IssuesLogin page changes broke authentication
2024-Mar-83.4.1✅ WorkingAfter hotfix for login issues

Cloud-Specific Considerations ​

Continuous Updates:

  • Qlik regularly updates the cloud interface
  • Butler Sheet Icons is updated to handle major changes
  • If issues arise, check for latest BSI version or open a GitHub issue.

Browser Compatibility ​

Butler Sheet Icons uses headless browsers for screenshot capture.
The latest available version will be used by default, it usually works well.

Browser Selection ​

A specific browser and version can be specified if needed.

bash
# Use latest Chrome (recommended)
butler-sheet-icons qscloud create-sheet-icons --browser chrome

# Use specific Chrome version
butler-sheet-icons qscloud create-sheet-icons \
  --browser chrome \
  --browser-version 121.0.6167.85

Chrome is the only browser accepted by the thumbnail commands — see Supported Browsers.

Browser Management ​

bash
# List installed browsers
butler-sheet-icons browser list-installed

# Install specific browser version
butler-sheet-icons browser install --browser chrome --browser-version 121.0.6167.85

# List available browsers for download
butler-sheet-icons browser list-available --browser chrome

# Update to latest browser
butler-sheet-icons browser uninstall --browser chrome --browser-version old-version
butler-sheet-icons browser install --browser chrome

Platform Support ​

Operating Systems ​

PlatformArchitectureStatusNotes
Windowsx64✅ Fully SupportedSigned binaries, Windows 10+
WindowsARM64⚠️ LimitedVia Node.js source only
macOSIntel x64✅ Fully SupportedNotarized binaries
macOSApple Silicon (M1/M2/M3/M4)⚠️ ComingVia Node.js source only
Linuxx64✅ Fully SupportedMost distributions
LinuxARM64⚠️ LimitedVia Node.js source only

Container Support ​

PlatformStatusNotes
Docker✅ Fully SupportedLinux containers, multi-arch
Kubernetes✅ SupportedVia Docker images
Podman✅ SupportedCompatible with Docker images

Node.js Compatibility ​

For users running Butler Sheet Icons from source:

Node.js VersionStatusNotes
20.x LTS✅ RecommendedCurrent LTS, fully tested
18.x LTS✅ SupportedPrevious LTS, well tested
16.x LTS❌ UnsupportedNot compatible
<16.x❌ UnsupportedNot compatible

Upgrade Path ​

From BSI 2.x to 3.x ​

Breaking Changes:

  • --sense-version parameter now mandatory for QSEoW
  • Some command options renamed
  • Browser management improved

Migration Steps:

  1. Update to latest BSI 3.x
  2. Add --sense-version parameter to QSEoW commands
  3. Review command options for any changes
  4. Test in development environment

From BSI 1.x to 3.x ​

Major Changes:

  • Complete rewrite with improved reliability
  • New browser management system
  • Enhanced error handling
  • Better logging and debugging

Migration Steps:

  1. Review all command-line options (many changed)
  2. Update scripts and automation
  3. Test thoroughly before production use

Getting Version Information ​

Butler Sheet Icons Version ​

bash
butler-sheet-icons --version

Environment Information ​

bash
# Check all installed browsers
butler-sheet-icons browser list-installed

# Check system Node.js version (if running from source)
node --version

# Check Qlik Sense version (QSEoW)
# Access QMC → About

Reporting Compatibility Issues ​

When reporting version compatibility issues:

  1. Include Version Information:

    • Butler Sheet Icons version
    • Qlik Sense version (exact build number if possible)
    • Operating system and version
    • Browser version being used
  2. Provide Context:

    • What worked vs. what didn't
    • Error messages
    • Screenshots if UI-related
  3. Submit via GitHub:

Future Compatibility ​

Butler Sheet Icons is actively maintained to support:

  • Latest Qlik Sense Cloud updates
  • New QSEoW releases
  • Current browser versions
  • Modern operating systems

Support Policy:

  • Latest 3 major QSEoW releases fully supported
  • Current Qlik Sense Cloud always supported
  • Security updates for all supported versions
  • Legacy versions supported on best-effort basis

Released under the MIT License.