Submit a ticket My tickets
Welcome
Login  Sign up

Qlik Sense Enterprise (Windows) Connector

This article explains how to use Qlik Sense Enterprise connector for DataGalaxy.

This connector is available in the following modes:

Desktop mode ✅SaaS Online mode ❌

Connector Overview

The connector allows importing metadata from a Qlik Sense Enterprise server. The retrieved objects and their correspondences in DataGalaxy are detailed in the following table:

Qlik Sense ObjectDataGalaxy ObjectComments
(none)Application (root)A root level application is created during the import (to be named during setup) in the Usage module. 

Streams

Application

Each Qlik Sense Stream is imported as a child application

Application

Dashboard

Only applications published in a Stream are taken into account

Sheet

Report

 

Table
Dataset
FieldUsage field
Master Item (measure, dimension)Usage fieldThe lineage between Master Items and Fields is retrieved too.

Step 1: Installation

  • Download DataGalaxy connector from the portal (see here)
  • Extract the connector archive in the directory of your choice
  • Download the Qlik Sense Entreprise plug-in from the portal and copy it into the /lib directory of the connector

Step 2 : Running Qlik Sense connector

  • After starting the connector, access Software type connectors:
  • If it has been correctly installed, the Qlik Sense Enterprise plug-in appears in the list
  • The following information is requested: 
ParameterMandatoryDescription
ServerYesQlik Sense server hostname
Port APIYesQRS REST API port, 4242 by default, to be modified if the server configuration is different
Port WSYesEngine JSON API WebSocket port, 4747 by default, to be modified if the server configuration is different
Root application nameYes

Root application name in the DataGalaxy Usage module, which will be used to store all Qlik Sense applications. If the application does not exist, it will be created during the import.

KeyStore PKCS12YesQlik Sense certificate information, see below for how to generate the certificate
KeyStore PKCS12 passwordYes
Root certificateYes
Get "Label Expression" fieldNoRetrieve the "Label Expression" field and import it as "Summary" attribute

Once this information has been filled in, you must test the connection in order to start the import procedure.

Technical Information

Qlik Sense connector uses the Qlik Sense Repository APIs (https://help.qlik.com/en-US/sense-developer/April2020/APIs/RepositoryServiceAPI/index.html?page=0)

Generating Qlik Sense certificates

Certificates must be generated from the Qlik Sense Management Console (QMC) in order to use the connector

The certificates must be generated with the following options: 

  • Machine name: this information is mandatory, but it doesn't need to match the computer's name that will use the certificate (this information is not checked afterwards)
  • It is not necessary to enter a password at this stage
  • Check the "Include secret key" box
  • Choose the PEM format for the certificates
  • Note the name of the path where the certificates will be generated on the server
  • Click on the "Export certificates" button at the bottom of the page
  • Retrieve the generated files from the Qlik Sense server


More information on this export procedure is available here : https://help.qlik.com/en-US/sense/June2019/Subsystems/ManagementConsole/Content/Sense_QMC/export-certificates.htm

Generating a PKS12 formatted key

Once the files have been retrieved, the key obtained must be converted to the PKS12 format (extension .p12) expected by the connector. To do this, use the openssl utility (installed by default on UNIX and MAC, to be installed on Windows - available for example here)

openssl pkcs12 -export -inkey client_key.pem -in client.pem -out client.p12

You will be asked for a password during the generation process. It is important to write it down because you will need it when you run the connector.

Once these operations have been carried out, you will have :

  • A p12 file corresponding to the KeyStore PKS12
  • A KeyStore password
  • A root certificate: this is the root.pem file generated by Qlik Sense

Releases

DatePlugin
Version
DataGalaxy
release
Desktop Connector
version (minimum)
Description
09/04/20265.3.1
5.15.8Fix: add missing fields in CSV export (Technical type, Expression for Master Items)
11/03/20265.3.0v3.315.05.15.6Feature: add ability to retrieve label expression field from measures in "summary" attribute
17/04/20255.1.2
5.5.5Fix: WebSocket default port + loading value from saved connection profile
28/03/20255.1.0v3.154.25.5.0Added WebSocket JSON API connection to retrieve app Tables + Master Items
23/08/20245.0.1v3.69.05.2.3Updated the logger to show more information when using verbose mode  
30/07/20245.0.0v3.63.0
5.0.4Migrated from java 11 to java 17 + CVE fixes


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.