For the complete documentation index, see llms.txt. This page is also available as Markdown.

Configuring a new integration

This section shows you how to use the Integration configuration wizard to set up a new integration of Data Quality & Observability (self-hosted) metadata from profile findings, rules, and alerts into Collibra Platform.

This is a one-time configuration per environment.

You can associate a single data asset with multiple tables. The cardinality of the "Data Asset Represent Table" relation type is one-to-many.

Prerequisites

To use the SQL Assistant for Data Quality with an OAUTH-based Data Quality & Observability (self-hosted) integration with Collibra Platform, you must have Data Quality & Observability (self-hosted) version 2026.03 or later.

For the Integration API to run successfully, ensure that you review and meet the following criteria.

  • The most recent versions (recommended) of Data Quality & Observability (self-hosted) and Collibra Platform. For more information on versions, go to Supported versions.

  • You have an Admin role or a role mapped to specific connections in Data Quality & Observability (self-hosted) to use the configuration wizard.

  • You have an Admin or Dataset Manager role in Data Quality & Observability (self-hosted) to enable or disable individual datasets for integration.

  • Your Collibra Platform profile must have Sysadmin and DataSteward global roles to manage all assets and objects of the integration.

  • You have followed the steps on how to add Data Quality Rules to Assets in Collibra Platform.

  • You have an aggregation path set for your Data Quality Rule in Collibra Platform Settings Operating model Data quality rules.

  • The DigiCert root and intermediate CA certificates are installed in the Data Quality & Observability (self-hosted) Java truststore. Collibra uses DigiCert as its Certificate Authority to issue the *.collibra.com SSL certificate that secures Collibra Platform instances.

Steps

1

Hover your cursor over the icon and click Integrations. The Integrations page opens.

2

In the upper right corner, click Add Integration. The Integration Setup wizard appears.

3

On the Credentials step, enter the required information.

Option
Description
Required

Service Type

The application with which to integrate Data Quality & Observability (self-hosted) metadata.

This value is always Data Intelligence Cloud.

Yes

Service URL

The URL of the Collibra Platform environment to send Collibra DQ metadata. For example, "https://dg-example.collibra.com".

Yes

Authentication Mode

The method of authenticating the API call to Collibra Platform.

You can select either Basic or OAuth.

To change the authentication mode, you should update the existing service URL credential. Only one integration credential can use a specific service URL. You can't have both Basic and OAuth for one service URL.

Yes

OAuth Token Endpoint

The Collibra Platform URL where Data Quality & Observability (self-hosted) sends requests to obtain the OAuth access token. The OAuth Token Endpoint must be in this format: https://<yourdomain>.collibra.com/rest/oauth/v2/token

To change the OAuth scopes that Data Quality & Observability (self-hosted) requests from Collibra Platform, go to Configuring the default OAuth scope.

To register your Collibra DQ instance, go to the OAuth Applications settings page.

Yes

Service Account

The username of your Collibra Platform environment. For example, "integration.user" or "Admin".

Yes

Password

The password of your Collibra Platform environment.

Yes

Client ID

The public identifier provided by your OAuth service provider.

Yes

Client Secret

The credential string from your OAuth service provider used to verify the identity of Data Quality & Observability (self-hosted) during the token request process.

Yes

4

Click Next. The Connections step opens.

5

On the Connections step, map your Collibra DQ connections to the appropriate database, schema, table, and column assets in Collibra Platform.

1

Optionally, select the Map to primary column only switch to see only the column identified as the primary column related to the rule in Collibra Platform.

2

From the Select Connection drop-down list, select a Collibra DQ database to integrate into Collibra Platform.

3

In your Collibra Platform environment, open the asset page of the database you intend to map, then copy the URL from the UUID of the database asset from the URL.database asset page uuid example screenshot

4

From the Connections tab in Collibra DQ, paste the copied UUID from Collibra Platform, or enter the UUID manually.

5

If this is the first integration, then click More icon, then Run to create an automatic mapping between the schemas within your selected Collibra DQ database and the schemas within Collibra Platform. If this is not the first integration, then proceed to the next step.

6

When the connection loads, click More icon, then Show Full Mapping to expand the entire database mapping, including schemas, tables, and columns. You can use the Auto Map feature or manually map (or a combination of both) for each schema.

1
Auto Map

Click More icon, then Auto Map. Select the tables to include in the mapping. Use the Search options to filter the results. Once the applicable tables are in the Included column, click Apply Auto Map to map tables in your DQ schema to those in DGC automatically. You can track the mapping status or cancel an in-progress mapping on the Mapping Status step.

If auto map fails for a schema, then the Data Quality & Observability (self-hosted) mapping table is not updated. This is considered an atomic update, which is a series of operations that function as a single, indivisible unit. The operations either complete entirely or fail completely, ensuring that no partial states occur.

2
Manually map
  1. In the DGC Name column, optionally click the drop-down list and select a different schema ( schema icon ) to update the schema mapping.

    When a name match cannot be made, a "Not Configured" message displays.

  2. In the DQ Name column, click the schema name to expand the available tables. The selected schema expands to show the available tables, and their corresponding tables ( table icon ) appear across from them in the DGC Name column.

  3. In the DGC Name column, click the drop-down list and select a different table to update the table mapping, if necessary.

  4. In the DQ Name column, click the table name to expand the available columns. The selected schema expands to show the available columns, and their corresponding columns ( column icon ) appear across from them in the DGC Name column.

  5. In the DGC Name column, click the drop-down list and select a different column to update the column mapping, if necessary.

schema, table, and column mapping example

If the table count shows as --/--, then select More icon Hide mapping (next to the Enter DGC Database UUID field) and then More icon Show mapping to refresh the counts. If this doesn't resolve the issue, then verify your column or schema name doesn't have special characters.

  1. Optionally, click More icon, then Delete Mapping to delete all the mapping records for the specific schema, including data quality rules, columns, jobs, and asset table relations.

  2. Optionally, click Add New to map another connection and then repeat this process.

6

Click Next. The Mapping Status step opens.

7

On the Mapping Status step, optionally review mapping details.

Mapping Status allows you to view mapping details, such as the number of available tables in a schema that are mapped and when a connection mapping fails.

Column
Description

Connection Name

The name of the data source included in the mapping.

Schema Name

The name of the schema included in the mapping.

Status

The state of completion of the mapping.

Start Time

The time stamp, in yyyy-MM-dd hh:mm:ss format, of when the mapping began.

End Time

The time stamp, in yyyy-MM-dd hh:mm:ss format, of when the mapping stopped.

Tables Mapped

The number of tables that mapped out of the total tables available in the schema. The 3 numbers shown in x/y/z format represent:

  • x = partial column table count. The number of tables found in Data Quality & Observability (self-hosted) and Collibra Platform where some (>0 and < all column count) of the columns were mapped.

  • y = all column table count. The number of tables found in and Collibra Platform where all columns were mapped.

  • z = all tables discovered count. The total table count found in Data Quality & Observability (self-hosted) using the datasource connection for the "automap" schema.

There may be instances when x+y does not equal z. This occurs when tables from Collibra Platform aren't available because their metadata hasn't been ingested. When those tables are found through the Data Quality & Observability (self-hosted) connection, there is no attempt to map the tables or columns. The table is included in the total table count (z), but not in the partial or all column table counts (x or y).

Exception

When an error during the mapping occurs, a message describes the issue. If the error message is truncated, you can hover your cursor over it to view the full message in a tooltip.

When an exception did not occur, the value in this column is N/A.

Actions

When a mapping job is in progress, a Close icon option appears in this column to allow you to cancel the job if necessary.

screenshot of mapping status step
8

Click Next. The Tenants step opens.

9

On the Tenants step, enter the required information.

  1. Optionally, choose to align your Collibra DQ tenant with an existing Collibra Platform community.

    1. Align

      • Select a Collibra Platform community from the drop-down list with which to align your tenant.

    2. Don't Align,

      • Enter the name of a new community with which to align your tenant.

    tenant mapping screenshot

Beneath each tenant-level community, a sub-community is created for each Business Unit that has datasets assigned to it in Collibra Platform. If a dataset is not assigned to a Business Unit, it is added to a community called Unassigned DQ Job by default.

10

Click Next. The Dimensions step opens.

11

On the Dimensions step, enter the required information.

1

Select a dimension from the drop-down list of the Data Intelligence Platform Dimension column that corresponds with the Data Quality Dimension you want to identify as a match.

All Data Quality Dimensions from your Collibra Platform environment are available to map to Data Quality Dimensions in Collibra DQ, including custom dimensions. However, Data Quality Dimensions from Collibra DQ are not customizable at this time.

Out of the box, not all adaptive rules are automatically assigned dimensions. Dimensions can be assigned to adaptive rules by changing a Metastore table. Contact Support or Professional Services for additional information.

More information about out-of-the-box dimensions
Dimension
Description
Out-of-the-box dimension assigned?

Accuracy

The degree to which data correctly reflects its intended values.

Monitors associated with the accuracy dimension:

  • Monitor: Min Value - Metastore subtype: Min Value

  • Monitor: Max Value - Metastore subtype: Max Value

  • Monitor: Mean Value - Metastore subtype: Mean Value

No

Completeness

The percentage of cells in a column that contain values identified as actual values, null, or empty. Completeness refers to the percentage of columns that have neither EMPTY nor NULL values.

Monitors associated with the completeness dimension:

  • Monitor: Row Count - Metastore subtype: Row

  • Monitor: Null - Metastore subtype: Null

  • Monitor: Empty - Metastore subtype: Empty

Yes

Consistency

The degree to which data contains differing, contradicting, or conflicting entries.

Monitor associated with the consistency dimension:

  • Monitor: Load Time - Metastore subtype: Time

Yes

Validity

The degree to which data conforms to its defining constraints or conditions, which can include data type, range, or format.

Monitor associated with the validity dimension:

  • Monitor: Data Type - Metastore subtype: Shift

No

Duplication

The degree to which data contains only one record of how an entity is identified. Refers to the cardinality of columns in your dataset.

Monitors associated with the duplication dimension:

  • Monitor: Cardinality - Metastore subtype: Unique

  • Monitor: Unique - Metastore subtype: Unique

No

dimension mapping screenshot
12

Click Next. The Layers step opens.

13

On the Layers step, select which layers to synchronize to Collibra Platform.

  1. If needed, clear the Create Metric Assets option. When selected, metric assets, such as Passing Fraction and Loaded Rows, are automatically created during integration to support the required data quality metrics for your Collibra Platform aggregation path or workflow design. When cleared, metric assets are not created during integration.

  2. Select a layer in the Sync on Integration column to automatically create a new asset in Collibra Platform when the integration runs.

  3. Select the Sync on Breaks option to create a new asset in Collibra Platform only when the layer has a finding.

14

Click Finish.

Known limitation

During the integration between Data Quality & Observability (self-hosted) and Collibra Platform, the Last Job Run and Last Successful Job Run attributes are sent as strings instead of dates. As a result, the time zone is converted to UTC (the Collibra Platform standard) instead of the user's time zone.

What's next

Enable a dataset for integration and start ingesting metadata from Collibra DQ into Collibra Platform.

Last updated

Was this helpful?