QlikView - Import - Cloud

Talend Cloud Data Catalog Bridges

Talend Documentation Team
Talend Cloud
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.

  • is only supported on Microsoft Windows.

Bridge Specifications

Vendor QlikTech
Tool Name QlikView
Tool Version 11.2 to 12.x
Tool Web Site http://www.qlik.com/us/products/qlikview
Supported Methodology [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure) via COM API on QVW or QVD File
Data Profiling
Remote Repository Browsing for Model Selection
Incremental Harvesting
Multi-Model Harvesting

Tool: QlikTech / QlikView version 11.2 to 12.x via COM API on QVW or QVD File
See http://www.qlik.com/us/products/qlikview
Metadata: [Business Intelligence] Multi-Model, BI Report (Relational Source, Expression Parsing, Report Structure)
Component: QlikViewFiles version 11.0.0

This bridge imports Business Intelligence (BI) reporting metadata from a directory (and subdirectories) of QlikView files including:
- QlikView Working (QVW) documents
- QlikView Data (QVD) files
- QlikView execution log files associated to each QVW documents
- QlikView external script files referenced by QVW documents

- QlikView software installed:
This bridge requires the QlikView software and its COM/OLE API to be installed on the machine that is executing this bridge.

- QlikView software not running:
As connectivity to the API is through COM based automation, please be sure to close all QlikView instances and check the Task Manager to confirm there are no QlikView processes running, as these may interfere with the startup of this bridge.

- QlikView execution log available:
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).

Q: What do I do if this bridge appears to stop processing for a long time with no log messages after 'Connected to QlikView version xx.xx.xxxxx.x'?
A: Pop-up dialog issue: As connectivity to the API is through COM based automation, the import may be blocked because a dialog message may have been issued by QlikView and it is awaiting a response. In order to address this issue, you must look for windows in the background that would be the dialog requiring user attention. In some cases, e.g., if this bridge is executed as a service rather than directly as an application, in order to ensure that you see this message, you will need to re-run this bridge as a full application rather than a service.

Q: How to create the execution log files used by this bridge?
A: The execution log files are generated by QlikView when a QVW document script is executed. Enable generation of the log files in QlikView menu Settings / Document Properties / General / Generate Logfile. Then, execute the QVW document script.

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

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

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)

Q: How do I provide information to help the support team reproduce an issue?
A: Provide an archive of the files involved (QVW, QVD, execution logs, external scripts). If you wish to remove confidential data from these files, please request a script to do so.

Bridge Parameters

Parameter Name Description Type Values Default Scope
Directory The directory (including sub directories) of QlikView documents, log files and external script files involved in the QlikView project.

Ideally, the parameter should point to the production location of the project. When it is not possible to access the production location directly, you can copy the production directory to a different location and point the parameter to it. In this case, when the project uses QlikView DIRECTORY statements you need to redirect the statements to the new location. Consult the Miscellaneous parameter documentation for additional information.
DIRECTORY     Mandatory
User ID The User ID specified in Section Access to protect any QlikView documents. This User ID has to have access to all documents in the Directory. Otherwise this bridge will hang because of Qlikview pop-up window which will wait for correct User ID. STRING      
Password The Password for the User ID in Section Access to protect any QlikView documents. PASSWORD      
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.

Import only the changes made since the last import

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>
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.

-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= -Dhttp.proxyPort=3128 -Dhttps.proxyHost= -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.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"

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 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:

-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

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:

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.

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.


Bridge Mapping

Meta Integration Repository (MIR)
(based on the OMG CWM standard)
QlikView (Application)
Mapping Comments
DirectoryStructureModel Application  
CreationTime Creation Time  
Description Description  
ImportDate Import Date  
Name Name  
NativeId Native Id  
NativeType Native Type  
Folder Folder  
Author Author  
CreationTime Creation Time  
Description Description  
LastModificationTime Last Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
NativeType Native Type  
StoreContent QVW, Connection, QVD  
Author Author  
CreationTime Creation Time  
Description Description  
LastModificationTime Last Modification Time  
Modifier Modifier  
Name Name  
NativeId Native Id  
NativeType Native Type