sense-export

Just a simple button to export data in your Qlik Sense application without displaying them in a table first.

Usage no npm install needed!

<script type="module">
  import senseExport from 'https://cdn.skypack.dev/sense-export';
</script>

README

sense-export

Just a simple button to export data in your Qlik Sense application without displaying them in a table first.

Codacy Badge

sense-export

Table of Contents

(TOC generated by verb using markdown-toc)

Purpose and Description

sense-export is a tiny and sweet visualization extension allowing you to export data without showing the underlying table.

Why?

Every object in Qlik Sense provides the export functionality, but sometimes one just wants to provide a download of some data from your data model by putting a tiny little button onto a screen, completely without showing the data first.

Screenshots

Just a very simple button with some properties to define the layout and the behavior of the export. See Configuration for mor details.

All properties

Installation & Download

  1. Download the latest version or any other version you want to install.
  2. Then install on either Qlik Sense Desktop or Qlik Sense Server:
  • Qlik Sense Desktop
    • To install, unzip all files and copy the content to the folder folder "C:\Users\%USERNAME%\Documents\Qlik\Sense\Extensions\sense-navigation"
  • Qlik Sense Server

NOTE: Do not use the download button on GitHub to download the entire GitHub repository, please follow the instructions below! - otherwise you'll run into issues importing the visualization extension on Qlik Sense Enterprise.

Configuration

Dimensions & Measures

Define dimensions and measures as you would do for every other extension. Pro Tip: Enable the debug mode if you want to see the result.

Button label

  • Label - Just define the label of the button, defaults to "Export".

Button label property

Button layout

The possibilities to layout the button should (hopefully) be pretty self-explanatory:

  • Style - Select on of the predefined styles.
  • Button width - Define whether the button should take the full width of the object or not.
  • Alignment - Define the horizontal alignment.
  • Icon - Select one of the provided icons. Defaults to "download" Pro Tip: Font Awesome icons are used here, go to https://fortawesome.github.io/Font-Awesome/icons/ to get a nice overview of all icons possible.

Property export definition

Export definition

Define the final output of the export:

  • Format - Select on of the following values (defaults ot "Open XML (Excel)):
    1. Open XML (Excel),
    2. Comma separated CSV,
    3. Tab separated CSV"
    4. Comma separated CSV - Client Side (see below for more information)
  • State - You can define whether your current selection will be considered or not. If this is the desired behavior, select "Possible values", otherwise "All values", then always all data will be exported, regardless the current selections.
  • File name - Optionally you can define a file name.

Property export definition

A note on "Comma separated CSV - Client Side"

This is an experimental feature and will generated the exported file client-side, so in your browser, and not using the QIX Engine to generated the file. Why? There is a scenario where Qlik Sense Enterprise is configured to provide anonymous access to dashboard. In that case the QIX Engine generates the export files, but QRS does not allow to serve them (this can obviously seen as a bug and is being investigated).

Use this functionality with caution

  • Client side generation of export files is much slower
  • You might run into issues with larger data-sets

Currently tested only with this setup:

  • Qlik Sense 3.2 SR2, SR3
  • Chrome, Firefox, IE
  • Up to about 100.000 records with 10 columns (... takes quite a while, but works)

Debug

While working in edit mode it's quite helpful to test the data (which will then be exported in the defined format). If you enable the debug mode a debug table will be shown to double-check if you you have defined the correct measures and dimensions.

Note:

  • The debug table will only be shown in edit mode, even if this settings is activated
  • The debug table only shows the first 500 records (for performance reasons). The export will contain all data, though.

Property debug

Compatibility

sense-export is designed to work with Qlik Sense 2.1.1 or higher. If you use the visualization extension in an older version of Qlik Sense the following message will be shown:

Unsupported message

Known Issues

There are two known improvements which might be addressed in future versions:

  • Vertical alignment of the button is currently now possible.
  • Improvement for the mobile view, reserve less space for the export button.
  • Would be nice to have some kind of spinner in case of the client export

Related Projects

Some related projects (Qlik Sense Visualization Extensions) I have recently created:

About

Change Log

See ./CHANGELOG.yml

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue. The process for contributing is outlined below:

  1. Create a fork of the project
  2. Work on whatever bug or feature you wish
  3. Create a pull request (PR)

I cannot guarantee that I will merge all PRs but I will evaluate them all.

Using the Project in Dev-Hub

The default build of sense-export minifies the JavaScript files and does not contain a wbfolder.wbl file (which is just necessary for Dev-Hub).

So if you want to edit the extension or create your own extension based on sense-export download the ./build/sense-export_dev.zip file which always contains the latest version + a wbfolder.wbl file.

Author

Stefan Walther

License

MIT

This file was generated by verb-generate-readme, v0.6.0, on July 20, 2017.