Qlik Sense Connector | OpenMetadata Integration Guide

• Requirements
• Metadata Ingestion
• Troubleshooting

​

Requirements

​

Metadata Ingestion

​

Step 1: Add New Service

1. Navigate to Settings > Services.
2. Click Add New Service.

​

Step 2: Select a Service and Connector

​

Step 3: Add Service Name and Description

• Enter a unique, descriptive Service Name. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other QlikSense services you are ingesting metadata from.
• Optional: Enter a Description for the service.

​

Step 4: Configure Connection Options

​

Enter Connection Details

• Qlik Sense Base URL: This field refers to the base URL of your Qlik Sense portal. It’s used to generate 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 the Qlik Sense Engine JSON API. For more information, see the Qlik Engine API connection guide. Example: wss://server.domain.com:4747 or wss://server.domain.com[/virtual proxy].

• Qlik Certificate By Values: This approach provides the content of the certificates in the relevant field.
  • Client Certificate Value: This field specifies the value of the client.pem certificate required for authentication.
  • Client Key Certificate Value: This field specifies the value of the client_key.pem certificate required for authentication.
  • Root Certificate Value: This field specifies the value of the root.pem certificate required for authentication.
  • Staging Directory Path: This field specifies the path to the temporary staging directory, where the certificates are stored temporarily during the ingestion process. The directory is cleared once the ingestion job is over.
  When using this approach, make sure you pass the key in the correct format. If your certificate looks like this:

-----BEGIN CERTIFICATE-----
MII..
MBQ...
CgU..
8Lt..
...
h+4=
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----\nMII..\nMBQ...\nCgU..\n8Lt..\n...\nh+4=\n-----END CERTIFICATE-----\n

• Qlik Certificate By Path: This approach provides the path to the certificates stored in the container or environment running the ingestion workflow.
  • Client Certificate Path: This field specifies the path of the client.pem certificate required for authentication.
  • Client Key Certificate Value: This field specifies the path of the client_key.pem certificate required for authentication.
  • Root Certificate Value: This field specifies the path of the 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 or disable this field to validate the host name against the provided certificates.

​

Test Connection

​

Step 5: Configure Ingestion Options

​

How Filter Patterns Work

• Include: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
• Exclude: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

• contains: matches any name containing the value. For example, sales matches my_sales_data and sales_2024.
• starts with: matches names beginning with the value. For example, prod_ matches prod_db and prod_schema.
• ends with: matches names ending with the value. For example, _raw matches events_raw and logs_raw.
• is exactly: matches the exact name only. For example, analytics matches only analytics.
• matches regex: matches names using a regular expression. For example, ^prod_.*_v\d+$ matches prod_events_v1.

• Dashboard: Controls which dashboards OpenMetadata ingests from the source.
• Chart: Controls which charts within the ingested dashboards are included.
• Data Model: Controls which data models are included in metadata ingestion.

• Scan Mode: You can choose between the following scan modes:
  • Scan all: Ingests every asset of that type the connector can access. This is the default.
  • Only specific: Enables include rules so only assets matching at least one rule are ingested.
• Always exclude: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
• Preview: Shows a real-time summary of what will be in scope based on your current rules.
• Include rules (available only in Only specific mode): Click + Add to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

​

Step 6: Create & Deploy

​

Configure Metadata Agent and Schedule Ingestion

1. Navigate to Settings > Services and select the service type.
2. Click the service you have added.
3. Select the Agents tab and click Add Agent > Metadata. For some services, the dropdown is not available and clicking Add Agent takes you directly to the agent configuration page.
4. On the Configure Ingestion page, do the following and click Next.
   • Name this Ingestion: Enter a unique recognizable name for this ingestion pipeline.
   • Agent Setup: Configure ingestion parameters. The following fields are available:

     Field	Default	Description
     Db Service Prefixes	—	List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: DBService, DBService.Database, DBService.Database.Schema, DBService.Database.Schema.Table.
     Query Parser Type	Auto	Select the SQL parser used for lineage extraction from dashboard queries. Auto selects the best available parser automatically. SqlGlot is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. SqlFluff is a comprehensive parser with strong dialect support; falls back to SqlParse on failure.
     Mark Deleted Dashboards	On	Soft-delete dashboards in OpenMetadata when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Data Models	On	Soft-delete data models in OpenMetadata when they are removed from the source. Associated lineage is also deleted.
     Mark Deleted Charts	On	Soft-delete charts in OpenMetadata when they are removed from the source.
     Include Data Models	On	Ingest data model metadata.
     Include Draft Dashboards	On	Ingest dashboards that are in draft state.
     Include Usage	On	Collect and ingest usage statistics for dashboards.

     
   • Filter Patterns: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in Step 5: Configure Ingestion Options.
   • Scope & Behaviour: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     Toggle	Default	Description
     Enable Debug Log	Off	Sets the ingestion log level to DEBUG. Useful for troubleshooting.
     Include Current Owners	Off	When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information.
     Include Tags	On	Ingest tags from the source.
     Override Metadata	Off	When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value.
     Override Lineage	Off	When on, existing lineage is replaced with newly extracted lineage on each run.

     
5. On the Schedule Interval page, set when the agent runs:
   • Schedule: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   • On-Demand: No automatic schedule; trigger the agent manually when needed.
   
6. Click Add to deploy the agent.

​

Lineage

​

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.

​

Securing Qlik Sense Connection with SSL in OpenMetadata

​

Related