Skip to main content
In this section, we provide guides and references to use the Qlik Sense connector. Configure and schedule Metabase metadata and profiler workflows from the OpenMetadata UI:

​
Requirements

OpenMetadata 1.1.1 or later

To deploy OpenMetadata, check the Deployment guides.

​
Metadata Ingestion

​
Connection Details

1

Connection Details

When using a Hybrid Ingestion Runner, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:
password: secret:/my/database/password
This applies only to fields marked as secrets in the connection form (these typically mask input and show a visibility toggle icon). For a complete guide on managing secrets in hybrid setups, see the Hybrid Ingestion Runner Secret Management Guide.
  • Qlik Sense Base URL: This field refers to the base url of your Qlik Sense Portal, will be used for generating the redirect links for dashboards and charts. Example: https://server.domain.com or https://server.domain.com/<proxy-path>
  • Qlik Engine JSON API Websocket URL: Enter the websocket url of Qlik Sense Engine JSON API. Refer to this document for more details about. Example: wss://server.domain.com:4747 or wss://server.domain.com[/virtual proxy]. Since we use the Qlik Sense Engine APIs, we need to authenticate to those APIs using certificates generated on Qlik Management Console. Qlik Certificate By Values: In this approach we provide the content of the certificates to the relevant field.
  • Client Certificate Value: This field specifies the value of client.pem certificate required for authentication.
  • Client Key Certificate Value: This field specifies the value of client_key.pem certificate required for authentication.
  • Root Certificate Value: This field specifies the value of root.pem certificate required for authentication.
  • Staging Directory Path: This field specifies the path to temporary staging directory, where the certificates will be stored temporarily during the ingestion process, which will de deleted once the ingestion job is over. when you are using this approach make sure you are passing the key in a correct format. If your certificate looks like this:
-----BEGIN CERTIFICATE-----
MII..
MBQ...
CgU..
8Lt..
...
h+4=
-----END CERTIFICATE-----
You will have to replace new lines with \n and the final private key that you need to pass should look like this:
-----BEGIN CERTIFICATE-----\nMII..\nMBQ...\nCgU..\n8Lt..\n...\nh+4=\n-----END CERTIFICATE-----\n
Qlik Certificate By Path: In this approach we provide the path of the certificates to the certificate stored in the container or environment running the ingestion workflow.
  • Client Certificate Path: This field specifies the path of client.pem certificate required for authentication.
  • Client Key Certificate Value: This field specifies the path of client_key.pem certificate required for authentication.
  • Root Certificate Value: This field specifies the path of root.pem certificate required for authentication. User Directory: This field specifies the user directory of the user. User ID: This field specifies the user id of the user. Validate Host Name: Enable/Disable this field to validate the host name against the provided certificates.
2

Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.Test Connection
3

Configure Metadata Ingestion

After adding and testing the dashboard service, configure the metadata ingestion pipeline. To configure, follow the steps below:
  1. Navigate to Settings > Services > Dashboards.
  2. On the Dashboards services page, click the service you’ve added.
  3. Go to the Agents tab, and then click Add Agent > Add Metadata Agent.
  4. Configure the ingestion details. See Metadata Ingestion Options.
Configure Metadata Ingestion

​
Metadata Ingestion Options

  • Name: This field is the name of the ingestion pipeline. Customize it or use the generated name.
  • Dashboard Filter Pattern (Optional): Use it to control whether to include dashboards as part of metadata ingestion.
    • Include: Explicitly include dashboards by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
    • Exclude: Explicitly exclude dashboards by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
  • Chart Filter Pattern (Optional): Use it to control whether to include charts as part of metadata ingestion.
    • Include: Explicitly include charts by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
    • Exclude: Explicitly exclude charts by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
  • Data Model Filter Pattern (Optional): Use it to control whether to include data models as part of metadata ingestion.
    • Include: Explicitly include data models by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
    • Exclude: Explicitly exclude data models by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models will be included.
  • Project Filter Pattern: Filter the dashboards, charts, and data sources by projects. Note that all of them support regex as include or exclude. For example, “My project, My proj.*, .*Project”.
    We filter the projects by concatenating the entire project hierarchy using dot notation (for example, Project1.NestedProjectA.OtherProject). Make sure the regex filter pattern accounts for this fully-qualified format.
  • Enable Debug Log: Enable this toggle to use debug-level logging.
Metadata Ingestion Option 1
  • Lineage Information (Optional): Configure this section to enable lineage between your dashboards and the database tables they are built on. OpenMetadata uses the database service name to match and draw the lineage path from table to dashboard.
    • Db Service Prefixes: Enter one or more service path prefixes to tell OpenMetadata where to look for the source tables used by your dashboards. Supported formats:
      • DBServiceName—matches all tables in the service
      • DBServiceName.DatabaseName—matches tables in a specific database
      • DBServiceName.DatabaseName.SchemaName—matches tables in a specific schema
      • DBServiceName.DatabaseName.SchemaName.TableName—matches a specific table
  • Query Parser Configuration: Controls how OpenMetadata parses SQL queries to extract lineage. Use this to select the SQL parser that best fits your data source’s dialect.
    • Query Parser Type: Choose the SQL parser for lineage extraction:
      • Auto (default): Automatically tries SqlGlot first, falls back to SqlFluff, then SqlParse. Recommended for best results.
      • SqlGlot: High-performance parser with good dialect support. Falls back to SqlParse on failure.
      • SqlFluff: Comprehensive but slower parser with strong dialect support. Falls back to SqlParse on failure.
  • Include Current Owners: Enable this toggle to control whether to include owners for the ingested entity if the owner email matches a user stored in the OpenMetadata server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
  • Mark Deleted Dashboards: Optional configuration to soft delete dashboards in OpenMetadata if the source dashboards are deleted. After deleting, all associated entities like lineage and other related data for that dashboard will be deleted.
  • Mark Deleted Data Models: Optional configuration to soft delete data models in OpenMetadata if the source data models are deleted. After deleting, all associated entities with that data model will be deleted.
  • Mark Deleted Charts: Optional configuration to soft delete charts in OpenMetadata if the source charts are deleted. After deleting, all associated entities with that chart will be deleted.
  • Include Tags: Enable this toggle to control whether to include tags in metadata ingestion.
  • Include Data Models: Enable this toggle to control whether to include data models as part of metadata ingestion.
  • Include Draft Dashboard: Enable this toggle to include draft dashboards. By default, this is enabled.
  • Include Usage: Enable this toggle to control whether to include usage data as part of metadata ingestion.
  • Override Metadata: Enable this toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If enabled, the metadata fetched from the source will override the existing metadata in OpenMetadata. If disabled, only fields that have no value in OpenMetadata will be updated. This is applicable for fields like description, tags, owner, and displayName.
  • Override Lineage: Enable this toggle to control whether to override the existing lineage in OpenMetadata with the lineage fetched from the source. If enabled, existing lineage will be replaced. If disabled, new lineage edges will be added without removing existing ones.
Metadata Ingestion Option 2
4

Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.If something doesn’t look right, click the Back button to return to the appropriate step and change the settings as needed.After configuring the workflow, you can click on Deploy to create the pipeline.Schedule the Workflow
5

View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.View Ingestion Pipeline
If AutoPilot is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.

​
Securing Qlik Sense Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata and Qlik Sense, there are two ways to communicate: defining the certificate file path or using the certificates value. Navigate to the Advanced Config section. When using the local certificate file path, ensure that the certificates are accessible from the Airflow Server. You can specify the path for the client certificate, client key certificate, and root certificate. Alternatively, when using the certificates value, you can provide the CA certificate used for SSL validation by specifying the CA Certificate. If both client and server require mutual authentication, you can upload all three: CA Certificate, SSL Certificate, and SSL Key. Refer to the guide on how to generate authentication certificates so that OpenMetadata can communicate with Qlik Sense here. SSL Configuration by local file path SSL Configuration

​
Lineage

Lineage in OpenMetadata shows you which database tables power each dashboard. When lineage is set up, you can trace any dashboard back to the exact source tables in your database. There is no separate lineage agent or lineage pipeline—lineage is collected as part of the same metadata ingestion workflow. Configuring the Db Service Prefixes field (covered below) is optional but recommended — it restricts table matching to specific database services. If left blank, OpenMetadata attempts to match source tables across all ingested database services. lineage Information

​
How to Set Up Lineage

  1. Go to Settings > Services > Dashboards.
  2. Click the dashboard service you’ve added.
  3. Go to the Agents tab, then select Add Agent > Add Metadata Agent. If a metadata agent already exists, select the three-dot context menu (⋮) next to it and select Edit.
  4. In the Configure Ingestion step, scroll down to the Lineage Information section.
  5. Optionally enter one or more database service names in the Db Service Prefixes field to restrict table matching to specific services. If left blank, OpenMetadata searches across all ingested database services.
The Db Service Prefixes field helps OpenMetadata locate the source tables and draw the lineage path from table to dashboard. Examples of valid entries:
What you enterWhat it matches
SnowflakeProdAll tables in the Snowflake service named SnowflakeProd
SnowflakeProd.sales_dbTables in the sales_db database within SnowflakeProd
SnowflakeProd.sales_db.publicTables in the public schema within sales_db
If your dashboards pull data from multiple database services, add each service as a separate entry in the Db Service Prefixes field.