Conceptual Data Mapping#

What is a conceptual data mapping document?

A conceptual data mapping document is a type of data specification that helps developers reason about data translation choices when mapping between OpenUSD and another data format. The document enables effective discourse when asking for feedback from the OpenUSD community, it helps quantify the types of features that can be supported between the two formats, and it can bring to light data mapping gaps that could be good candidates for new schemas.

The document can also serve as a software design document for data mapping implementations. Teams benefit from using it early to communicate USD export and import requirements and expectations before any coding begins. By reaching understanding and agreement before implementation, it can save costly iterations and confusion during implementation. While both official and unofficial implementations are allowed to deviate from the conceptual data mapping document, documenting these deviations in reference to the conceptual data mapping document fosters a shared understanding among stakeholders.

A conceptual data mapping document is a living document. Stakeholders should strive to keep their conceptual data mapping document up-to-date with:

  1. Changes to the source data format.

  2. Changes to OpenUSD.

  3. Changes to an official data mapping implementation.

Resources

To help developers create their own conceptual mapping document, we provide some best practices and resources to get started:

  • General guidance for creating a conceptual data mapping document.

    • In this section, you will find essential tips and best practices for crafting an effective conceptual data mapping document.

  • A conceptual data mapping template.

    • This section presents a structured template that developers can copy to create their own data mapping document. The template serves as a starting point, providing predefined sections and prompts to guide you through the process of documenting your data mapping choices and strategies.

  • A brief example data mapping document for glTF

    • To further illustrate how to adapt the template and apply it in practice, this section includes a brief example data mapping document for translating data from the glTF format.