Prepare a SSRS and PBRS <source ID> configuration file

The lineage harvester uses the lineage harvester configuration file to collect the SQL Server Reporting Services (SSRS) and Power BI Report Server (PBRS) data objects and send them to the Collibra Data Lineage service.

The <source ID> configuration file allows you to:

  • If useCollibraSystemName in the lineage harvester configuration file is set to true, use the collibraSystemName property to specify the system name of databases in SSRS and PBRS.
  • Provide additional information about databases in SSRS and PBRS, which is necessary if the databases do not contain all information to process the SQL source code correctly.
Example 

Copy code

{
	"DataSources": {
		"Redshift": {
			"dbname": "redshift-database-name",
			"schema": "redshift-schema-name",
			"dialect": "redshift",
			"collibraSystemName": "redshift-system-name"
		},
		"Oracle": {
			"dbname": "oracle-database-name",
			"schema": "oracle-schema-name",
			"dialect": "oracle",
			"collibraSystemName": "oracle-system-name"
		}
	},
	"CustomDataSources": {
		"/path to report/custom data souce name": {
			"dbname": "mssql-database-name",
			"dialect": "mssql"
		}
	}
}

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

Steps

  1. Create a new JSON file in the lineage harvester config folder.
  2. Give the JSON file the same name as the value of the Id property in the lineage harvester configuration file.
    Example The value of the Id property in the lineage harvester configuration file is ssrs-source-1. As a result, the name of your JSON file should be ssrs-source-1.conf.

    Important Your JSON file must have the file extension .conf.

  3. For each database in SSRS and PBRS, add the following content to the JSON file:

    Property

    		Description

    Required?

    DataSources

    This section contains all connections for which you want to create a technical lineage.

    The DataSources section refers to shared data sources in SSRS and PBRS. For more information about shared data sources, see the Microsoft documentation.

    Yes

    <data source type>

    The path of a connection object in SSRS and PBRS.

    Yes

    dbname
    		The name of the database of a supported data source in SSRS and PBRS.

    No

    schema

    The name of the default schema of a supported data source in SSRS and PBRS.

    No

    dialect

    The dialect of the supported data source in SSRS and PBRS.

    No

    collibraSystemName

    The system or server name of the database.

    Let's assume you have two databases named Customers. When you prepare the physical data layer in Data Catalog, you create a System asset for each of these databases. Let's say you named them Customers-Europe and Customers-USA. You can then configure this property as follows.

    "Redshift": {
	"dbname": "Customer",
	"schema": "redshift-schema-name",
	"dialect": "redshift",
	"collibraSystemName": "Customers-Europe"
},
"Oracle": {
	"dbname": "Customer",
	"schema": "oracle-schema-name",
	"dialect": "oracle",
	"collibraSystemName": "Customers-USA"
}

    Yes

    CustomDataSources

    You can use custom data processing extensions that are used to support embedded data sources of which the data source definition is specified locally in a report or embedded data set.

    The CustomDataSources section refers to embedded data sources in SSRS and PBRS. For more information about embedded data sources, see the Microsoft documentation.

    No

    <path to report>/<custom data source name>

    The full path to the report and the custom data source name.

    You can use wildcards to match multiple folders, reports or data sets. The connection information is this section is used to add missing information or to overwrite parsed information.

    No

    dbname
    		The name of the database of a custom data source in SSRS and PBRS..

    No

    schema

    The name of the schema of a custom data source in power. If you don't provide the schema name, the default schema is used.

    No

    dialect

    The dialect of the custom data source in SSRS and PBRS..

    • azure, for an Azure SQL Server data source.
    • bigquery, for a Google BigQuery data source.
    • db2, for an IBM DB2 data source.
    • hana, for a SAP Hana data source.
    • hive, for a HiveQL data source.
    • greenplum, for a Greenplum data source.
    • mssql, for a Microsoft SQL Server data source.
    • mysql, for a MySQL data source.
    • netezza, for a Netezza data source.
    • oracle, for an Oracle data source.
    • postgres, for a PostgreSQL data source.
    • redshift, for an Amazon Redshift data source.
    • snowflake, for a Snowflake data source.
    • spark, for a Spark SQL data source.
    • sybase, for a Sybase data source.
    • teradata, for a Teradata data source.

    No

  4. Save the <source ID> configuration file.