Prepare the lineage harvester configuration file for SQL Server Reporting Services and Power BI Report Server integration

You have to prepare a configuration file before you run the lineage harvester. The lineage harvester collects your SQL Server Reporting Services and Power BI Report Server metadata and sends it to Collibra Data Intelligence Cloud, where it is processed and analyzed. Collibra then imports the SQL Server Reporting Services and Power BI Report Server assets and relations to Data Catalog.

Tip We highly recommend to use the configuration file generator to make sure your configuration file is valid.

Prerequisites

You have access to the lineage harvester in the Downloads section of the Collibra Product Resource Center.
You have Collibra Data Intelligence Cloud 2021.06 or newer.
You have downloaded the lineage harvester version 1.4.0 and you have the necessary system requirements to run it.
You have prepared the SQL Server Reporting Services configuration file, if necessary.
You have a global role that has the Manage all resources global permission.

Steps

Run the following command line to start the lineage harvester:
- Windows: .\bin\lineage-harvester.bat
- for other operating systems: chmod +x bin/lineage-harvester and then bin/lineage-harvester
An empty configuration file is created in the lineage harvester config folder.

Open the lineage-harvester.conf file and enter the values for each property.

Properties	Description
general	This section describes the connection information between the lineage harvester and Data Catalog.
catalog	This section contains information that is necessary to connect to Data Catalog.
url	The URL of your Collibra Data Intelligence Cloud environment. Note You can only enter the public URL of your Collibra Data Intelligence Cloud environment. Other URLs will not be accepted.
username	The username that you use to sign in to Collibra.
useCollibraSystemName	Indication whether you want to include the system or server name of a data source to differentiate between data sources with the same name. Tip We highly recommend to only set `useCollibraSystemName` to `true` if you want to enable the Collibra Data Lineage server to process multiple databases with the same name.
sources	This section contains all SQL Server Reporting Services connection properties.
collibraSystemName	The system or server that you use when you ingest SQL Server Reporting Services. If you only want to ingest one SQL Server Reporting Services source, this property is optional. If you want to ingest multiple SQL Server Reporting Services sources, you have to leave this property empty and create a SQL Server Reporting Services <source ID> configuration file. Note If the `useCollibraSystemName` is set to `true`, you have to include a separate configuration fileseparate configuration file that maps the data objects in SQL Server Reporting Services to a system > database > schema > table > column structure.
id	The unique ID to identify the SQL Server Reporting Services metadata that was uploaded to the Collibra Data Lineage server. Tip This value can be anything as long as it is a unique. The lineage harvester uses the ID to identify a batch of data on the Collibra Data Lineage server.
type	The kind of data source. In this case, the value has to be SSRS or PBIRS. Note There is no difference between type SSRS or PBIRS.
url	The URL to the server's web portal. By default, the URL is http://<computer-name>/reports. For example, "http://1.23.45.678/PowerBIReports".
userName	The username you use to sign in to the web portal. Tip If you use NTLM authentication, your username also contains the NTLM domain name. For example `MyDomain\\username`.
domainId	The unique ID of the domaindomain in Collibra Data Intelligence Cloud in which you want to ingest the SSRS assets. Finding the domain ID Open the domain. Copy the domain ID. Tip If you go to your domain, you can find the domain ID in the URL. The URL looks like: https://<yourcollibrainstance>/domain/22258f64-40b6-4b16-9c08-c95f8ec0da26?view=00000000-0000-0000-0000-000000040001. In this example, the domain ID is in bold.
folderFilter	An option to exclude specific folders that contain reports or KPIs from the ingestion process. You can add multiple folders by listing folder names, providing the full path to folders or by using a wildcard: Use folder names when the folder name is unique: ["folder 1", "folder 2"] Use the full path to the folder to only ingest a specific folder: ["/database1/folder1", "/database2/folder2"] Use a wildcard to ingest all child folders or a specific folder: ["/folder1/", "/folder2/"] You can also use a combination of these methods. For example, ["folder 1", "/database/folder2", /folder3/*"] If the `folderFilter` field remains empty or is deleted from the configuration file, all accessible SQL Server Reporting Services and Power BI Report Server folders are processed and ingested. Tip For more information about connecting to a SQL Server Reporting Services or Power BI Report Server folder, see the Microsoft documentation.

Save the configuration file.
Start the lineage harvester again in the console and run the following command:
- for Windows: .\bin\lineage-harvester.bat full-sync
- for other operating systems: ./bin/lineage-harvester full-sync
When prompted, enter the passwords to connect to Collibra and SQL Server Reporting Services. Do one of the following:
- Enter the passwords in the console.
  The passwords are encrypted and stored in /config/pwd.conf.
- Provide the passwords via command line.
  The passwords are stored locally and not in your lineage harvester folder.

Example

{
 "general": {
  "catalog": {
   "url": "https://<organization>.collibra.com",
   "userName": "<your-collibra-username>"
  },
  "useCollibraSystemName": false
 },
 "sources": {
  "collibraSystemName": "",
  "id": "<unique-id>",
  "type": "SSRS",
  "url": "http://<IP address or computer name>/Reports",
  "userName": "<server-api-user-name>",
  "domainId": "<domain-resource-id>",
  "folderFilter":  ["/Folder1/*", "Folder2"]
 }
}

Note There is no difference between type SSRS or PBIRS.

Tip We highly recommend you to use the lineage harvester configuration file generator when you create a configuration file.

What's next?

The lineage harvester triggers Collibra to import SQL Server Reporting Services and Power BI Report Server assets and their relations and create a technical lineage for SQL Server Reporting Services assets.Collibra also stitches the new SQL Server Reporting Services assets to existing assets in Data Catalog.

Note We can only access stitching and lineage information for SSRS assets, but not for Power BI reports in Power BI Report Server and SQL Server Reporting Services.

If issues occur during the ingestion process, check the Collibra Data Lineage troubleshooting section to solve your problems.

To synchronize the SQL Server Reporting Services and Power BI Report Server metadata, you can run the lineage harvester again or schedule jobs to run them automatically.

Tip You can check the progress of the ingestion in Activities. The results field indicates how many relations were imported into Data Catalog.