This repository contains an Excel template for authoring data contracts using the Open Data Contract Standard. It provides a user-friendly interface to define and share data contracts with stakeholders, especially those less familiar with YAML. You can convert the Excel into YAML through the Data Contract CLI or upload it directly to Entropy Data.
Download the Excel Template:
Here are example Data Contracts:
- shipments-example.xlsx that can be converted to this YAML
- full-odcs-3.2.xlsx and its YAML, a reference contract that uses every element of ODCS v3.2.0 — multiple schemas, all quality types, enums, synonyms, context, relationships and servers
A data contract, such as ODCS, defines the structure, format, semantics, quality, and terms of use for data exchanged between a producer and one or more consumers.
While data contracts are typically written in YAML, this Excel template enables easier collaboration, review, and iteration—especially across business and technical teams.
The Excel file includes the following sheets:
Provides a quick guide on how to fill out the template.
Captures general metadata for the data contract, including ID, Name, Version, Domain and Description.
Defines the data model with all properties.
Copy this sheet for every table in your data contract.
Defines relationships between schemas by mapping properties from one schema to another (e.g., foreign keys).
Describes data quality rules & parameters. They are tightly linked to the schema described in the Schema sheet(s).
Support and communication channels help consumers find help regarding their use of the data contract.
This section lists team members and the history of their relation with this data contract. In v2.x, this section was called stakeholders.
This section lists team members and the history of their relation with this data contract.
This section describes the service-level agreements (SLA).
The servers element describes where the data protected by this data contract is physically located.
This section covers pricing when you bill your customer for using this data product.
References to authoritative sources such as business definitions, implementations, or tutorials for any element of the contract.
Verified question/answer pairs that give consumers and AI agents context.
Constraints that consumers and AI agents must respect when using the data.
Restricts the allowed values of a property. Use one row per accepted value.
Alternative names for a schema or a property. Leave Property blank when referring to a schema.
Use this optional sheet to define additional metadata or annotations.
Use the open-source Data Contract CLI to convert the Excel template to or from YAML.
datacontract import --format excel --source odcs.xlsx
Upload the Excel directly to Entropy Data using the “Import Excel” feature, and open existing ODCS data contracts in Excel using the "Open in Excel" feature.
Created by Jochen Christ and Dr. Simon Harrer under MIT License