About the metadata profile (MDP)
Why do I need this?
Metadata profile (MDP) is a set of configurations that you use to adapt the data.world UI for your business needs.
The out-of-the-box UI includes only the most basic metadata fields for resources. For example, a business term in the glossary has the following default metadata fields out of the box:
As an example, you would use the MDP to add a Status field to the business terms. This field is configured to allow only one Status value to be selected from the accompanying single-select list.
Important
Everything required to render resource metadata must be stated in the MDP file.
If certain metadata is present in your catalog graph but it is not defined in the MDP, it won’t show up in the UI.
If you remove sections from the MDP, those presentations will be removed from the UI, even if there is underlying metadata.
What does it let me do?
You can use the MDP to customize and configure your application user interface. A comprehensive list of what you can do using the MDP, is available here
You can also refer this demo.ttl file with sample configurations.
In this section, we will walk you through the process of doing some common tasks with MDP.
Task | Details |
|---|---|
Add custom sections on the resource pages to highlight key information on these pages. | |
Tailor the metadata fields of your catalog to your unique use case. Add different type of custom fields to the out-of-the-box and custom sections of resource pages. | |
Apply custom status to the various resources to indicate to users of data if what they are looking at is approved, rejected, deprecated, etc. | |
Catalog the various types of resources your organization has. | |
Extend the system by adding custom resources. | |
Add custom relationships between resources. |
How do I do it?
The MDP is a graph file written in Turtle syntax. You add it to the catalog configuration dataset, ddw-catalogs.
Catalog configuration dataset (ddw-catalogs)
This is a special dataset within data.world that manages the organizations catalog graph and configuration files. It drives all metadata files for your org, including:
The metadata profile (MDP)
Cataloged resources (DWCC outputs)
The business glossary
Important
Who should have access?
The ddw-catalogs repository is intended to be strictly admin-only. The ability to make edits to the MDP should be limited. Improper edits to the files in this dataset can cause unintended changes to the catalog.
Edit the MDP
Make your desired changes to the graph configuration file and upload it to ddw-catalogs, replacing the previous file if there is one. The following sections of this guide will teach you how to perform those steps.
Important
Everything required to render resource metadata in the UI must be stated in the MDP file.
If certain metadata is present in your catalog graph but it is not defined in the MDP, it won’t show up in the UI.
If you remove sections from the MDP, those presentations will be removed from the UI, even if there is underlying metadata in the catalog graph.