# Qlik Sense (On-Prem)

This article outlines integration with Qlik Sense (On-Prem), enabling efficient metadata management through features such as crawling, delta crawling, report preview, and lineage building (both automatic and manual).

Connectivity to Qlik Sense (On-Prem) is established using **REST APIs** and **WebSocket**. The connector supports **Authentication with Windows** and **Authorization with JWT**, allowing metadata extraction through **service account-based access** and **JWT-enabled virtual proxy** authentication.

<figure><img src="/files/ewLcSopm6YhbebXaNaPq" alt=""><figcaption></figcaption></figure>

## Overview

### **Connector Capabilities**

The QlikSense connector supports the following data objects:

<table data-header-hidden><thead><tr><th width="407.75"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Reporting Tools</td></tr><tr><td>Connector Version</td><td>Release6.3.4</td></tr><tr><td>Releases Supported (Available from)</td><td>Release3.0</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Qlik Sense]</p></td><td>REST APIs and WebSocket</td></tr><tr><td>Verified Qlik Sense (On-Prem) Version</td><td>November 2024 Release</td></tr></tbody></table>

{% hint style="info" %}
The Qlik Sense (On-Prem) connector has been validated with the mentioned "Verified Qlik Sense (On-Prem) Versions" and is expected to be compatible with other supported Qlik Sense (On-Prem) versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

### Connector Features

| Feature                                                                                                                          | Availability |
| -------------------------------------------------------------------------------------------------------------------------------- | :----------: |
| Crawling                                                                                                                         |       ✅      |
| Delta Crawling                                                                                                                   |       ✅      |
| Profiling                                                                                                                        |       ❌      |
| Query Sheet                                                                                                                      |       ❌      |
| Report Preview                                                                                                                   |       ✅      |
| Auto Lineage                                                                                                                     |       ✅      |
| Manual Lineage                                                                                                                   |       ✅      |
| Secure Authentication via Credential Manager                                                                                     |       ✅      |
| Data Quality                                                                                                                     |       ❌      |
| DAM (Data Access Management)                                                                                                     |       ❌      |
| Bridge                                                                                                                           |       ✅      |
| [Chrome Extension Supported](https://docs.ovaledge.com/home/browser-extension/features-and-operations#view-certification-status) |       ✅      |

### Metadata Mapping

For detailed information about Qlik Sense metadata extraction, including scripts, measures, dimensions, sheets, visual objects, and internal data models, refer to [**Qlik Sense Metadata Extraction**](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/qlik-sense/qlik-sense-on-prem/qlik-sense-metadata-extraction?fallback=true)**.**

The following objects are crawled from Qlik Sense (On-Prem) and mapped to the corresponding UI assets.

<table><thead><tr><th width="169">Qlik Sense Object</th><th width="191.8333740234375">Qlik Sense Attribute</th><th width="180.5">OvalEdge Attribute</th><th width="183.8333740234375">OvalEdge Category</th><th width="163">OvalEdge Type</th></tr></thead><tbody><tr><td>Apps</td><td>App</td><td>Report Group</td><td>Report Group</td><td>Apps</td></tr><tr><td>Apps</td><td>Report</td><td>Report</td><td>Presentation Layer</td><td>Apps</td></tr><tr><td>Apps</td><td>App Description</td><td>Source Description</td><td>Description</td><td>Apps</td></tr><tr><td>Sheets</td><td>Sheet</td><td>Report</td><td>Report</td><td>Sheets</td></tr><tr><td>Sheets</td><td>Sheet Description</td><td>Source Description</td><td>Description</td><td>Sheets</td></tr><tr><td>Cells</td><td>Cell</td><td>Report</td><td>Report</td><td>Cells</td></tr><tr><td>Cells</td><td>Cell Description</td><td>Source Description</td><td>Description</td><td>Cells</td></tr><tr><td>Streams</td><td>Stream</td><td>Report Group</td><td>Report Group</td><td>Streams</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

For detailed steps to create a **service account user**, **configure user access**, configure **Admin permissions**, and assign **minimum required security rules** for Authentication with Windows, refer to the [**Access Configuration for Qlik Sense on Windows**](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/qlik-sense/qlik-sense-on-prem/access-configuration-for-qlik-sense-on-windows).

For detailed steps to configure **virtual proxy** settings, **JWT certificates**, and **authentication parameters** required for **Authorization with JWT**, refer to the [**JWT Authentication Configuration for Qlik Sense**](https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/qlik-sense/qlik-sense-on-prem/jwt-authentication-configuration-for-qlik-sense).

#### **Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
👨‍💻Who can provide these permissions? These permissions are typically granted by the Qlik Sense administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th width="281.5">Objects</th><th>Access Permission</th></tr></thead><tbody><tr><td>Connector Validation</td><td>Windows Service user with Audit Admin rights</td></tr><tr><td>Crawling</td><td>Windows Service user with Audit Admin rights</td></tr><tr><td>Lineage</td><td>Windows Service user with Audit Admin rights</td></tr><tr><td>Delta Crawl</td><td>Windows Service user with Audit Admin rights</td></tr><tr><td>Apps</td><td>Windows Service user with Audit Admin rights</td></tr><tr><td>sheets</td><td>Windows Service user with Audit Admin rights</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into **OvalEdge**, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Qlik Sense**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="219">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Qlik Sense" is displayed as the selected connector type.</td></tr><tr><td>Type of Server*</td><td>Select QliksenseOnPrem from the dropdown menu.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Qlik Sense (On-Prem) connection              </p><p>(Example: "Qlik Sense_test").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Authentication*</td><td><p>The following three types of authentication are supported for Qlik Sense (On-Prem):</p><ul><li>Authentication with Windows</li><li>Authorization with JWT</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Authentication with Windows" %}

<table><thead><tr><th width="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connection url*</td><td>Enter the Hostname or IP address of the Qlik Sense (On-Prem) (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-xxx-1.xxx.xxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>Qlik Sense User Id*</td><td>Provide the service account User ID with required permissions to connect to Qlik Sense.</td></tr><tr><td>Qlik Sense User Password*</td><td>Enter the password associated with the Qlik Sense service account.</td></tr><tr><td>Alias Host Name</td><td>Enter the alias host name of the Qlik Sense (On-Prem) server used for establishing connectivity.</td></tr><tr><td>Logs Path</td><td>Enter the directory path where Qlik Sense logs will be stored for monitoring and troubleshooting.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes if a proxy server is required for connectivity, otherwise select No.</td></tr><tr><td>QVDs Path</td><td>Provide the path where QVD files are stored for metadata crawling.</td></tr><tr><td>Xml files generation path</td><td>Enter the path created in the OvalEdge server to generate metadata files.</td></tr><tr><td>Path to store QVDS</td><td>Enter path to save extension-modified QVD files for later use.</td></tr><tr><td>QVS Path</td><td>Enter the directory path where QVS script files are located.</td></tr><tr><td>Certificate Path</td><td>Enter the path where the Qlik Sense certificates are stored for secure authentication.</td></tr><tr><td>Certificates Password</td><td>Enter the password associated with the Qlik Sense certificates.</td></tr><tr><td>User Directory</td><td>Enter the Qlik Sense user directory name configured in the QMC (Qlik Management Console).</td></tr><tr><td>Crawl Streams</td><td>Select <strong>Y</strong> to enable crawling of Qlik Sense streams, or <strong>N</strong> to skip them.</td></tr><tr><td>Exclude UnPublished Apps(Y/N)</td><td>Select Y to exclude unpublished apps during crawling, or N to include them.</td></tr><tr><td>Exclude UnPublished Sheets(Y/N)</td><td>Select Y to exclude unpublished sheets during crawling, or N to include them.</td></tr></tbody></table>
{% endtab %}

{% tab title="Authorization with JWT" %}

<table><thead><tr><th width="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connection url*</td><td>Enter the Hostname or IP address of the Qlik Sense (On-Prem) (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-xxx-1.xxx.xxxx.com or 1xx.xxx.1.xx).</td></tr><tr><td>JWT Token*</td><td>Enter the JSON Web Token (JWT) required for authentication with Qlik Sense.</td></tr><tr><td>Prefix*</td><td>Enter the user directory prefix associated with the JWT token for successful authentication.</td></tr><tr><td>Alias Host Name</td><td>Enter the alias host name of the Qlik Sense (On-Prem) server used for establishing connectivity.</td></tr><tr><td>Logs Path</td><td>Enter the directory path where Qlik Sense logs will be stored for monitoring and troubleshooting.</td></tr><tr><td>Proxy Enabled</td><td>Select Yes if a proxy server is required for connectivity, otherwise select No.</td></tr><tr><td>QVDs Path</td><td>Provide the path where QVD files are stored for metadata crawling.</td></tr><tr><td>Xml files generation path</td><td>Enter the path created in the OvalEdge server to generate metadata files by the node server.</td></tr><tr><td>Path to store QVDS</td><td>Enter path to save extension-modified QVD files for later use.</td></tr><tr><td>QVS Path</td><td>Enter the directory path where QVS script files are located.</td></tr><tr><td>Certificate Path</td><td>Enter the path where the Qlik Sense certificates are stored for secure authentication.</td></tr><tr><td>Certificates Password</td><td>Enter the password associated with the Qlik Sense certificates.</td></tr><tr><td>User Directory</td><td>Enter the Qlik Sense user directory name configured for authentication.</td></tr><tr><td>Crawl Streams</td><td>Select Y to enable crawling of Qlik Sense streams, or <em>N</em> to skip them.</td></tr><tr><td>Exclude UnPublished Apps(Y/N)</td><td>Select Y to exclude unpublished apps during crawling, or N to include them.</td></tr><tr><td>Exclude UnPublished Sheets(Y/N)</td><td>Select Y to exclude unpublished sheets during crawling, or N to include them.</td></tr><tr><td>Is Virtual Proxy Enabled(Y/N)</td><td>Select Y if a virtual proxy is configured in Qlik Sense, otherwise select N.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows you to select one or more Report Groups for crawling.&#x20;

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the schemas to be crawled.
3. The **Crawl** option is selected by default.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog.**
5. After a successful crawl, the information appears in the **Data Catalog > Report / Report Column** tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the Select **Period drop-down**.
2. Select a time interval for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected **crawl operation** at the scheduled time.

#### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

#### Managing connectors includes:

* **Connector Health:** Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details, including databases, tables, columns, and codes.

**Nine Dots Menu Options:**

To view, edit, validate, build lineage, configure, or delete connectors, click on the **Nine Dots** menu.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector**: Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Build Lineage:** Automatically build data lineage using source code parsing.
* **Delete Connector:** Remove a connector with confirmation.

## Additional Information

<table><thead><tr><th width="233.0909423828125">Configuration</th><th>Details</th></tr></thead><tbody><tr><td>Qlik Sense On-Premises Certificates</td><td>For Qlik Sense On-Premises connections, add the required Qlik certificates to the Java keystore (<code>cacerts</code>) before validating the connection.</td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/reporting-tool/qlik-sense/qlik-sense-on-prem.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.