Manifest-to-asset mappings

When you work with a data contract, information flows between the data contract manifest and the asset attributes. This topic explains how those asset attributes map to the manifest properties and vice versa. Understanding this mapping helps you identify the source of values when you generate manifest versions based on Collibra metadata, apply manifest versions to Collibra metadata, or troubleshoot missing server or schema details.

SLA mapping

The following out-of-the-box SLA asset attributes are used to generate a manifest version for a data contract. When you apply a manifest version, these asset attributes are updated with the data in the manifest.

Collibra asset attribute Manifest property

Backup Frequency

backupFrequency
Latency latency
Most Recent Record Date mostRecentRecordDate

Processing Frequency

processingFrequency

Processing Method

processingMethod

Recency

recency

Recovery Point

recoveryPoint

Recovery Time

recoveryTime

Response Time

responseTime

Retention Period

retentionPeriod

Support Availability

supportAvailability

Unlimited Retention

isRetentionUnlimited

Uptime Percentage

uptimePercentage

SLA property mapping rules

When you apply a manifest version, only the manifest property names that use camelCase are mapped to the Data Contract asset attributes. If a manifest property includes a unit, both the value and the unit are combined in the attribute.

For example, for the following manifest data, the resulting value for the Retention Period attribute is 5 months. Any other variations in the property name, such as retentionperiod or retention_period, are ignored.

slaProperties:
	- property: retentionPeriod
	value: 5
	unit: months

Server mapping from Collibra to manifest

When you generate a data contract manifest, Collibra includes a Servers section for the following data sources: Athena, BigQuery, Databricks, MySQL, Oracle, PostgreSQL, Redshift, Snowflake, SQL Server.

The Servers section contains fields such as server, type, database, and schema. By default, this information is retrieved from the Edge connection string, if the JDBC data source was registered through Edge. If this information is not available, it is retrieved from Database and Schema assets.

Generic fields

The manifest properties use the values of the following Collibra asset attributes.

Manifest property Collibra asset attribute
id

UUID of the Database asset.

server Name of the Edge connection or display name of the Database asset.
type This value is calculated by Collibra and refers to the data source, for example, Snowflake.
description

Description of the Edge connection or the Database asset.

host

Edge connection string and properties (host, server) or location of the Database asset.

port

Edge connection string and properties (port) or location of the Database asset.

Data source fields

The manifest properties use the values of the following Collibra asset attributes.

Data source Manifest property Collibra asset attribute
Athena catalog Edge connection string and properties (catalog), display name of the Database asset, or location of the Database asset.
schema Display name of the Schema asset.
regionName Edge connection string and properties (region, awsregion) or location of the Database asset.
stagingDir Edge connection string and properties (s3stagingdirectory, outputlocation, s3outputlocation) or location of the Database asset
BigQuery project

Edge connection string and properties (projectid), location of the Database asset, or display name of the Database asset.

dataset

Edge connection string and properties (projectid), location of the Database asset, or display name of the Schema asset.

Databricks catalog Edge connection string and properties (catalog), display name of the Database asset, or location of the Database asset.
schema

Display name of the Schema asset.

MySQL database Edge connection string and properties (database), location of the Database asset, or display name of the Database asset.
schema

Display name of the Schema asset.

Oracle serviceName

Edge connection string and properties (servicename), location of the Database asset, display name of the Database asset.

schema Display name of the Schema asset.
PostgreSQL database

Edge connection string and properties (database), location of the Database asset, or display name of the Database asset.

schema Schema asset displayName
Redshift database Edge connection string and properties (database), location of the Database asset, or display name of the Database asset.
schema

Display name of the Schema.

region Edge connection string and properties (region) or location of the Database asset.
account Edge connection string and properties (account) or location of the Database asset.
Snowflake database

Edge connection string and properties (database), location of the Database asset, or display name of the Database asset.

account

Edge connection string and properties (account) or location of the Database asset.

warehouse

Edge connection string and properties (database) or location of the Database asset.

schema Display name of the Schema asset.
SQL Server database Edge connection string and properties (database), location of the Database asset, or display name of the Database asset.
schema

Display name of the Schema asset.

Relation mapping from manifest to Collibra

When you apply a manifest version, Collibra creates or updates relations between Data Product Port assets and Table assets. To identify and match the correct Table asset, Collibra extracts the database, schema, and table names from the manifest in the following order of priority.

Priority Description
1. physicalName property If physicalName contains three parts (database, schema, and table), Collibra uses this information to locate the Table asset to create the relation. If physicalName contains only the table name, Collibra proceeds to custom properties to resolve the missing schema and database names.
2. Custom properties

If physicalName does not contain the schema or database name, Collibra checks custom properties schemaName and databaseName. Both properties must be present. If only one is present, the relation cannot be created.

3. Servers section

If neither physicalName nor custom properties specify the schema or database name, Collibra checks the Servers section by using the following fields:

  • Schema: Defined as schema or dataset. schema takes priority over dataset.
  • Database: Defined as database, catalog, or project. database takes priority over catalog, and catalog takes priority over project.

Collibra uses the first source in the manifest where it finds the required information. If the information is missing from one source, it checks the next priority source.

Duplicate asset handling

If a database, schema, and table combination matches more than one Table asset (for example, if duplicate Table assets exist in your environment), the following rules are applied:

  • If a relation already exists: The existing relation between the linked Data Product Port asset and the Table asset remains unchanged.
  • If no relation exists: A new relation is not created.