Komment allows for three different methods to be used when saving data.
Utilizes the built-in QIX Engine API for processing the writing mechanism. Partial reload is performed by the Qlik Sense user.
Kaptain is an added service that you can purchase to enhance the functionality of Komment. There are several reasons as to why Kaptain might be relevant for you:
Just contact us if you would like to add Kaptain to your Qlik Sense writeback solution.
Security rule setup needed
Each user must have ‘CommentingRole’ assigned
Supporting Analyzer License users
Extra node.js service to be installed
Partial reload needed when saving data
The setup is made in the Data Connection Settings section. The default is QIX Engine so if you don't have a plan (Standard, Pro or Premium) where Kaptain Service is included you don't have to touch this section.
Select your Connection Type
Input the URL to Kaptain service
If you have multiple environments (devl, test, prod, etc.) you can ease the setup by defining a variable that holds the URL
Then you just reference this variable in the URL field:
Test Service to ensure Komment and Kaptain service are connected
To setup your Komment object to work with Kaptain there are only a few steps needed. You find the Kaptain Settings Under Data Connection Settings:
Here you select the source Kaptain should use when loading the saved data back into Komment:
Kaptain DB (Kapsule): This will load data directly from Kaptain's MongoDB database (recommended).
QVD: If you have defined a QVD transport you can choose to load data from here.
Here you choose which 'user' that will handle the data reload:
Kaptain: This will use the QS Service account to perform reload (recommended).
Komment: This will use the logged-in user account to perform reload.
Here you define where in Kaptain's MongoDB you want to save the data entered by the users when using Komment. A Kapsule corresponds to a collection in MongoDB. You can think of it as a table in a SQL database.
If you have already created a Kapsule you can select from the list
If not, then
Select <Create New ...>
Enter a name
Refresh your browser window and select the newly created Kapsule in the list
Use variable to select Kapsule dynamically:
To be able to easily moved applications with Komment between different Qlik servers and Kaptain installations you can define the Kapsule dynamically using a variable. Here is how.
After you have selected your Kapsule as described above, you do the following:
Copy the Kapsule ID shown below the Kapsule you have selected
Create a new variable using Qlik's variable editor (or define in script) and insert the copied value in the variable value
In Kaptain settings switch on
Input the the name of the newly created variable
Here you can create a Qlik Sense Data Connection that will ensure you can load data from Kaptain. You just choose a name and a REST connection to Kaptain will automatically be established.
If a REST data connection to Kaptain is already created you can select this
If not, then
Write desired name of connection in pop-up window
OK (browser window will automatically refresh)
Select the newly created data connection from the list
A final step is to decide on what the scope of the data you load from Kaptain and into your Qlik Sense app on each reload (partial and full). By default only the latest records for each Komment Key field will be loaded so to get the full audit trail loaded each time toggle on the
Load Full History :
if you add new widgets or remove existing widgets in your Komment setup you need to press
Sync Kapsule to enforce the changes to be reflected in the MongoDB Kapsule.
6. Known limitations
The field names used in the Komment widgets cannot contain the following characters:
Kapsule names should begin with an underscore or a letter character, and cannot:
be an empty string (e.g.
contain the null character.
begin with the
You can learn more here: https://docs.mongodb.com/manual/reference/limits/
When using Kaptain as a data connection you have a few more option in relation to the Date widget. The below settings will only affect how the dates entered in the date widget is stored in MongoDB and how they are represented in Komment.
By enabling Custom Date Format you get the possibility to set your own Date Format. Note that it is case sensitive.
If you have users in many different time zones you can also tick Ignore Timezone to ensure that the selected date will be displayed exactly the same to all users.