Skip to main content

Qlik Sense integration

Overview​

Qalyptus Cloud allows you to connect to Qlik Sense SaaS using Qlik credentials or a Qlik Sense API key.

This option allows Qalyptus to connect to Qlik Sense using a JWT token created with the user's email address and a Qlik Sense API key. Users don't need to register their Qlik credentials in Qalyptus.

caution

Authenticate with Qlik Sense API key is only available for Qlik Sense SaaS Enterprise. The JWT authorization capabilities must be activated in your Qlik Sense tenant.

By default, the JWT authorization capabilities is desabled in Qlik Sense Cloud. If it is not yet activated, contact your Qlik account manager explaining that you need to activate the JWT capability to allow embedded analytics and reporting.

See below how to check if JWT authorization capabilities is active in your Qlik Sense tenant.

Qalyptus Cloud -check if JWT authorization capabilities is active

Qalyptus Cloud - Authenticate with Qlik Sense API key

To configure the Authenticate with Qlik Sense API key, follow the steps below:

  1. Go to Administration > Settings.
  2. Go to the Qlik Sense Integration section.
  3. Enter your Qlik Sense tenant hostname.
  4. The Web Integration Id will be created by Qalyptus.
  5. Select the option Qlik Sense API key.
  6. Enter a Qlik Sense API key. See below how to create Qlik Sense API key.
  7. Click Save.
info

After saving the information, Qalyptus will automatically renew the Qlik Sense API key to avoid any interruption of use. For security reasons, we recommend you choose a short duration for the API.

caution

Qalyptus will identify the user using their email address. The user email address must be identical in Qalyptus Cloud and Qlik Sense SaaS.

Authenticate with Qlik credentials​

This option allows Qalyptus Cloud to connect to Qlik Sense using the user's Qlik credentials (email and password). Each user in your Qalyptus tenant must register his Qlik Sense credentials in his Profile.

info

You can only use this option if the Identity Provider is not configured in your Qlik Sense tenant. In other terms, you connect to the Qlik Sense tenant using the Qlik authentication system.

Qalyptus Cloud - Authenticate with Qlik credentials

To configure the Qlik credentials authentication, follow the steps below:

  1. Go to Administration > Settings.
  2. Go to the Qlik Sense Integration section.
  3. Select the option Qlik credentials.
  4. Enter your Qlik Sense tenant hostname.
  5. Enter a Web Integration Id. See below how to create a Web Integration Id in Qlik Sense.
  6. Click Save.
caution

Qalyptus will use the user's Qlik credentials (email and password) to authenticate to Qlik Sense. The user email address must be the same in Qalyptus Cloud and Qlik Sense SaaS.

Create a Web Integration Id​

A Qlik Sense Web Integration Id will authorize your Qalyptus Cloud tenant to connect to connect to your Qlik Sense SaaS tenant.

Follow the steps described below to configure a Qlik Sense Web Integration Id.

  1. In Qalyptus Cloud, go to Administration > Settings
  2. Copy the Tenant hostname

Qalyptus Cloud - Get tenant host name

  1. Open Qlik Sense SaaS
  2. Go to Console Managment > Web
  3. Click Create new
  4. Enter a name of your choice
  5. Paste the the Qalyptus Cloud Tenant hostname copied previously and click Add
  6. Click Create

Qalyptus Cloud - Create Web Integration Id

  1. A web Integration Id will be generated
  2. Copy the Web Integtation Id
  3. Paste the Web Integration Id in Qalyptus > Settings > Qlik web integration Id

Qalyptus Cloud - Find Web Integration Id

Qalyptus Cloud - Add Web Integration Id

Generate a Qlik Sense API key​

A Qlik Sense API can be generated from the user profile in Qlik Sense SaaS. Before generating a Qlik Sense API, make sure that API key generation is enabled in Qlik Sense Settings and that the user who will generate the API key has a Developer role.

1- Enable API keys

Navigate to Qlik Sense Console Management > Settings and ensure the Enable API keys option is active.

Qalyptus Cloud - Enable API keys

2- User has the Developer role

Navigate to Qlik Sense Console Management > Users, click edit the user roles, and ensure they have the Developer role.

Qalyptus Cloud - User has Qlik developer role

3- Generate the API key

Folow the steps below to generate a Qlik Sens API key.

  1. In Qlik Sense SaaS, click the avatar in the upper-right corner of the screen
  2. Click Profile settings
  3. In the Management section, click API keys
  4. You will see all your existing API keys
  5. Click Generate new key
  6. Enter a description
  7. Set the expiration time from the drop-down list. Set a at least 3 days
  8. Click the Generate button to generate the API key

Qalyptus Cloud - Generate Qlik Sense API key

  1. The generated API key appears. Copy it and paste it in Qalyptus Cloud settings
info

After using the API key in Qalyptus Cloud, it will be renewed automatically one day before it expires.

Qalyptus Cloud - Qlik Sense API key generated