📝
📝
📝
📝
Komment - Qlik write-back extension
Search
⌃K
Comment on page

Installation

Time to complete: 1 minute

Komment

  1. 1.
    Import the extension from the Qlik Management Console (QMC)
  2. 2.
    The Komment extension should now be available from the Custom Objects tab under Extend BI bundle
Make sure you have the needed privileges to import extensions on the QMC
If you already have a version of Komment installed, make sure to delete this from the QMC before you upload the latest version

Disable QVD data connection and storage

If you as admin wants to restrict developers from using QVD as data storage that is also possible. It is done by disabling QVD Data Connection and QVD Storage. Follow these simple steps to achieve this:
  1. 1.
    Go to the folder where you have your Komment.zip file.
  2. 2.
    Open the zip file and navigate to static\config
  3. 3.
    Copy the file Settings.txt
  4. 4.
    Navigate out of the zip file and paste the Settings.txt file in the initial folder
  5. 5.
    Open the Settings.txt file
  6. 6.
    Change value to "true" and save and close the file
  7. 7.
    Copy the Settings.txt file
  8. 8.
    Open the Komment.zip file and navigate to static\config
  9. 9.
    Paste the Settings.txt file and say OK to replace the existing file
  10. 10.
    Navigate out of the zip file
  11. 11.
    Follow the above steps to import the updated zip file to the QMC
You should only disable QVD storage if you have Kaptain installed as you otherwise won't have any way to save your data.

Kaptain

If you are on a Standard plan or higher you have access to our Kaptain service.

Installation via Kaptain Console

From version 2.6.0

Scope: The below is valid for installations on Kaptain on Windows servers (it can be the Qlik Sense server but does not have to be)
Pre-requisites:
  • You must have access to the Windows/Qlik server with admin rights
  • Make a public port ready on the server so end user can access Kaptain service successfully:
    • If you install kaptain on same server as Qlik, you will need to define a port number (or choose default kaptain port 8000).
    • If you install kaptain on a dedicated server, a typical https port (443) will be preferred. In addition you will need to open 4747 port inbound on Qlik server to let Kaptain communicate with Qlik Engine.
Authentication: Based on certificates
Files needed: Kaptain-installer-2.6.0.exe
Initial steps:
  1. 1.
    Log into your Windows server and place the Kaptain-installer.exe in any give folder
  2. 2.
    Start the installation by double clicking the Kaptain-installer.exe
  3. 3.
    Choose Full Installation and installation folder and press Next
  4. 4.
    Once the installation is completed open Windows Services and start Kaptain DB Service and Kaptain Server Service.
    ​
  5. 5.
    Open a browser and go to http://localhost:8000 (Be aware we use the http protocol, sometimes the browser redirects to https) and set a new root password. This step is not required for old installations.
    ​
  6. 6.
    Enter admin as user and the password set in step 5 and press Log in.
    ​
  7. 7.
    Go to the Settings section under the System Management tab.
    ​
  8. 8.
    In the Settings section set Qlik Hub URL (e.g. https://qlik.extendbi.com) and press enter. We can add multiple URLs in this field.
    ​
  9. 9.
    In the Qlik Connection section set Qlik User ID for Kaptain as Qlik service admin user (The user has to have a root admin role in Qlik Sense QMC)
    ​
  10. 10.
    In the same section upload Qlik exported certificates from QMC (see below for instructions on how to create certificates)
    ​
  11. 11.
    In the Logs section set Log Level as info
    ​
  12. 12.
    Press Submit and Confirm you want to save the changes
    ​
  13. 13.
    You will see a confirmation message and the page will automatically refresh.
    ​
  14. 14.
    The installation is completed.
Steps for creating Certificate and key-file in .pem format:
Step 1-6 can be ignored if Kaptain is installed on Qlik Sense server
  1. 1.
    Open the QMC of your Qlik Sense server
  2. 2.
    Navigate to the Cetificates section
  3. 3.
    Press 'Add Machine Name' and enter your Kaptain server name (e.g. kaptain.extendbi.com)
  4. 4.
    Ignore password but Check mark to include secret key
  5. 5.
    Export file format for certificates as PEM-format
  6. 6.
    Press 'Export Certificates' button
  7. 7.
    Go to Windows File explorer and navigate to C:\ProgramData\Qlik\Sense\Repository\Exported Certificates
  8. 8.
    Copy Client.pem, Client_key.pem, Root.pem and paste into C:\Program Files\ExtendBI\Kaptain\config\Qlik
  9. 9.
    Go back to QMC and Certificates section
  10. 10.
    Press 'Add Machine Name' and enter your Qlik Sense server name (e.g. qlik.extendbi.com)
  11. 11.
    Enter password and Check mark to include secret key
  12. 12.
    Select Windows format for the file format
    ​
    ​
  13. 13.
    Press 'Export Certificates' button

How to activate HTTPS Service

  1. 1.
    Turn HTTP mode on
  2. 2.
    Turn PFX certificate on
  3. 3.
    Upload your .pfx certificate
  4. 4.
    Set a password
  5. 5.
    Submit the changes

Installation via Server Interface

From version 2.5.0

Scope: The below is valid for installations on Kaptain on Windows servers (it can be the Qlik Sense server but does not have to be)
Pre-requisites:
  • You must have access to the Windows/Qlik server with admin rights
  • Make a public port ready on the server so end user can access Kaptain service successfully:
    • If you install kaptain on same server as Qlik, you will need to define a port number (or choose default kaptain port 8000).
    • If you install kaptain on a dedicated server, a typical https port (443) will be preferred. In addition you will need to open 4747 port inbound on Qlik server to let Kaptain communicate with Qlik Engine.
Authentication: Based on certificates
Files needed: Kaptain-installer-2.5.0.exe
Installation steps:
Initial steps:
  1. 1.
    Copy Kaptain-installer.exe to the Windows server
  2. 2.
    Start installation by double click the Kaptain-installer.exe
  3. 3.
    Choose Full Installation and installation folder and press Next
  4. 4.
    Navigate to C:\Program Files\ExtendBI\Kaptain
    1. 1.
      Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
    2. 2.
      Update the following according to your system:
      1. 1.
        corsAllowOrigins
      2. 2.
        userId
      3. 3.
        COMPANY
      ​
      ​
Steps for creating Certificate and key-file in .pem format:
Step 1-6 can be ignored if Kaptain is installed on Qlik Sense server
  1. 1.
    Open the QMC of your Qlik Sense server
  2. 2.
    Navigate to the Cetificates section
  3. 3.
    Press 'Add Machine Name' and enter your Kaptain server name (e.g. kaptain.extendbi.com)
  4. 4.
    Ignore password but Check mark to include secret key
  5. 5.
    Export file format for certificates as PEM-format
  6. 6.
    Press 'Export Certificates' button
  7. 7.
    Go to Windows File explorer and navigate to C:\ProgramData\Qlik\Sense\Repository\Exported Certificates
  8. 8.
    Copy Client.pem, Client_key.pem, Root.pem and paste into C:\Program Files\ExtendBI\Kaptain\config\Qlik
  9. 9.
    Go back to QMC and Certificates section
  10. 10.
    Press 'Add Machine Name' and enter your Qlik Sense server name (e.g. qlik.extendbi.com)
  11. 11.
    Enter password and Check mark to include secret key
  12. 12.
    Select Windows format for the file format
    ​
    ​
  13. 13.
    Press 'Export Certificates' button
  14. 14.
    Copy the exported files to C:\Program Files\ExtendBI\Kaptain\config\kaptain folder
  15. 15.
    Navigate to C:\Program Files\ExtendBI\Kaptain
    1. 1.
      Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
      1. 1.
        Set usePfxCertificate to true
      2. 2.
        Set pfxPassword to the password defined when exporting the Certificates
      ​
      ​
Steps to configure inbound traffic:
  1. 1.
    Open powershell as administrator
  2. 2.
    Run the following command:
New-NetFirewallRule -DisplayName "Kaptain Inbound" -Direction Inbound –LocalPort 8000 -Protocol TCP -Action Allow –Profile Domain
​
Start Kaptain services:
  1. 1.
    Open the Windows Server Manager
  2. 2.
    Start Kaptain DB Service and Start Kaptain Server Service
Check settings:
  1. 1.
    Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
  2. 2.
    Ensure you have the correct settings defined for the certificate related elements:
    1. 1.
      settings => qlikHost:"cert"
    2. 2.
      hosts => cert =>
      1. 1.
        keyFile:"qlik/client_key.pem"
      2. 2.
        caFile:"qlik/root.pem"
      3. 3.
        certFile:"qlik/client.pem"
      ​
      ​
If you want to base the authentication on JWT please contact us at [email protected]

Up to version 2.4.x

Download the file below for instructions on how to install Kaptain on a Windows server.
Kaptain_Installation steps_JUN2021.xlsx
19KB
Binary
Kaptain Installation Instructions June 2021

External DB configurations

If you wish to store data in one of the supported external databases you need to configure the relevant one in the Kaptain configuration.

Configuration Via Kaptain Console

  1. 1.
    Login to Kaptain console and go to the Settings section under the System Management tab.
  2. 2.
    Go to Data Source List section and click Add Data Source
    ​
  3. 3.
    Select the Data Source Type that you want to add (e.g. MySQL) and click OK
  4. 4.
    Fill in the configuration fields according to your setup. (See image below with an example)
    ​
Configuration via Kaptain Configuration file
The system administrator must setup the proper settings for the DBs to be used by Komment. This is done in the Kaptain configuration file that is installed together with Kaptain.
Default location: C:\Program Files\ExtendBI\Kaptain\config\default.json
The configuration file has a section for each DB which must be adjusted to your setup:
"mssql": {
"MSSQL_SERVER": "mssql.extendbi.eu-central-1.rds.amazonaws.com",
"MSSQL_PORT": 1433,
"MSSQL_USER": "admin",
"MSSQL_PASSWORD": "strongpassword",
"MSSQL_DATABASE": "Kaptain",
"DRIVER": "msnodesqlv8",
"OPTIONS": {
"encrypt": true,
"enableArithAbort": true,
"trustedConnection": false
}
},
"oracle": {
"ORACLE_SERVER": "oracledb.extendbi.eu-central-1.rds.amazonaws.com",
"ORACLE_LIB": "C:\\Projects\\instantclient_19_11",
"ORACLE_PORT": 1521,
"ORACLE_USER": "admin",
"ORACLE_PASSWORD": "strongpassword",
"ORACLE_DATABASE": "ORCL"
},
"mysql": {
"MYSQL_POOL": 300,
"MYSQL_SERVER": "mysql.extendbi.eu-central-1.rds.amazonaws.com",
"MYSQL_PORT": 3306,
"MYSQL_USER": "admin",
"MYSQL_PASSWORD": "strongpassword",
"MYSQL_DATABASE": "Kaptain"
},
"postgresql": {
"POSTGRE_USER": "postgres",
"POSTGRE_SERVER": "localhost",
"POSTGRE_DATABASE": "Kaptain",
"POSTGRE_PASSWORD": "strongpassword",
"POSTGRE_PORT": 4432
}

Windows authentication for MS SQL

For the MS SQL database it is possible to use Windows authentication. For it to work make sure that:
DRIVER: "msnodesqlv8" and trustedConnection: true as in the below example.
"mssql": {
"MSSQL_SERVER": "mssql.extendbi.eu-central-1.rds.amazonaws.com",
"MSSQL_PORT": 1433,
"MSSQL_USER": "admin",
"MSSQL_PASSWORD": "strongpassword",
"MSSQL_DATABASE": "Kaptain",
"DRIVER": "msnodesqlv8",
"OPTIONS": {
"encrypt": true,
"enableArithAbort": true,
"trustedConnection": true
}
​
If not already part of your standard MS SQL installation, please ensure that you have Microsoft® SQL Server® 2012 Native Client - QFE installed as well. The official download site can be reached here: https://www.microsoft.com/en-us/download/details.aspx?id=50402​
​

SSL instructions

You might need to install ssl on your server. You can use the below package:
libssl-1_1-x64.zip
5MB
Binary
Open SSL tool

Installation steps:

  1. 1.
    Download the file above and extract it to the server - e.g. c:\install\openssl
  2. 2.
    Paste your PFX file into same folder - e.g cert.pfx
  3. 3.
    Open a CMD as Administrator
  4. 4.
    Go to the folder where you extracted the - e.g. c:\Install\openssl\
  5. 5.
    Execute the following commands: openssl pkcs12 -in server.pfx -out "c:\install\server.pem" -nokeys -password pass:<your pass> openssl pkcs12 -in server.pfx -out "c:\install\server_key.pem" -nocerts -nodes -password pass:<your pass>
  6. 6.
    Paste the files generated in step 5 into kaptain install folder: \config\kaptain\
  7. 7.
    Restart kaptain service
  8. 8.
    Open kaptain admin console in browser and check if there’s still certificate warning
Previous
Welcome
Next - Getting started
Load script
Last modified 1yr ago