Skip to main content

Adding a Qlik Sense Connection

Prerequisites

  • A user with sufficient permissions is required to establish a connection with Qlik Sense.
  • Zeenea traffic flows towards the data source must be open.
TargetProtocolUsual Ports
Qlik Sense ServerHTTP/HTTPS80/443

Supported Versions

The Qlik Sense connector was developed and tested with Qlik Sense Server version 14.20.5.

Installing the Plugin

The Qlik plugin can be downloaded here: Zeenea Connector Downloads

For more information on how to install a plugin, please refer to the following article: Installing and Configuring Connectors as a Plugin.

Declaring the Connection

Creating and configuring connectors is done through a dedicated configuration file located in the /connections folder of the relevant scanner. The scanner frequently checks for any change and resynchronises automatically.

Read more: Managing Connections

In order to establish a connection with a Qlik Sense instance, specifying the following parameters in the dedicated file is required:

ParameterExpected value
nameThe name that will be displayed to catalog users for this connection.
codeThe unique identifier of the connection on the Zeenea platform. Once registered on the platform, this code must not be modified or the connection will be considered as new and the old one removed from the scanner.
connector_idThe connector type to use for the connection. Here, the value must be qlik-sense and this value must not be modified.
connection.urlQlik Sense server address (example: https://hostname.port/virtual-proxy)
connection.auth.keyHeader name for authentication
connection.auth.valueHeader value for authentication, format: domain\user name
tls.truststore.pathThe Trust Store file path. This file must be provided in case TLS encryption is activated (protocol https) and when certificates of Qlik Sense servers are delivered by a specific authority. It must contain the certification chain.
tls.truststore.passwordPassword of the trust store file
tls.truststore.typeType of the trust store file (PKCS12 or JKS). Default value is discovered from the file extension.
proxy.schemeDepending on the proxy, http or https
proxy.hostnameProxy address
proxy.portProxy port
proxy.usernameProxy username
proxy.passwordProxy account password
note

A template of the configuration file is available in this repository.

User Permissions

In order to collect metadata, the running user's permissions must allow them to access and read applications and sheets that need cataloging.

Here, the user must have read access to correspondent applications and their sheets from the QRS API.

Data Extraction

To extract information, the connector runs requests on the Qlik Sense API.

  • To collect applications: /qrs/app/full
  • To collect sheets: /qrs/app/object/full

Collected Metadata

Inventory

Will collect the list of sheets applications accessible by the user.

Visualization

A visualization is a sheet from an application.

  • Name: Sheet name
  • Source Description: Sheet description
  • Contacts
  • Technical Data:
    • Application Name
    • Sheet Url
    • Creation Date
    • Modification Date
    • Publish Date

Unique Identifier Keys

A key is associated with each item of the catalog. When the object comes from an external system, the key is built and provided by the connector.

More information about unique identification keys in this documentation: Identification Keys.

ObjectIdentifier KeyDescription
Visualizationcode/application id/sheet id
  • code: Unique identifier of the connection noted in the configuration file
  • application id
  • sheet id