Prepare the lineage harvester configuration file for SSRS and PBRS integration

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

{
 "general": {
   "catalog": {
     "url": "https://<organization>.collibra.com",
     "username": "<your-collibra-username>"
   },
   "useCollibraSystemName": false
 },
  "sources": {
    "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"],
	"deleteRawMetadataAfterProcessing": true
  }
}

Before you begin

• Set up the latest lineage harvester.
• Prepare a domain in Data Catalog.
• Prepare a SSRS and PBRS <source ID> configuration file, if necessary.

Requirements and permissions

• The following roles with user access to the server from which you want to ingest:

  • A system-level role that is at least a System user role.
  • An item-level role that is at least a Content Manager role.

• Collibra Data Intelligence Cloud.
• A global role with the following global permissions:
  • Catalog, for example Catalog Author
  • Data Stewardship Manager
  • Manage all resources
  • System administration
  • Technical lineage
• A resource role with the following resource permissions on the community level in which you created the BI Data Catalog domain:
  • Asset: add
  • Attribute: add
  • Domain: add
  • Attachment: add

Steps

1. Open the lineage-harvester.conf file that was created when you installed the lineage harvester, and enter the values for each property.

   Properties	Description
   general	This section describes the connection information between the lineage harvester and Data Catalog.
   techlin	This section contains information that is necessary to connect to the Collibra Data Lineage service instance. Warning This section applies only to US government customers.
   url	The URL of the Collibra Data Lineage service instance.“url”: “https://techlin-gov.collibra.com” Warning This section applies only to US government customers.
   userKey	The unique API key to connect to the Collibra Data Lineage service instance. A unique user key is needed for each Collibra environment. If you're not sure what your user key is, please contact your Collibra Customer Success Manager. Warning This section applies only to US government customers.
   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 use the system or server name of a data source to match to the System asset you created when you prepared the physical data layer. This is useful when you have multiple databases with the same name. By default, the useCollibraSystemName property is set to false. If you want to use it, set it to true. Important  If you set this property to true, the lineage harvester reads the value of the collibraSystemName property in your SSRS-PBRS <source-ID> configuration file. If you set the useCollibraSystemName property to false, the lineage harvester ignores the collibraSystemName property in the <source-ID> configuration file.
   sources	This section contains all SSRS connection properties.
   id	The unique ID to identify the SSRSmetadata that was uploaded to the Collibra Data Lineage service. 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 service. Warning In the sources section of your lineage harvester configuration file, you can only specify one id property per SQL Server Reporting Service (SSRS) or Power BI Report Server (PBRS). If you have multiple id properties for a single SSRS or PBRS, ingestion will fail. If you have multiple id properties in the configuration file, it means you intend to ingest from multiple unique SSRS or PBRS.
   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 domain in Collibra Data Intelligence Cloud in which you want to ingest the 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/*"] Important This property must be included in your configuration file and it cannot be empty. If you want to ingest all folders, use *, for example: "folderFilter":["*"]. Tip For more information about connecting to a SSRS or PBRS folder, see the Microsoft documentation.
   deleteRawMetadataAfterProcessing	The lineage harvester harvests raw metadata from specified data sources and uploads it in a ZIP file to a Collibra Data Lineage service instance, for processing. You can use this optional property to specify whether or not the raw metadata should be deleted from Collibra Data Lineage service instance after the metadata that is targeted for ingestion in Data Catalog is processed. The default value is false. If the property is set to true, the raw source metadata is deleted after processing. If set to false, it is stored in the Collibra infrastructure. Note Setting this property to true can negatively impact performance.

2. Save the configuration file.