QlikSense Server - Import - Cloud

Talend Cloud Data Catalog Bridges

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
EnrichPlatform
Talend Data Catalog

Note: This bridge is not available in Talend Cloud Data Catalog by default. You need to set up a remote harvesting agent to import metadata from this source. For more information, see Deploying a remote harvesting agent in Talend Cloud Data Catalog Administration guide.

Bridge Requirements

This bridge:
  • requires the tool to be installed to access its SDK.

  • requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.

Bridge Specifications

Vendor QlikTech
Tool Name QlikSense
Tool Version 3.2
Tool Web Site http://www.qlik.com/us/products/qlik-sense
Supported Methodology [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via WebSocket API on QVF or QVD File
Data Profiling
Remote Repository Browsing for Model Selection
Incremental Harvesting
Multi-Model Harvesting

SPECIFICATIONS
Tool: QlikTech / QlikSense version 3.2 via WebSocket API on QVF or QVD File
See http://www.qlik.com/us/products/qlik-sense
Metadata: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure)
Component: QlikSenseServer version 11.0.0

DISCLAIMER
This bridge requires internet access to https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites)
in order to download the necessary third party software libraries into $HOME/data/download/MIMB/
- If https fails, the bridge then tries with http.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -j option in the Miscellaneous parameter).
- If the bridge does not have access to internet, that directory can be copied from another 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.

OVERVIEW
This bridge imports Business Intelligence (BI) reporting metadata from multiple Qlik Sense applications (QVF apps) in a Qlik Sense server.

REQUIREMENTS
This bridge requires access the Qlik Engine API (JSON over WebSocket).

FREQUENTLY ASKED QUESTIONS
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.

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html

SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)


Bridge Parameters

Parameter Name Description Type Values Default Scope
Server URL The Qlik Sense URL server URL required for the connection to the Qlik Sense Engine API.

In order to use the Qlik Engine API, you need to open a WebSocket to the engine using one of the following URIs:
wss://server.domain.com:4747/app/
or wss://server.domain.com[/virtual proxy]/app/
STRING   wss://localhost:4747/app/ Mandatory
Server user directory The Qlik Sense user directory required for connection to the Qlik Sense server.

See the "Users" page of the Qlik Management Console, e.g.
htttps://server.domain.com/qmc
STRING   Internal Mandatory
User name The Qlik Sense user required for authentication to the Qlik Sense server

See the "Users" page of the Qlik Management Console, e.g.
https://server.domain.com/qmc
STRING     Mandatory
User certificate The client certificate required for authentication to the Qlik Sense server, e.g.
client.pfx

The client certificate can be exported from the Qlik Management Console
https://server.domain.com/qmc
using the following 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. E.g. MYMACHINE.mydomain.com or the IP address.
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.
6. 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. Under 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
User certificate password The password for client certificate. PASSWORD      
Applications The Qlik Sense Application (QVF app) names.

If left empty, all applications are imported.
REPOSITORY_SUBSET      
Server log folder The network shared location of Qlik Sense Server's archive log folder.
The archive log folder location is defined during the Qlik Sense Enterprise, e.g.
\\server\share\ArchivedLogs\computerName\Script.

This bridge requires the QlikView document execution log, because some (or all) metadata details cannot be extracted from the source script due to their dynamic aspect (e.g. use of loops, subroutines, variable definitions).
Note that the Miscellaneous parameter offers an option -log.notavailable (although not recommended).
DIRECTORY      
Server data folder The network shared location of Qlik Sense Server's Qlik View Data (QVD) folder. DIRECTORY      
Incremental import Incremental import only extracts what has changed since the last import. The initial full metadata harvesting (model import) of a very large source system can take a long time. However the extracted metadata are organized as a multi-model, where each model is a unit of change (e.g. Schema of a RDBMS server, or report of BI server). Subsequent model imports are dramatically faster than the initial import as this bridge will automatically try to detect changes in the source system, in order to only process the modified, added or deleted models and reuse all unchanged metadata from the model cache. Note however that the detection of change is more or less efficient depending on the sources system: e.g. BI servers can quickly provide the list of new, modified or deleted reports, but not all data stores offer a schema level change detection.

'True'
Import only the changes made since the last import

'False'
import all metadata. This option is required after upgrading the bridge in particular to take full advantage of any additional metadata coverage.

For debugging purpose, the option -cache.clear of the Miscellaneous parameter can be used to clear one model from the cache which is located (by default) in: $HOME/data/MIMB/cache/<BridgeId>/<ModelId>
BOOLEAN
False
True
True  
Miscellaneous INTRODUCTION
Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g.
-connection.cast MyDatabase1="SQL Server"
Some options can be used multiple times if applicable, e.g.
-connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2;
As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g.
ETL/Miscellaneous.txt

JAVA ENVIRONMENT OPTIONS
-m <Java Memory's maximum size>
1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-m 8G
-m 8000M

-j <Java Runtime Environment command line options>
This option must be the last one in the Miscellaneous parameter as all the text after -j is passed "as is" to the JRE, e.g.
-j -Dname=value -Xms1G
The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries.
-j -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass

-jre <Java Runtime Environment full path name>
It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-jre "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-v <Environment variable value>
None by default, e.g.
-v var1=value1 -v var2="value2 with spaces"

MODEL IMPORT OPTIONS
-model.name <model name>
Override the model name, e.g.
-model.name "My Model Name"

-prescript <script name>
The script must be located in the bin directory, and have .bat or .sh extension.
The script path must not include any parent directory symbol (..).
The script should return exit code 0 to indicate success, or another value to indicate failure.
For example:
-prescript "script.bat arg1 arg2"

-cache.clear
Clears the cache before the import, and therefore will run a full import without incremental harvesting.
Warning: this is a system option managed by the application calling the bridge and should not be set by users.

-backup <directory>
Full path of an empty directory to save the metadata input files for further troubleshooting.

DATA CONNECTION OPTIONS
Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs.

-connection.cast ConnectionName=ConnectionType
Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g.
-connection.cast "My Database"="SQL SERVER".
The list of supported data store connection types includes:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

-connection.rename OldConnection=NewConnection
Renames an existing connection to a new name, e.g.
-connection.rename OldConnectionName=NewConnectionName
Multiple existing database connections can be renamed and merged into one new database connection, e.g.
-connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase

-connection.split oldConnection.Schema1=newConnection
Splits a database connection into one or multiple database connections.
A single database connection can be split into one connection per schema, e.g.
-connection.split MyDatabase
All database connections can be split into one connection per schema, e.g.
-connection.split *
A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g.
-connection.split MyDatabase.schema1=MySchema1

-connection.map DestinationPath=SourcePath
Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file).
On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g.
-connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder
On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g.
-connection.map /users/John=/data -connection.map /users/paul=/data
On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g.
-connection.map M:\=C:\data -connection.map N:\=C:\data

-pppd
Create the connections and connection data sets in DI/ETL design models. This feature should only be used when intending to export to another DI/ETL tool.

-database.type <list of connection database types>
If databases are accessed via generic ODBC connections, then it is critical to know the exact database type in order to properly parse that database specific SQL syntax for lineage.
The list of connection database types must be specified as a comma separated value pairs: <Connection name>=<Database type>
The supported database types for SQL parsing is:
ACCESS
CASSANDRA
DB2
DENODO
HIVE
MYSQL
NETEZZA
ORACLE
POSTGRESQL
PRESTO
REDSHIFT
SALESFORCE
SAP HANA
SNOWFLAKE
SQL SERVER
SYBASE
TERADATA
VECTORWISE
VERTICA

Specify the default database connection without any connection name, e.g.
-database.type ORACLE

If multiple database connections are used, then specify each database type using the associated connection name, e.g.
-database.type MyConnectionName=ORACLE

It is possible to mix the default database type with multiple connection database types, e.g.
-database.type ORACLE , MyConnectionName1=TERADATA , MyConnectionName1=DB2

-directory <statement>
A Qlik document DIRECTORY statement is used to set the Directory path for subsequent LOAD statements.

If this directory is inaccessible, then use a DIRECTORY statement to redirect it to another directory. To do so, copy the DIRECTORY statement from a Qlik document execution log, add '=' and specify the path to another directory. In the following case, folder 'c:\folder' is redirected to 'd:\folder2' folder., e.g.
-directory [c:\folder1]=[d:\folder2]

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

-file.path <file directory>
A Qlik document may have statements such as Include, Store, Load statements which operate with file path. If the original file path is not accessible by this bridge, then it logs the following errors:
- "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.

If the necessary files are located in "\\inaccessible\folder", then copy them to C:\accessible\folder and instruct the bridge to read them from the new location, e.g.
-file.path [\\inaccessible]=[c:\accessible]

The file.path option allows you to replace a portion of the original file path with a new one by specifying multiple file.path options, e.g.
-file.path [\\inaccessible]=[c:\accessible], [\\inaccessible2]=[c:\accessible2]

The bridge applies multiple -file.path options in order provided.
-file.path [\\a]=[c:\a], [\\aa]=[c:\aa] - The wrong way
-file.path [\\aa]=[c:\aa], [\\a]=[c:\a] - The right way

Make sure not to specify the file.path to be outside of the Directory path where you have the QlikSense documents you would like to import.

-log.notavailable
The Qlik document execution log is required because some critical metadata (e.g. exact source data store tables for lineage) cannot be directly extracted from the Qlik scripts due to their dynamic aspect (e.g. use of loops, subroutines, variable definitions).
This options allows to import even if the execution log is not available, in such case some critical metadata for lineage may be missing.
STRING      

 

Bridge Mapping

Mapping information is not available