Prepare Azure Data Factory <source ID> configuration file

You can create the Azure Data Factory <source ID> configuration file to define connections and mappings.

Example 

Steps

  1. Create a new JSON file in the lineage harvester config folder.
  2. Name the JSON file as <sourceId>.conf, where <sourceId> is the same as the value of the sourceId property in the lineage harvester configuration file and the file extension must be .conf.
    Example If the value of the sourceId property in the lineage harvester configuration file is my-adf, the name of your JSON file must be my-adf.conf.
  3. For each database in Azure Data Factory, add the following content to the JSON file:

    Property

    Description

    Mandatory?

    found_dbname=<database name>;found_hostname=<server name>;found_schema=<schema name> | found_dbname=<datafactory_name>_<linkedservice_name>;found_hostname=*

    The information of the supported data sources in Azure Data Factory to be collected by the lineage harvester. You can specify any of the following values for the found_dbname property:

    • A database name. And then you can specify the following properties:
      • found_hostname=<server name>, where <server name> is the name of the server that the database is running on.
      • found_schema=<schema name>, where <schema name> is the name of the schema. This property is optional.
    • The combination of <datafactory_name>_<linkedservice_name>, where <datafactory_name> is a data factory name and <linkedservice_name> is a linked service name. If you use this combination, specify * for the found_hostname property.
    Tip 

    You can use wildcards to capture multiple connection string combinations:

    Yes

    dbname

    The name of the database asset in Data Catalog. Specify this property with the database name that you created when you prepared the Data Catalog physical data layer.

    No

    schema

    The name of the schema asset in Data Catalog. Specify this property with the schema name that you created when you registered the data source.

    If the lineage harvester fails to find the schema that you specify, it uses the default schema.

    No

    dialect

    If you specify a database name for the found_dbname property, select one of the following dialects. If you specify a linked service name for the found_dbname property, ignore this property.

    No

    collibraSystemName

    The system or server name of a database.

    If you don't specify a value for this property, "DEFAULT" is shown in the technical lineage harvester.

    Warning The value of this property must exactly match (including for case-sensitivity) the name of your System asset in Collibra.

    Important If you are using a <source ID> configuration file for the purpose of providing the true system name of an ODBC database in Azure Data Factory, you are not required to:
    • Set the useCollibraSystemName property in the lineage harvester 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 lineage harvester configuration file, you must specify a Collibra system name in the <source ID> configuration file.

    Yes

  4. Save the <source ID> configuration file.