Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at https://www.stonebranch.com/integration-hub/Terms-and-Privacy/Terms-of-Use/

Overview

Qlik Sense is a Business Intelligence (BI) Tool. Qlik Sense users can connect and combine data from hundreds of data sources by defining data pipelines as applications. Data can then be visualized via custom dashboards on a Qlik Sense Cloud instance (Business or Enterprise edition) or by using a Desktop application (Enterprise Windows edition).

This Universal Extension provides the capability to perform reload related actions upon an Application, stored on a Qlik Sense Cloud instance.

Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Python 3.7.0 or higher. Tested with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

Both Windows and Linux agents are supported:

• Universal Agent for Windows x64 Version 7.0.0.0 and later with python options installed.
• Universal Agent for Linux Version 7.0.0.0 and later with python options installed.

Software Requirements for Universal Controller

Universal Controller Version 7.0.0.0 and later.

Network and Connectivity Requirements

• Universal Agent where the extension is deployed, should be able to reach the Qlik Sense Cloud instance.
• A Qlik Sense API Key should be generated in prior from the Qlik Sense Cloud Management Console. API Keys can be generated from users who have either 'Tenant Admin' or 'Delelopers' Role assigned.

Support Qlik Sense SaaS API versions

This Universal Extension is compatible with SaaS API version 24-Feb-2022.

Key Features

This Universal Extension provides the following main features, for a Qlik Sense Cloud instance:

Import Universal Template

To use this downloadable Universal Template, you first must perform the following steps:

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true.
2. To import the Universal Template into your Controller, follow the instructions here.
3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

Configure Universal Task

For the new Universal Task type Qlik Sense, create a new task, and enter the task-specific details that were created in the Universal Template

Input Fields

The input fields for this Universal Extension are described below.

Extension Cancelation

When using a 7.0 or newer template, we must ensure that the “Always Cancel On Force Finish” is checked. This is to minimize leaving “orphan” processes on the OS without the option for the agent to see they are running.

Task Examples

Reload a Qlik Sense Application

Reload an application on a Qlik Sense Cloud instance:

Read Reload Status of a Qlik Sense Application

Read the status of an already reloaded Qlik Sense application:

Task Output

Output Only Fields

The output parameters are set after every message processing. If they are 'preserved on re-run', they prevent a re-run of the task instance from restarting from scratch.
The output fields for this Universal Extension are described below.

Exit Codes

The exit codes for this Universal Extension are described below.

Extension Output

Extension Output example for a successful execution of Reload App:

{
    "exit_code": 0,
    "status_description": "SUCCESS: QlikSense App reloaded successfully.",
    "changed": true,
    "invocation": {
        "extension": "ue-qliksense",
        "version": "1.0.0",
        "fields": {
            "action": "Reload App",
            "qliksense_type": "Cloud",
            "tenant_url": "https://a4clkt1cb9k4trp.eu.qlikcloud.com",
            "api_credentials": "****",
            "app_id": "5aca2029-f5d7-48b7-9606-45d55f6bc469",
            "reload_id": null,
            "partial_reload": true,
            "enable_ssl_cert_verification": true
        }
    },
    "result": {
        "reload_id": "626bc4aef8699d7f94fd30da"
    }
}

Extension Output example for a successful execution of Read Reload Status:

{
    "exit_code": 25,
    "status_description": "SUCCESS: Reload status is SUCCEEDED.",
    "changed": true,
    "invocation": {
        "extension": "ue-qliksense",
        "version": "1.0.0",
        "fields": {
            "action": "Read Reload Status",
            "qliksense_type": "Cloud",
            "tenant_url": "https://a4clkt1cb9k4trp.eu.qlikcloud.com",
            "api_credentials": "****",
            "app_id": null,
            "reload_id": "626aa8eb3433e820e4e410e0",
            "partial_reload": false,
            "enable_ssl_cert_verification": true
        }
    },
    "result": {
        "reload_status": "SUCCEEDED"
    }
}

Document References

This document references the following documents: