QlikSense (On-Prem)
This document 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). It also ensures secure authentication via Credential Manager.
Overview
Connector Capabilities
The QlikSense connector supports the following data objects:
Connector Category
Reporting Tools
Connector Version
Release6.3.4
Releases Supported (Available from)
Release3.0
Connectivity
[How the connection is established with Qlik Sense]
REST APIs and WebSocket
Verified Qlik Sense (On-Prem) Version
November 2024 Release
Connector Features
Crawling
✅
Delta Crawling
✅
Profiling
❌
Query Sheet
❌
Report Preview
✅
Auto Lineage
✅
Manual Lineage
✅
Secure Authentication via Credential Manager
✅
Data Quality
❌
DAM (Data Access Management)
❌
Bridge
✅
Metadata Mapping
The following objects are crawled from Qlik Sense (On-Prem) and mapped to the corresponding UI assets.
Apps
App
Report Group
Report Group
Apps
Apps
Report
Report
Presentation Layer
Apps
Apps
App Description
Source Description
Description
Apps
Sheets
Sheet
Report
Report
Sheets
Sheets
Sheet Description
Source Description
Description
Sheets
Cells
Cell
Report
Report
Cells
Cells
Cell Description
Source Description
Description
Cells
Streams
Stream
Report Group
Report Group
Streams
Set up a Connection
Prerequisites
The following are the prerequisites to establish a connection:
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.
Connector Validation
Windows Service user with Audit Admin rights
Crawling
Windows Service user with Audit Admin rights
Lineage
Windows Service user with Audit Admin rights
Delta Crawl
Windows Service user with Audit Admin rights
Apps
Windows Service user with Audit Admin rights
sheets
Windows Service user with Audit Admin rights
Connection Configuration Steps
Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Qlik Sense (On-Prem), and complete the required parameters.
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
License Add Ons
Auto Lineage
Supported
Data Quality
Not Supported
Data Access
Not Supported
Select the checkbox for Auto Lineage Add-On to build data lineage automatically.
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.
Connector Description
Enter a brief description of the connector.
Authentication*
The following three types of authentication are supported for Qlik Sense (On-Prem):
Authentication with Windows
Authorization with JWT
Authentication with Cookie
Authentication with certificates using Node Server
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 by the node server.
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 for authentication.
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.
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 Directory
Enter the Qlik Sense user directory name configured for authentication.
Qlik Sense Node Url
Enter the Qlik Sense node URL used to establish API connectivity.
Qlik Sense Node Url Read Timeout
Enter the read timeout (in seconds) for API calls made to the Qlik Sense node URL.
Qlik Sense User Password*
Enter the password associated with the Qlik Sense user account.
Alias Host Name
Enter the alias host name of the Qlik Sense (On-Prem) server used for establishing connectivity.
Node API version*
Enter the supported Qlik Sense Node API version to be used for the connection.
Qlik Sense Port
Enter the port number configured for the Qlik Sense node server connection.
Qlik Sense Certs Path
Enter the file system path where Qlik Sense certificates are stored for secure authentication.
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 by the node server.
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 for authentication.
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.
After entering all connection details, the following actions can be performed:
Click Validate to verify the connection.
Click Save to store the connection for future use.
Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
To perform crawl operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows you to select one or more schemas for crawling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to be crawled.
The Crawl option is selected by default.
Click Run to collect metadata from the connected source and load it into the Data Catalog.
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.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time interval for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.
Last updated
Was this helpful?