Create a technical lineage via Edge

Important 

In Collibra 2024.02, we've launched a new user interface (UI) in beta for Collibra Data Intelligence Cloud! You can learn more about this latest UI in the UI overview.

Use the following options to see the documentation in the latest UI or in the previous, classic UI:

This topic provides an overview of the necessary steps to create a technical lineage via Edge.

You can also use the Collibra Catalog Cloud Ingestions API to create or update a technical lineage capability and start or schedule a synchronization to create a technical lineage. For more information about using APIs, go to Collibra Developer Portal.

To view the steps to create technical lineage for your data source, select the data source and connection type, if applicable. For a listed of supported data sources and their corresponding connection types, go to Supported data sources for technical lineage.

Tip 

Select a data source and the connection type if needed to see the related information.

Currently, the information is shown for:

Available vaults

Tip 

You can use a vault to add your data source information to your Edge site connection.

None
AWS Secrets Manager
Azure Key Vault
CyberArk Vault
Google Secret Manager
HashiCorp Vault
 
Important Collibra Data Lineage support for Databricks Unity Catalog is in beta testing, because the system tables feature in Databricks Unity Catalog is in Public Preview. Collibra Data Lineage support for Databricks Unity Catalog will go GA when the system tables feature in Databricks Unity Catalog goes GA.

Before you begin

  • Use Collibra Data Intelligence Cloud 2024.02 or newer
  • Use Collibra Data Intelligence Cloud 2023.03 or newer.
  • Use Collibra Data Intelligence Cloud 2023.08 or newer
  • Create an Edge site in Collibra Data Intelligence Cloud. Ensure that you use Edge 2024.02 or newer.
  • Install an Edge site.
  • Register the data source via Edge. Before you register the data source, ensure that you add the Catalog JDBC ingestion capability, so that CollibraData Lineage can stitch the data objects in your technical lineage to the assets in Data Catalog.
  • Integrate Databricks Unity Catalog or register a Databricks file system.

Requirements and permissions

The following requirements and permissions are needed for the technical lineage process. Additional, Edge-related roles and resources, are mentioned in each of the specific steps.

  • A global role with the following global permissions:
    • Data Stewardship Manager
    • Manage all resources
    • System administration
    • Technical lineage
  • A resource role with the following resource permission on the community level in which you created the BI Data Catalog domain:
    • Asset: add
    • Attribute: add
    • Domain: add
    • Attachment: add
  • As a technical lineage user, ensure that your Catalog Author global role has the following global permissions. With these permissions, Collibra Data Lineage can process the lineage and synchronize the results to Data Catalog to create technical lineage.
    • Catalog > Advanced Data Type > Add
    • Catalog > Advanced Data Type > Remove
    • Catalog > Advanced Data Type > Update
    • Catalog > Technical lineage
  • As a Data Catalog user, ensure that your Edge integration engineer global role has the following global permissions. With these permissions, you can create connections and capabilities on Edge, configure the integration, and synchronize the integration.
    • Manage connections and capabilities
    • View Edge connections and capabilities
  • As a Databricks Unity Catalog user, ensure that you have the following permissions in Databricks. The access token of this user must be specified in the Databricks connection so that Collibra Data Lineage can access the system tables (Public Preview) after connecting to Databricks Unity Catalog.
    • Enable the lineage system tables.
    • Have the USE CATALOG privilege to the system catalog.
    • USE_SCHEMA, and SELECT privileges to the system.access schema.
    • For details, go to Enable system tables and Grant access to system tables in Databricks documentation.

      If you do not have the right accesses, the Could not get column lineage data error occurs when you synchronize the Technical Lineage for Databricks Unity Catalog capability. Contact Databricks support if you encounter issues on getting access to the system tables.

  • Necessary permissions to all database objects that technical lineage via Edge accesses.
  • Tip Some data sources require specific permissions. For the data source selected above:
    You need read access on the SYS schema.
    You need read access on the SYS schema and the View Definition Permission in your SQL Server.
    You need read access on information_schema:
    • bigquery.datasets.get
    • bigquery.tables.get
    • bigquery.tables.list
    • bigquery.jobs.create
    • resourcemanager.projects.get
    • bigquery.routines.get
    • bigquery.routines.list
    • bigquery.readsessions.create
    • bigquery.readsessions.getData
    • GRANT SELECT, at table level. Grant this to every table for which you want to create a technical lineage.
    • The role of the user that you specify in the username property in lineage harvester configuration file must be the owner of the views in PostgreSQL.
    The role of the user must be the owner of the views in PostgreSQL, and the username of the user must be specified in the JDBC connection that you use to access PostgreSQL.
    You need read access on information_schema. Only views that you own are processed.
    Ensure that your service account token has the Read-Only permission.
    Ensure that you have the permission to copy the target/ directory, which is generated by running the dbt compile command, to a Shared Storage connection folder. For more information about the Shared Storage connection folder, go to Step 1 Create a Shared Storage connection.
    SELECT, at table level. Grant this to every table for which you want to create a technical lineage.
    A role with the LOGIN option.
    SELECT WITH GRANT OPTION, at Table level.
    CONNECT ON DATABASE
    The following permissions are required, regardless of the ingestion mode: SQL or SQL-API.
    • Ensure that the Snowflake user has the appropriate allowed host list. For details, go to Allowing Hostnames in Snowflake documentation.
    • You need a role that can access the Snowflake shared read-only database. To access the shared database, the account administrator must grant the IMPORTED PRIVILEGES privilege on the shared database to the user. The username of the user must be specified in the JDBC connection that you use to access Snowflake.
    • If the default role in Snowflake does not have the IMPORTED PRIVILEGES privilege, you can click the Add property button to add a custom parameter with the following values specified:
      FieldValue
      NamecustomConnectionProperties
      TypeText
      Encryption

      Select one of the following encryption methods: 

      • Not encrypted (plain text)
      • Encrypted with public key
      • To be encrypted by Edge management server
      Valuerole=METADATA
    You need read access on the DBC.
    You need read access to the following dictionary views:
    • all_tab_cols
    • all_col_comments
    • all_objects
    • ALL_DB_LINKS
    • all_mviews
    • all_source
    • all_synonyms
    • all_views
    You need read access on definition_schema.
    • Your user role must have privileges to export assets.
    • You must have read permission on all assets that you want to export.
    • You have at least a Matillion Enterprise license.
    • You have generated the Matillion certificate. Ensure that the certificate is signed by a certificate authority. Self-signed certificate is not supported when you create technical lineage via Edge.
    • You have added the Matillion certificate to a Java truststore. For more information about adding a certificate to a Java truststore, go to Add a Certificate to a Truststore Using Keytool.

    The following permissions apply only to MicroStrategy on-premises customers.

    • You need Admin API permissions.
      The first call we make to MicroStrategy is to authenticate. We connect to <MSTR URL>:<Port>/MicroStrategyLibrary/api-docs/ and use POST api/auth/login. You have to ensure that this API call can be made successfully.
    • You need permissions to access the library server.
    • The lineage harvester uses port 443. If the port is not open, you also need permissions to access the repository.
    • If you have a MicroStrategy on-premises environment, you need the permissions for all of the database objects that the lineage harvester accesses.
    • You have to configure the MicroStrategy Modeling Service. For complete information, see the MicroStrategy documentation.
    • Necessary permissions to all database objects that the lineage harvester accesses.
    Important 
  • Before you start the Power BI integration process, you have to perform a number of tasks in Power BI and Microsoft Azure. These tasks, which are performed outside of Collibra, are needed to enable the lineage harvester to reach your Power BI application and collect its metadata. For complete information, go to Set up Power BI.

  • Collibra Data Lineage supports:

    • Power BI on the Microsoft Power Platform.
    • Power BI on Fabric.
    The configuration requirements and the integration are the same, regardless of your setup.

  • Important 
    Before you start the Tableau integration process, you have to perform a number of tasks in Tableau. For complete information, go to the following topics:

Steps

  1. Set up Tableau.
  2. Set up Power BI.
  3. Set upMicroStrategy.
  4. Which custom lineage definition option are you using?