Skip to content

datacontract/open-data-contract-standard-excel-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Open Data Contract Standard (ODCS) - Excel Template

This repository contains an Excel template for authoring data contracts using the Open Data Contract Standard V3. 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 Data Mesh Manager.

image

📥 Template

Download the Excel Template:

💡 Example

Here is an example Data Contract:

🧾 What is a Data Contract?

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.

📄 Template Overview

The Excel file includes the following sheets:

1. Instructions

Provides a quick guide on how to fill out the template.

2. Fundamentals

Captures general metadata for the data contract, including ID, Name, Version, Domain and Description.

3. Schema <table_name>

Defines the data model with all properties.

Copy this sheet for every table in your data contract.

4. Support

Support and communication channels help consumers find help regarding their use of the data contract.

5. Team

This section lists team members and the history of their relation with this data contract. In v2.x, this section was called stakeholders.

6. Roles

This section lists team members and the history of their relation with this data contract.

7. SLA

This section describes the service-level agreements (SLA).

8. Servers

The servers element describes where the data protected by this data contract is physically located.

9. Pricing

This section covers pricing when you bill your customer for using this data product.

10. Custom Properties

Use this optional sheet to define additional metadata or annotations.

🚀 Integrations

Data Contract CLI

Use the open-source Data Contract CLI to convert the Excel template to or from YAML.

datacontract import --format excel --source odcs.xlsx

Data Mesh Manager

Upload the Excel directly in Data Mesh Manager using the “Import Excel” feature, and open existing ODCS data contracts in Excel using the "Open in Excel" feature.

image

📜 License

Created by Jochen Christ and Dr. Simon Harrer under MIT License

About

Edit Open Data Contract Standard in Excel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published