Rock-VbCity / QSE

Grunt QlikSense Extensions

Grunt QSE Template (QS Visualization Extension)

This is a Grunt-Init Template that creates a QlikSense Visualization Extension with several features, including a companion Gruntfile.js giving you some tasks to manage your extension's build process and storing it at your GitHub repository.

Prerequisites

• node.js
• grunt-cli
• grunt-init
• QSE; the grunt-init scaffolding folder

This link Grunt Prerequisites explains with more details, what is required to install Grunt in your Windows machine.

Installation

We split the installation procedure in two separated documents:

• Grunt Installation explains the installation of the components required by Grunt and the QSE Grunt Template.
• Grunt QSE Template Installation explains installing the QSE Template in your Windows workstation.

Grunt Scaffolding Execution

Now that we installed the QlikSense's QSE Grunt Template let's build our first QlikSense Visualization Extension by executing the grunt-init command; Let's follow the instructions found at this document Grunt QSE Template Execution.

Visualization Extension Properties

The Grunt Scaffolding install a QlikSense Visualization Extension, with several pre-defined properties; we basically coded into the template several of the Visualization Extensions found in the Qlik Community and Qlik Help.

The following document Grunt QSE Properties explains them.

We consider it will be easier for you to amend these properties to your needs, and remove or comment out those that you do not need.

Visualization Extension Code

The Visualization Extension code is located in the file <Extension_Name>.js

There are two approaches to implement *Visualization Extensions:

• The Paint method rendering the Visualization Extension content.
• Using AngularJS in Visualization Extensions.

This *Visualization Extension* is based in the former method, it uses the *Paint* method to render its content.

Grunt Tasks

The QSE Grunt Template for QlikSense includes some pre-define Grunt tasks that could assist your development workflow by automating these tasks:

• src source folder updates.
• Updates the version number in your json, qext and about property.
• It generates the dist folder containing 3 distribution files:
  • <extension_name>.zip
  • <extension_name>-min.zip
  • <extension_name>-mix.zip

Please read this document explaining them Grunt QSE Pre-Defined Tasks.