Prepare Power BI <source ID> configuration file (deprecated)

The Power BI harvester uses a Power BI configuration file to collect the Power BI data objects. It then sends the metadata to the Collibra Data Lineage server. However, if the useCollibraSystemName in the Power BI configuration file is set to true, you also have to provide a specific <source ID> configuration file that defines the system name of databases in Power BI.

Collibra Data Lineage uses the system names to match the structure of databases in Power BI to assets in Data Catalog.

Tip The name "<source ID>" refers to the value of the sourceId property in the Power BI configuration file.

Prerequisites

Note This is not a prerequisite if you are using a <source ID> configuration file for the purpose of providing the true system names of the ODBC databases in Power BI. In that case, you can set the useCollibraSystemName property in the Power BI harvester configuration file to true, but it is not mandatory.

Steps

  1. Create a new JSON file in the Power BI harvester config folder.
  2. Give the JSON file the same name as the value of the sourceId property in the Power BI configuration file.
    Example The value of the sourceId property in the Power BI configuration file is power-bi-source-1. Therefore, the name of your JSON file should be power-bi-source-1.conf.
  3. For each database in Power BI, add the following content to the JSON file:

    Property

    		Description

    Mandatory?

    found_dbname=<database name>;found_hostname=<server name>

    The database information of supported data sources in Power BI that is typically collected by the Power BI harvester. It describes on which server the database is running (found_hostname) and what the name of the database is (found_dbname).

    Tip 

    You can use wildcards to capture multiple connection string combinations:

    PatternDescription
    *Matches everything.
    ?Matches any single character.
    [seq]Matches any character in "seq".
    [!seq]Matches any character not in "seq".

    Yes

    dbname
    		The name of the database of a supported data source in Power BI.

    No

    schema

    The name of the default schema of a supported data source in Power BI.

    If the Power BI harvester fails to find a specific schema, it uses the default schema.

    No

    dialect

    The dialect of the supported data source in Power BI.

    • azure, for an Azure SQL Server data source.
    • bigquery, for a Google BigQuery data source.
    • mssql, for a Microsoft SQL Server data source.
    • oracle, for an Oracle data source.
    • redshift, for an Amazon Redshift data source.
    • snowflake, for a Snowflake data source.
    • sybase, for a Sybase data source.

    No

    collibraSystemName

    The system or server name of a database.

    Warning The value of this property must exactly match the name of your System asset in Collibra.

    Important If you are using a <source> configuration file for the purpose of providing the true system name of an ODBC database in Power BI, you are not required to:
    • Set the useCollibraSystemName property in the Power BI configuration file to true.
    • Specify a Collibra system name in the <source ID> configuration file.
    However, if the useCollibraSystemName property is set to true in the Power BI configuration file, then you must specify a Collibra system name in the <source ID> configuration file.

    Yes

    (unless you are using a <source ID> file to provide the true system names of ODBC databases in Power BI.)

    Copy code

    {
	"found_dbname=databasename1;found_hostname=*": {
		"dbname": "mssql-database-name",
		"schema": "mssql-schema-name",
		"dialect": "mssql",
		"collibraSystemName": "mssql-system-name"
	},
	"found_dbname=databasename2;found_hostname=server-name.onmicrosoft.com": {
		"dbname": "oracle-database-name",
		"schema": "oracle-schema-name",
		"dialect": "oracle",
		"collibraSystemName": "oracle-system-name"
	}
}

    Tip Click Copy code to copy the example to your clipboard.

  4. Save the <source ID> configuration file.