Add the SSRS-PBRS technical lineage capability

After you have created a connection to SQL Server Reporting Services or Power BI Report Server in your Edge or Collibra Cloud site, you have to add the SSRS-PBRS technical lineage capability to the connection.

Required permissions

You have a global role with the Product Rights > System administration global permission.
You have a global role that has the Manage connections and capabilities global permission, for example, Edge integration engineer.

Steps

Open a site.
1. On the main toolbar, click → Settings.
  The Settings page opens.
2. In the tab pane, click Edge.
  The Sites tab opens and shows a table with an overview of your sites.
3. In the table, click the name of the site whose status is Healthy.
  The site page opens.
In the Capabilities section, click Add capability.
The Add capability page appears.
Select the Technical Lineage for SSRS/PBRS capability template.

Enter the required information.

Field Description Required

Name

The name of the capability.

Yes

Description

The description of the capability.

Source ID

The name of the data source. The name must be unique and cannot contain special characters, for example, /.

Warning

You can only specify one source ID per SQL Server Reporting Service (SSRS) or Power BI Report Server (PBRS). Ingesting the same SQL Server Reporting Service (SSRS) or Power BI Report Server (PBRS) under different source IDs will fail.
Any single SSRS or PBRS can be ingested only once. If you create more than one connection for the same SSRS or PBRS, integration will fail. If you want to ingest from multiple unique SSRS or PBRS, you have to create a new Edge connection for each one, configure a new capability template for each one, and each must have a unique source ID.

Warning If you are switching between the lineage harvester and Edge, the value in this field must exactly match the value of the id property in your lineage harvester configuration file.

We highly recommend that you specify only one source ID per SSRS or PBRS service account.

Yes

TechLin Admin Connection (in preview)

If you want to use the OAuth authentication type to connect to the Collibra Data Lineage service instances, you have to create a Technical Lineage Admin Edge or Collibra Cloud site connection and select the OAuth authentication type. Then, in this field, you specify the name of the Technical Lineage Admin Edge or Collibra Cloud site connection.

SSRS/PBRS connection

The Microsoft SSRS/PBRS connection that you created for ingestion in Data Catalog.

Tip Select the name that you provided in the Name field when you created a connection to SSRS-PBRS.

Yes

Domain ID

The unique reference ID of the domain in Collibra Platform in which you want to ingest the SSRS assets.

Yes

Folder Filter

This field allows you to include only specific folders that contain reports or KPIs in the ingestion process.

Important This field is mandatory. If you want to ingest all folders, enter *.

You can filter on multiple folders by:

Specifying folder names.
Specifying the full path to folders.
Using a wildcard.
Using a combination of these approaches. For example: folder1, /database/folder2, /folder3/*

Show me some examples

Scenario	Configuration
Ingest all folders with the name Folder3, anywhere in the folder hierarchy.	`Folder3` Note Reports in child folders of Folder3 are not included in the ingestion. As such: Reports in `/Folder1/Folder2/Folder3` are included in the ingestion. Reports in `/Folder3/ChildFolder` are not included in the ingestion.
Ingest Folder1 and Folder2.	`Folder1, Folder2`
Ingest two folders that are both named Folder1.	In this case, specify the full paths to the folders, for example: `/Database1/Folder1, /Database2/Database3/Folder1`
Use a wildcard to ingest all child folders of Folder1.	`/Folder1/*` Note The reports in all child folders of Folder1 are ingested, but the reports in Folder1 itself are not ingested.
Ingest all reports from Folder1 and all of the reports in the child folders of Folder1.	`/Folder1/*, /Folder1`

Tip For more information about connecting to a SSRS or PBRS folder, see the Microsoft documentation.

Yes

Source configuration

This field allows you to provide <source ID> configuration file JSON code.

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.

If you previously integrated SSRS-PBRS via the lineage harvester, you can copy and paste in this field the JSON code from your SSRS-PBRS <source ID> configuration file.

Connection definition properties

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. If you set the `useCollibraSystemName` property to `true` in your lineage harvester configuration file, but you either don't create a <source ID> configuration file, or don't specify a value for the `collibraSystemName` property in your <source ID> configuration file, the system name in the technical lineage is "DEFAULT". How to configure this property if you have two databases with the same name 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. Copy `"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. Click for possible values: 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

Example

See an example.

Copy

{
    "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"
        }
    }
}

Property

This section contains the custom parameters you can specify to create technical lineage. Click Add property to add a property.

You can use this field to set the HTTP timeout duration by adding the httpTimeout property:

Warning If you are a Collibra Platform for Government customer, this field is required to connect to a Collibra Data Lineage service instance:

Properties for Collibra Platform for Government customers

Type Value Type Name Value

Text

Plaintext

techlinHost

This is the URL of the Collibra Data Lineage service instance to which you want to upload metadata, for example techlin-europe-west1.collibra.com.

Example: techlin-europe-west1.collibra.com

Text

Secret

techlinKey

This is the unique API key to connect to a Collibra Data Lineage service instance.

Specify a unique user key for each Collibra environment. If you're not sure what your user key is, contact your Collibra Collibra Account Team.

<your-techlin-key>

Yes for US government customers.

Dependent On Sources

This option allows you to provide table-definition details from an independent data source to a data source that is dependent on those details. This is needed to avoid analysis errors and to have a complete lineage that includes lineage from the SQL statements from dependent data sources.

To use this option, enter the source ID of the independent source.

Important If a dependent data source contains lowercase column names, this feature will only work for the following dialects: Oracle, Snowflake, and Teradata. For all other dialects:

An analyze error is raised, prompting you to provide the DDL file.
The only workaround is to consolidate your SQL statements and DDL file in a single data source.

For complete information, go to Sharing database models across data sources.

Delete Raw Metadata After Processing

Technical lineage via Edge harvests raw metadata from specified data sources and uploads it in a ZIP file to a Collibra Data Lineage service instance. This option indicates whether the raw metadata should be deleted from the Collibra Data Lineage service instance after the metadata that is targeted for ingestion in Data Catalog is processed.

Select this option to indicate that the raw source metadata is deleted after processing.

Clear the checkbox to keep the raw source metadata after processing. In this case, it is stored in the Collibra infrastructure.

Analyze Only (Deprecated)

Important This option is deprecated and will be removed in a future version of Collibra. We recommend that you no longer use it. The mandatory Processing Level setting, below, replaces this option.

The "Analyze" option in the Processing Level setting is the equivalent of selecting the Analyze Only option.
The "Sync" option in the Processing Level setting is the equivalent of clearing the Analyze Only option.

Processing Level

Important This setting replaces the deprecated Analyze Only option, which will be removed in a future version of Collibra.

For each of your data sources, you have to specify one of the following values: Load, Analyze, or Sync. Then, when you synchronize your technical lineage, the following process begins:

Metadata for all data sources is loaded, regardless of the value of this setting for a particular data source.
Metadata from data sources for which the value of this setting is either Analyze or Sync, is analyzed.
Metadata from data sources for which the value of this setting is Sync, is synchronized.

Value Description

Load

Harvest metadata from the data source and upload it to your Collibra environment. This allows you to inspect and, if necessary, edit the harvested metadata before uploading it to the Collibra Data Lineage service instance for analysis.

When the job is done, you can download and review the metadata:

Open the Activities list.
In the row containing the job, click Result.
The Synchronization Results dialog box appears.
Click download and save the ZIP file to your hard drive.

Tip The download link resembles the following: https://integrations.collibra-abc.com/rest/2.0/files/01944f12-7665-7d9c-8bc5-aa426b6a63cc. Take note of the file ID, in this example: 01944f12-7665-7d9c-8bc5-aa426b6a63cc. After you inspect the metadata, you can send the ZIP file for analysis by using the "Analyze files" option. Alternatively, you can upload the ZIP file using the POST /files API. In either case, you need to specify the file ID.

Analyze

Load and analyze the metadata on the Collibra Data Lineage service instance.

Synchronization does not start after analysis; it starts only after either:

You trigger synchronization of another data source for which you specify Sync in the Processing Level drop-down list.
You configure the Technical Lineage Admin Edge or Collibra Cloud site capability, and trigger synchronization via the Sync option in the Integration Configuration tab in Data Catalog.

Important If you want to synchronize multiple data sources, we strongly recommend that you select this option in the respective Edge or Collibra Cloud site capabilities for each of your data sources. This allows you to synchronize all data sources in a single job, thereby maximizing efficiency and mitigating the risk of failed synchronization jobs.

For complete information and important considerations, go to Tips for successful lineage synchronization
For more information about the Sync option in the Technical Lineage Admin Edge or Collibra Cloud site capability, go to Technical lineage admin options.

Sync

Load, analyze, and synchronize metadata from all data sources. Synchronization starts – or is queued, if another synchronization job is running – immediately after analysis.

Important If you want to synchronize multiple data sources and you select this option, each data source is processed as a separate job. This is highly inefficient and will likely lead to failed sync jobs. For complete information and important considerations, go to Tips for successful lineage synchronization.

Yes

Active

The option determines whether to include or remove the technical lineage of the data source.

Select this option to include the technical lineage of this data source.

Clear the checkbox to exclude the technical lineage of this data source.

Debug

This setting is not valid for this integration. It should be set to false.

Log level

Only complete this field on the request of or together with Collibra Support.

Click Create.
The capability is added to the Edge or Collibra Cloud site.
The fields become read-only.

What's next

You can now synchronize the technical lineage.