Installation
Time to complete: 1 minute
Last updated
Time to complete: 1 minute
Last updated
Import the extension from the Qlik Management Console (QMC)
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
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:
Go to the folder where you have your Komment.zip file.
Open the zip file and navigate to static\config
Copy the file Settings.txt
Navigate out of the zip file and paste the Settings.txt file in the initial folder
Open the Settings.txt file
Change value to "true" and save and close the file
Copy the Settings.txt file
Open the Komment.zip file and navigate to static\config
Paste the Settings.txt file and say OK to replace the existing file
Navigate out of the zip file
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.
If you are on a Standard plan or higher you have access to our Kaptain service.
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:
Authentication: Based on certificates
Files needed: Kaptain-installer-2.6.0.exe
Initial steps:
Log into your Windows server and place the Kaptain-installer.exe in any give folder
Start the installation by double clicking the Kaptain-installer.exe
Choose Full Installation and installation folder and press Next
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
Open the QMC of your Qlik Sense server
Navigate to the Cetificates section
Press 'Add Machine Name' and enter your Kaptain server name (e.g. kaptain.extendbi.com)
Ignore password but Check mark to include secret key
Export file format for certificates as PEM-format
Press 'Export Certificates' button
Go to Windows File explorer and navigate to C:\ProgramData\Qlik\Sense\Repository\Exported Certificates
Copy Client.pem, Client_key.pem, Root.pem and paste into C:\Program Files\ExtendBI\Kaptain\config\Qlik
Go back to QMC and Certificates section
Press 'Add Machine Name' and enter your Qlik Sense server name (e.g. qlik.extendbi.com)
Enter password and Check mark to include secret key
Select Windows format for the file format
Press 'Export Certificates' button
Turn HTTP mode on
Turn PFX certificate on
Upload your .pfx certificate
Set a password
Submit the changes
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:
Authentication: Based on certificates
Files needed: Kaptain-installer-2.5.0.exe
Installation steps:
Initial steps:
Copy Kaptain-installer.exe to the Windows server
Start installation by double click the Kaptain-installer.exe
Choose Full Installation and installation folder and press Next
Navigate to C:\Program Files\ExtendBI\Kaptain
Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
Update the following according to your system:
corsAllowOrigins
userId
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
Open the QMC of your Qlik Sense server
Navigate to the Cetificates section
Press 'Add Machine Name' and enter your Kaptain server name (e.g. kaptain.extendbi.com)
Ignore password but Check mark to include secret key
Export file format for certificates as PEM-format
Press 'Export Certificates' button
Go to Windows File explorer and navigate to C:\ProgramData\Qlik\Sense\Repository\Exported Certificates
Copy Client.pem, Client_key.pem, Root.pem and paste into C:\Program Files\ExtendBI\Kaptain\config\Qlik
Go back to QMC and Certificates section
Press 'Add Machine Name' and enter your Qlik Sense server name (e.g. qlik.extendbi.com)
Enter password and Check mark to include secret key
Select Windows format for the file format
Press 'Export Certificates' button
Copy the exported files to C:\Program Files\ExtendBI\Kaptain\config\kaptain folder
Navigate to C:\Program Files\ExtendBI\Kaptain
Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
Set usePfxCertificate to true
Set pfxPassword to the password defined when exporting the Certificates
Steps to configure inbound traffic:
Open powershell as administrator
Run the following command:
Start Kaptain services:
Open the Windows Server Manager
Start Kaptain DB Service and Start Kaptain Server Service
Check settings:
Open the file C:\Program Files\ExtendBI\Kaptain\config\default.json as Administrator
Ensure you have the correct settings defined for the certificate related elements:
settings => qlikHost:"cert"
hosts => cert =>
keyFile:"qlik/client_key.pem"
caFile:"qlik/root.pem"
certFile:"qlik/client.pem"
If you want to base the authentication on JWT please contact us at info@extendbi.com
Download the file below for instructions on how to install Kaptain on a Windows server.
If you wish to store data in one of the supported external databases you need to configure the relevant one in the Kaptain configuration.
Login to Kaptain console and go to the Settings section under the System Management tab.
Select the Data Source Type that you want to add (e.g. MySQL) and click OK
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:
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.
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
You might need to install ssl on your server. You can use the below package:
Download the file above and extract it to the server - e.g. c:\install\openssl
Paste your PFX file into same folder - e.g cert.pfx
Open a CMD as Administrator
Go to the folder where you extracted the - e.g. c:\Install\openssl\
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>
Paste the files generated in step 5 into kaptain install folder: \config\kaptain\
Restart kaptain service
Open kaptain admin console in browser and check if there’s still certificate warning
Once the installation is completed open Windows Services and start Kaptain DB Service and Kaptain Server Service.
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.
Enter admin as user and the password set in step 5 and press Log in.
Go to the Settings section under the System Management tab.
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.
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)
In the same section upload Qlik exported certificates from QMC (see below for instructions on how to create certificates)
In the Logs section set Log Level as info
Press Submit and Confirm you want to save the changes
You will see a confirmation message and the page will automatically refresh.
Go to Data Source List section and click Add Data Source
Fill in the configuration fields according to your setup. (See image below with an example)
