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

MIMB Bridge Documentation

MIMB Import Bridge from Microsoft Power BI (File) - New Beta Bridge

Bridge Specifications

Vendor Microsoft
Tool Name Power BI
Tool Version 2.x
Tool Web Site https://powerbi.microsoft.com/
Supported Methodology [Business Intelligence] Data Store (Physical Data Model, OLAP Dimensional Model), BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure) via PBIX File

SPECIFICATIONS
Tool: Microsoft / Power BI version 2.x via PBIX File
See https://powerbi.microsoft.com/
Metadata: [Business Intelligence] Data Store (Physical Data Model, OLAP Dimensional Model), BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Expression Parsing, Report Structure)
Component: MicrosoftPowerBIFile version 11.0.0

OVERVIEW
This bridge imports Business Intelligence (BI) reporting metadata from Microsoft Power BI file in PBIX or PBIT format.
PowerBI Desktop stores reports natively in PBIX format, and can convert them to PBIT Template format.

REQUIREMENTS
n/a

FREQUENTLY ASKED QUESTIONS
n/a

LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
The PBIX file format currently has no public SDK or API to allow inspecting the structure of the report, the tables it contains, and detailed lineage to sources.
The PBIX file format usually does not expose the report Tabular Object Model (TOM) metadata definition.
Recent versions do not expose metadata in readable format, and contain mostly binary data.
As a result, the bridge cannot import some of the report metadata (e.g. calculated tables, columns, measures expressed in DAX language).

The PBIT file format usually contains the report Tabular Object Model (TOM) metadata definition, leading to more complete report lineage.
The PBIT file format may not contain the report Tabular Object Model (TOM) metadata definition when AnalysisServices is used as a source.
Each Table Query in PowerQuery M language is written slightly differently in PBIT format than how they appear in the PowerBI Desktop tool.
There is no public API to convert PBIX files into PBIT template format automatically.

When parsing the Tabular Object Model (TOM), the bridge relies on a PowerQuery M language parser to understand the lineage of each Table Query.
Some concepts in the PowerQuery language may not be well supported:
- not all functions are supported (data access functions, data manipulation functions)
- complex queries that rely on sub-queries, parameters, or custom/lambda functions
- queries that rely on third party scripts (R, Python languages)

The source metadata does not contain sufficient information about connections to allow stitching to AnalysisServices cubes.

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
File Select the PowerBI file to import. FILE
*.pbix
*.pbit
  Mandatory
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
-java.memory <Java Memory's maximum size> (previously -m)

1G by default on 64bits JRE or as set in conf/conf.properties, e.g.
-java.memory 8G
-java.memory 8000M

-java.parameters <Java Runtime Environment command line options> (previously -j)

This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g.
-java.parameters -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.
-java.parameters -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

-java.executable <Java Runtime Environment full path name> (previously -jre)

It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g.
-java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe"

-environment.variable <name>=<value> (previously -v)

None by default, e.g.
-environment.variable 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

-connection.casesensitive ConnectionName

Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g.
-connection.casesensitive "My Database"

MICROSOFT POWER BI OPTIONS
-c <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 semi-column separated value pairs: <Connection name>=<Database type>, e.g.
-c Connection1=ORACLE;Connection2=TERADATA;
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

-columns.notpropagated

Do not propagate the columns discovered while parsing PowerQuery M script steps back to the source tables/files.
STRING      

 

Bridge Mapping

Mapping information is not available

Last updated on Mon, 12 Apr 2021 17:37:38

Copyright © Meta Integration Technology, Inc. 1997-2021 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.