Meta Integration® Model Bridge (MIMB)
"Metadata Integration" Solution

MIMB Bridge Documentation

MIMB Import Bridge from QlikSense Server

Bridge Specifications

Vendor QlikTech
Tool Name QlikSense
Tool Version 3.2
Tool Web Site
Supported Methodology [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via WebSocket API on QVF or QVD File

Import tool: QlikTech QlikSense 3.2 (
Import interface: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via WebSocket API on QVF or QVD File from QlikSense Server
Import bridge: 'QlikSenseServer' 11.0.0

This bridge requires internet access to (and exceptionally a few other tool sites)
in order to download the necessary third party software libraries into $HOME/data/download/MIMB/
(such directory can be copied from another MIMB server with internet access).
By running this bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third party software libraries.

This bridge imports reporting metadata (QVF applications) from the Qlik Sense server using the Qlik Engine API (JSON over WebSocket).


Q: When do I need to generate execution log files?
A: Reports use data load scripts. The execution log files contain information that help the bridge understand the scripts' expressions. Whenever the script contains variables, loops, or dynamic script statements, execution log files may be useful.

Q: How do I provide information to help the support team reproduce an issue?
A: Provide an archive of the files involved (QVF, QVD, execution logs, external scripts).

Q: How do I avoid the error: Handshake response not received
A: Make sure the hots name used to generate the Certificate is the same as the one used in the URL parameter.

Bridge Parameters

Parameter Name Description Type Values Default Scope
Engine API URL URL of the Qlik Engine API.
To use the Qlik Engine API, you need to open a WebSocket to the engine using one of the following URIs:
wss:// or wss://[/virtual proxy]/app/
STRING   wss://localhost:4747/app/ Mandatory
User To authenticate with Qlik Sense server you have to specify user name.
You can see user name on page Users of Qlik Management Console (
STRING     Mandatory
User directory To authenticate with Qlik Sense server you have to specify user directory.
You can see user directory on page Users of Qlik Management Console (
STRING   Internal Mandatory
Certificate Path to the client certificate file (e.g. client.pfx). The client certificate is required for authenticating with the Qlik Sense server.
You can export it using the Qlik Management Console (
To export the certificate please follow these steps:
1. Select Certificates on the QMC start page or from the menu.
The Export page for Certificates is displayed.
2. In the Machine name box, type the full computer name of the computer that you are creating the certificates for: or the IP address. Note that host name must match the one used in the URL parameter
3. Using a password is optional.
4. Export file format for certificates has to be 'Windows format'.
5. Click Export certificates in the action bar.
The export of certificates is initiated and Exporting certificates is displayed.
When the export is finished, the dialog Certificates exported is displayed.
Certificates will be exported to this disk location displays the target directory where
one folder for each computer is added. In every folder the following certificates are created:
client.pfx, root.cer, server.pfx. If the export fails, the dialog displays Certificates export could not complete.
FILE *.pfx   Mandatory
Certificate Password Password for client certificate. PASSWORD      
Applications Specify applications ids you want ot import.
Left empty if you want to import all applications
Log Folder Path to Qlik Sense script log folder.
The script log files contain information that help the bridge understand the script expressions.
Whenever the script contains variables, loops, or dynamic script statements, execution log files may be useful.
This folder is located on Qlik Sense Server in Archive logs folder
and specified during installation of Qlik Sense Enterprise and has to be network folder.
For example \\server\share\ArchivedLogs\computerName\Script.
If you believe the script execution logs are not required, you may specify '-RequireLog no' in the Miscellaneous parameter.
Qvd Folder Path to qvd folder. DIRECTORY      
Incremental import Specifies whether to import only the changes made in the source or to re-import everything (as specified in other parameters).

True - import only the changes made in the source.
False - import everything (as specified in other parameters).

An internal cache is maintained for each metadata source, which contains previously imported models. If this is the first import or if the internal cache has been deleted or corrupted, the bridge will behave as if this parameter is set to 'False'.
Miscellaneous Specify the following miscellaneous options:
- ODBC connection database type
- Replace DIRECTORY statement
- Require script log

ODBC connection database type
When Qlik Sense connects to a database using ODBC the database type is unknown. It is necessary to understand lineage through database specific SQL syntax.
Specify default database type using DatabaseType string (e.g. '-DatabaseType []=Oracle'). When the Qlik Sense application connects to different database types, you may specify each type using the associated connection name (e.g. for 'ODBC CONNECT TO ConnectionName' use 'ConnectionName=Oracle'). It is possible to mix the default database type with connection database types (e.g. '-DatabaseType []=Oracle, ConnectionName= TERADATA').

Here is a list of major supported database type:

DIRECTORY statement
A Qlik Sense DIRECTORY statement is used to set the Directory path for subsequent LOAD statements. When this directory is inaccessible use a DIRECTORY statement to redirect it to another directory.
To do so, copy the DIRECTORY statement from a script log file, add '=' and specify the path to another directory.
-DIRECTORY [c:\folder1]=[d:\folder2]
In this case, folder 'c:\folder' is redirected to 'd:\folder2' folder.

When the path after the DIRECTORY statement is empty, all DIRECTORY statements are redirected to the specified directory.
-DIRECTORY []=[d:\folder2]

Script log
The script execution logs are employed to understand what tables applications use and to determine the lineage to their sources (e.g. QVD or database). When the log is not available an error message is logged. If the script execution log is not required, one may specify '-RequireLog no'.
Note: when a log file is missing, its original script is used. In this case, some or all metadata details could be lost as scripts are dynamic because of loops, subroutines, variable definitions.

For example, the following will set the default database type to Oracle, asks to not require logs and redirects all DIRECTORY statements:
'-DatabaseType []=Oracle -RequireLog no -DIRECTORY []=[d:\folder2]'

Qlik Sense's Include, Store, Load statements operate with file path. When the original file path is not accessible by the bridge it logs errors, like:
'Unable to open Include file: '\\inaccessible\scripts\include.txt''
'Could not process the dependency because the source document '\\inaccessible\QVDs\file.qvd' is not accessible'

You can resolve the errors by copying inaccessible files to accessible paths.
For example, when necessary files are located in \\inaccessible\folder you can copy them to c:\accessible\folder and instruct the bridge to read them from the new location with:
-FILEPATH [\\inaccessible]=[c:\accessible]

The FILEPATH option allows you to replace a portion of the original file path with a new one.

You can specify multiple FILEPATH options, like:
-FILEPATH [\\inaccessible]=[c:\accessible], [\\inaccessible2]=[c:\accessible2]

The bridge applies multiple FILEPATH options in order provided.
WRONG - -FILEPATH [\\a]=[c:\a], [\\aa]=[c:\aa]
RIGHT - -FILEPATH [\\aa]=[c:\aa], [\\a]=[c:\a]

Be sure not to specify the FILEPATH be outside of the Directory path where you have the Qlik Sense documents you would like to import.

Bridge still supports old comma separated format for miscellaneous options.

-m the maximum Java memory size whole number (e.g. -m 4G or -m 2500M ).


Bridge Mapping

Mapping information is not available

Last updated on Tue, 23 Jun 2020 18:16:25

Copyright © Meta Integration Technology, Inc. 1997-2020 All Rights Reserved.

Meta Integration® is a registered trademark of Meta Integration Technology, Inc.
All other trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.