Connect to and manage Qlik Sense in Microsoft Purview

This article outlines how to register Qlik Sense, and how to authenticate and interact with Qlik Sense in Microsoft Purview. For more information about Microsoft Purview, read the introductory article.

Supported capabilities

The supported Qlik Sense version is 11.11 to 14.x.

When scanning Qlik Sense, Microsoft Purview supports extracting technical metadata including:

• Server
• Folders
• Streams
• Applications
• Stories
• Dimensions
• Measures
• Expressions
• QVD (QlikView Data)
• Tables and the columns
• Sheets and the lists, charts, report tables, pivot tables, axes, text boxes, text fields

Known limitations

• When object is deleted from the data source, currently the subsequent scan won't automatically remove the corresponding asset in Microsoft Purview.

Prerequisites

• You must have an Azure account with an active subscription. Create an account for free.

• You must have an active Microsoft Purview account.

• You need an Azure Key Vault, and to grant Microsoft Purview permissions to access secrets.

• You need Data Source Administrator and Data Reader permissions to register a source and manage it in the Microsoft Purview governance portal. For more information about permissions, see Access control in Microsoft Purview.

• Set up the right integration runtime for your scenario. If your data source isn't publicly accessible, set up the latest kubernetes supported self-hosted integration runtime.

Required permissions for scan

Microsoft Purview extracts metadata via Qlik Engine API (JSON over WebSocket). It supports Qlik Sense certificate authentication for scanning Qlik Sense. Make sure:

• User account must have read access granted.
• This may be accomplished by creating security rules for a specific application and user.
• Another alternative is if the application is published to a specific stream and the user has rights to read from this stream.

The user must have appropriate permissions:

• Read all application objects (especially script).
• Read all data connections (or at least data connections specified in application).

Create Qlik Sense certificate

You need to export the certificate from Qlik Sense. Learn more from Exporting certificates through the QMC.

1. Launch Qlik Management Console (QMC): https://your_QPS_server_name/qmc.
2. Under CONFIGURE SYSTEM, click Certificates.
3. Enter the machine name, and optionally input the certificate password or leave it empty.
4. Keep the export file format as "Windows format".
5. Note the location where the certificate will be exported to, and then click Export certificates.
6. In File Explorer, navigate to where the certificate was exported to, e.g. C:\ProgramData\Qlik\Sense\Repository\Exported Certificates.

Next, store the client.pfx certificate you exported in your Azure Key Vault. You can choose to store it as a certificate or as a secret.

• To store it as a certificate, follow the steps in Tutorial: Import a certificate in Azure Key Vault. If your certificate is protected by a password, note after imported in Key Vault, its associated password isn't saved. The password is required only once during the import operation.
• To store it as a secret, you can convert the content of client.pfx to Base64 format using https://www.base64encode.org/, and put the resulted string as secret value. If your certificate is protected by a password, also save the password as another secret.

Register

This section describes how to register a Qlik Sense server in Microsoft Purview by using the Microsoft Purview governance portal.

1. Go to your Microsoft Purview account.

2. Select Data Map on the left pane.

3. Select Register.

4. In Register sources, select Qlik Sense > Continue.

5. On the Register sources (Qlik Sense) screen, do the following:

   1. For Name, enter a name that Microsoft Purview will list as the data source.

   2. For Server URL, enter the URL of your Qlik Sense server. In order to use the Qlik Engine API, you need to open a WebSocket to the engine using one of the following URIs: wss://server.domain.com:4747/app/ or wss://server.domain.com[/virtual proxy]/app/.

   3. Select a collection from the list.

   

6. Select Register.

Scan

Use the following steps to scan Qlik Sense server to automatically identify assets. For more information about scanning in general, see Scans and ingestion in Microsoft Purview.

1. Go to Sources.

2. Select the registered Qlik Sense source.

3. Select + New scan.

4. Provide the following details:

   1. Name: Enter a name for the scan.

   2. Connect via integration runtime: Choose the proper type of integration runtime. Learn more from Choose the right integration runtime configuration for your scenario.

   3. Credential: Select the credential to connect to your data source. Follow the steps to Create Qlik Sense certificate and store it in Azure Key Vault. When creating the credential, make sure to:

      • Select Qlik Sense certificate Authentication while creating a credential.
      • Specify the user name.
      • Specify the user directory. See the "Users" page in the Qlik Management Console (https://your_QPS_server_name/qmc).
      • For the certificate, specify the Key Vault certificate or secret name.
      • If your certificate is protected by a password and you store the certificate as a Key Vault secret, also specify the Key Vault secret name for the password.

      For more information, see Credentials for source authentication in Microsoft Purview.

   4. Server data folder: The network shared location of Qlik Sense Server's Qlik View Data (QVD) folder, e.g. \\QlikSense\qliksenseshare. If specified, Microsoft Purview tries to access the network shared location and scan the QVD files.

5. Click Test connection to validate the settings.

   

6. Select Continue.

7. For Scan trigger, choose whether to set up a schedule or run the scan once.

8. Review your scan and select Save and Run.

View your scans and scan runs

To view existing scans:

1. Go to the Microsoft Purview portal. On the left pane, select Data map.
2. Select the data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.
3. Select the scan that has results you want to view. The pane shows you all the previous scan runs, along with the status and metrics for each scan run.
4. Select the run ID to check the scan run details.

Manage your scans

To edit, cancel, or delete a scan:

1. Go to the Microsoft Purview portal. On the left pane, select Data Map.

2. Select the data source. You can view a list of existing scans on that data source under Recent scans, or you can view all scans on the Scans tab.

3. Select the scan that you want to manage. You can then:

   • Edit the scan by selecting Edit scan.
   • Cancel an in-progress scan by selecting Cancel scan run.
   • Delete your scan by selecting Delete scan.

Browse, search, and view assets

After successfully scanning your Qlik Sense server, you can browse data catalog or search data catalog to view the asset details.

Next steps

Now that you've registered your source, use the following guides to learn more about Microsoft Purview and your data:

• Search the data catalog