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.

Overview

Connector Capabilities

The QlikSense connector supports the following data objects:

Connector Category	Reporting Tools
OvalEdge Release Supported	Release6.3.4 and later
Connectivity [How the connection is established with Qlik Sense]	REST APIs and WebSocket
Verified Qlik Sense (On-Prem) Version	November 2024 Release

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.

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	✅

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.

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

Qlik Sense Object	Qlik Sense Attribute	OvalEdge Attribute	OvaEdge Category	OvalEdge Type
Streams	stream	Report Group	Report Group	Domain
Apps	App	Report Group	ReportGroup	Domain
Apps	App	Report	Report	Presentation Layer
Apps	App description	source Description	description
Sheet	Sheet	Report	Report	Sheet
Sheet	Sheet description	Source description	description
Cells	Cell	Report	Report	cell type
Cells	cell description	source description	description
Measures	Measure	Report Field	Report Field	Measure
Measures	Measure name	name	Report filed	Measure
Measures	Measure fomula	formula	Report field	Measure
Measures	Measure description	description	Report field	Measure
Dimensions	Dimension	Report Field	Report field	Dimension
Dimensions	Dimension name	name	Report field	Dimension
Dimensions	Dimension formula	formula	Report Field	Dimension
Dimensions	Dimension description	description	ReportField	Dimension
Master Objects	Master Object	Report Field	ReportField	Master Object
Master Objects	Master Object name	name	ReportField	Master Object
Master Objects	Master Object formula	formula	ReportField	Master Object
Master Objects	Master Object description	description	ReportField	Master Object
Variables	Variable	Report Field	ReportField	Variable
Variables	Variable name	name	ReportField	Variable
Variables	Variable value	formula	ReportField	Variable
Source Code	Script Info	Source Code	SourceCode	Script
Source Code	Script content	code	SourceCode	Script
Source Code	Script name	sourceCodeName	SourceCode	Script

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.

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.

Service Account User Permissions

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.

👨‍💻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.

Operations	Objects	Access Permission
Crawling	Space	User with View and Edit Access on Generated API Key
Crawling	Apps	User with View and Edit Access on Generated API Key
Crawling	Reports	User with View and Edit Access on Generated API Key
Crawling	Sub Reports	User with View and Edit Access on Generated API Key
Crawling	Source Code	User with View and Edit Access on Generated API Key

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

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

Fields marked with an asterisk (*) are mandatory for establishing a connection.

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

Authentication with Windows

Field Name	Description
Connection url*	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).
Qlik Sense User Id*	Provide the service account User ID with required permissions to connect to Qlik Sense.
Qlik Sense User Password*	Enter the password associated with the Qlik Sense service account.
Alias Host Name	Enter the alias host name of the Qlik Sense (On-Prem) server used for establishing connectivity.
Logs Path	Enter the directory path where Qlik Sense logs will be stored for monitoring and troubleshooting.
Proxy Enabled*	Select Yes if a proxy server is required for connectivity, otherwise select No.
QVDs Path	Provide the path where QVD files are stored for metadata crawling.
Xml files generation path	Enter the path created in the OvalEdge server to generate metadata files.
Path to store QVDS	Enter path to save extension-modified QVD files for later use.
QVS Path	Enter the directory path where QVS script files are located.
Certificate Path	Enter the path where the Qlik Sense certificates are stored for secure authentication.
Certificates Password	Enter the password associated with the Qlik Sense certificates.
User Directory	Enter the Qlik Sense user directory name configured in the QMC (Qlik Management Console).
Crawl Streams	Select Y to enable crawling of Qlik Sense streams, or N to skip them.
Exclude UnPublished Apps(Y/N)	Select Y to exclude unpublished apps during crawling, or N to include them.
Exclude UnPublished Sheets(Y/N)	Select Y to exclude unpublished sheets during crawling, or N to include them.

Authorization with JWT

Default Governance Roles

Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.

Admin Roles

Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.

Bridge

Select Bridge*	If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.

1. 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.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

To perform crawl operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows you to select one or more Report Groups for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the report groups 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 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 report, sub report, report 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.

For more details on connector settings, click here.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

Sl. No.	Error Message	Error Description and Resolution
1	SSL validation failed due to incorrect certificate configuration	Description: Connector validation failed because the SSL certificate path configured in server.xml was outdated or incorrect. Resolution: Update the certificate path in the server.xml configuration file. Restart the OvalEdge service after updating the configuration. Revalidate the connector to confirm successful SSL communication.
2	PKIX path building failed during Bridge validation	Description: Bridge validation failed due to missing or invalid SSL certificate configuration, resulting in a PKIX path building error. Resolution: Configure the correct SSL certificate path on the OvalEdge server. Verify that the certificate is valid and accessible by the Bridge service. Revalidate the connector after updating the certificate configuration.
3	SSL trust validation failed for Qlik Sense On-Prem connector	Description: Connector communication failed because the required SSL certificates were not available or trusted on the Bridge instance. Resolution: Import the required certificates into the Bridge truststore. Verify that all certificates are properly trusted by the environment. Revalidate the connector after updating the truststore configuration.
4	Engine connectivity failed due to certificate validation error	Description: The Qlik Sense engine connection failed because of an SSL certificate validation issue causing a PKIX path building error. Resolution: Update the SSL certificate configured on the server. Ensure the certificate is correctly installed and valid. Coordinate with the DevOps team to apply the required certificate updates.
5	403 Forbidden error during engine connectivity validation	Description: Connector validation failed with a 403 Forbidden error because the Qlik Sense server was unavailable or unreachable during validation. Resolution: Verify that the Qlik Sense server is up and running. Ensure the server is reachable from the OvalEdge environment. Retry connector validation after confirming server availability.

Additional Information

Configuration	Details
Qlik Sense On-Premises Certificates	For Qlik Sense On-Premises connections, add the required Qlik certificates to the Java keystore (cacerts) before validating the connection.

---

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA