hostPort: 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]

Note: Notice that you have to provide the websocket url here which would begin with either wss:// or ws://

displayUrl: 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/<virtual-proxy-path>

Since we use the Qlik Sense Engine APIs, we need to authenticate to those APIs using certificates generated on Qlik Management Console.

In this approach we provide the path of the certificates to the certificate stored in the container or environment running the ingestion workflow.

• clientCertificate: This field specifies the path of client.pem certificate required for authentication.
• clientKeyCertificate: This field specifies the path of client_key.pem certificate required for authentication.
• rootCertificate: This field specifies the path of root.pem certificate required for authentication.

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:

You will have to replace new lines with \n and the final private key that you need to pass should look like this:

userId: This field specifies the user directory of the user.

userDirectory: This field specifies the user directory of the user.

validateHostName: Enable/Disable this field to validate the host name against the provided certificates.

The sourceConfig is defined here:

• dbServiceNames: Database Service Names for ingesting lineage if the source supports it.
• dashboardFilterPattern, chartFilterPattern, dataModelFilterPattern: Note that all of them support regex as include or exclude. E.g., "My dashboard, My dash.*, .*Dashboard".
• projectFilterPattern: Filter the dashboards, charts and data sources by projects. Note that all of them support regex as include or exclude. E.g., "My project, My proj.*, .*Project".
• includeOwners: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
• includeTags: Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
• includeDataModels: Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
• markDeletedDashboards: Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.
• Include Draft Dashboard (toogle): Set the 'Include Draft Dashboard' toggle to include draft dashboards. By default it will include draft dashboards.

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

Store Service Connection

If set to true (default), we will store the sensitive information either encrypted via the Fernet Key in the database or externally, if you have configured any Secrets Manager.

If set to false, the service will be created, but the service connection information will only be used by the Ingestion Framework at runtime, and won't be sent to the OpenMetadata server.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.caCertificate with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.