About data contract creation and maintenance
The data contract is an important part of a data product as it shapes the agreement between the data product owner and the data consumers. The data contract documents the structure, format, service level, quality, and terms of use. A data contract consists of a high-level overview of the agreement and one or more data contract manifests. Data contract manifests are the actual YAML files that contain the definitions and contents of a data contract.
For more information, go to About data contracts.
Available tools to create and maintain data contracts
To create, maintain, and show data contracts and their details, Collibra offers a set of tools. These tools are optimized for the Open Data Contract Standard, an open-source framework that describes what is expected in a data contract manifest file. Collibra provides:
-
In-product features to create, manage, and view the data contracts and manifests.
-
CLIs and API calls to create, maintain, and integrate data contracts and manifests.
Data Contract SLA mappings
The following out-of-the-box SLA (Service Level Agreement) asset attributes are mapped to the manifest file. These attributes are used by Collibra to generate a manifest file and are updated with manifest data when you use the apply API command.
| 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 |
When mapping manifest file data to Collibra only manifest file data with titlecase (camelCase) property names are mapped to Data Contract asset attributes. If the manifest property includes a unit, both the value and the unit are combined in the Data Contract attribute.
slaProperties: - property: retentionPeriod value: 5 unit: months
Variations in the manifest, such as retentionperiod or retention_period won't be mapped.
Related topics
- Creating and maintaining data contracts and their manifest files from Collibra
- Creating and maintaining data contracts and their manifest files through CLI and API
- Viewing all data contracts via the Data Contract Registry
- About data products
- Data product asset types and operating model