Kaptain

This section will describe the additional steps needed to setup Kaptain on SaaS and the specific way to use Kaptain

Content Security Policy

After you have uploaded the Komment extension via the QMC you need to make a small change to the content security setup. So navigate to the menu item Content Security Policy => In the top right corner press Add => In the Directive section select connect-src and connect-src (web-socket). In the Origin write the URL to your Kaptain service - e.g. kaptain.domain.com. You can provide a name of your own choice - e.g. 'Kaptain'. Finish by pressing Add.

Remember to include the port in the Origin if relevant. e.g. like kaptain.domain.com:8000

API Key

In order for Kaptain to be able to perform reloads and store data on Qlik SaaS it must have an API key setup in the configuration file. So there are two steps to take:

  1. Generate API key on Qlik SaaS

  2. Input API key in Kaptain config file

1. Generate API key

You can follow the below steps to generate an API key on Qlik SaaS:

  1. Log onto your tenant, for example, https://<tenantname>.com.

  2. Click your profile in the top right corner and select Profile settings.

  3. Select API keys.

  4. Click Generate new key.

  5. Enter an API key description and select when the API key should expire.

  6. Click Generate.

    An API key is generated.

  7. Copy the API key and store it in a safe place.

Currently Kaptain only supports one API key so use a generic user account to create the API key

2. Input API key into Config file

The configuration file is placed under Kaptain installation folder. Default location:

C:\Program Files\ExtendBI\Kaptain\config\default.json

Find the Host section and fill out the section with the API key you just created and the relevant hostname of your Qlik SaaS tenant:

Recommended setup and process

Due to the design of the Spaces on Qlik SaaS and the need for an API key, the current best practice when using Kaptain as a Data connection is as follows.

  • Kaptain is required for saving to work in managed spaces and:

    • The app owner must be the user account who owns the API key used in Kaptain configuration (in backend)

    • If your QVDs are to be stored to a managed space, this must also be owned by this user

  • Kaptain only supports one API key currently. This calls for below setup and development process:

    • Create a generic user account that will generate the API key to be used by Kaptain

    • Each developer can setup everything in the app using Kaptain but it will not be possible to trigger partial reload (unless he is logged in with the generic account)

    • To test partial reload works:

      • Move app to shared space

      • Change owner to generic account

      • Open app with own user and try to save

      • Check that data reload is happening - i.e. data is brought into Qlik data model and not just Komment table

      • If QVD transport is used check the selected space for saved QVD

PreviousSpacesNextIntro

Last updated