Data Field Details

The details page for a Data Field gives you everything you need to know about the Data Field all in one place.

../../_images/data_fields_overview.png

Title

The title section contains the name of the Field (in this example the field name is channel), the points of contact and location of the field, as well as the button required to edit the data field. If your Field has been connected and you have the ability to view data within this data store then you will see a badge indicating that you are connected.

../../_images/data_fields_title_connected.png

When you are viewing a Data Field that has not been connected to Tree Schema or if you do not have permissions or if the existing connection is no longer valid (e.g. password change) then you will see the title without the connected badge:

../../_images/data_fields_title_not_connected.png

README

../../_images/data_field_readme.png

The Data Field README is the perfect place to document all of the information about this field. Use this along with the Value Definitions below to not only capture information about the field but to also define and describe the specific values that may exist within the field.

Field Details

The field details list the following information:

  • Field type

    • Tree Schema determines this field on your behalf based on how the field was created, it will always be one of the following: scalar, list, object

  • Data type

    • This value is a JSON compatible data type

  • Data format

    • This field always contains the format that you provided, it is a free-form field

  • Nullable

    • Whether or not the field can be null

For more information on field types, data types and data formats see Understanding Data Types & Formats for more details.


Tags

Tags are a great way to add quick labels to your data store. Later on, in the Tags section, we will see how you view all of your tagged items in a single place.

../../_images/data_field_tags.png

Details

The Details section of the Data Field contains everything about how your field fits into your overall data ecosystem. Each of the sections below represents a tab that may be available to your Data Field if applicable.

Value Definitions

This tab shows all of the sample values that have been defined for your field and it enables you to document information specific to each sample value. This is a great place to capture the meaning for specific values or to allow your users to provide details about why certain values exist in the database.

When you automatically create fields directly from the Data Store Tree Schema attempts to create these values on your behalf, you can also add or remove field values at any time.

../../_images/data_field_values.png

Full Schema

Shows this field relative to the other fields within the schema and highlights the field in the JSON view to give you a quick reference of how this field sits in the overall schema.

../../_images/data_field_schema_one.png

If the field is an array or an object then all sub-objects and values are highlighted as well.

../../_images/data_field_schema_two.png

Governance

Any outstanding governance actions for this Data Field. If you are the Steward for this Field you will be able to mark them as completed or dismissed.

../../_images/data_field_governance.png

Comments

You can add, edit or reply to comments for your Data Field. This is a good way to have conversations about your data, with your data and to enable others in the future to gain from the knowledge shared about this specific field.

../../_images/data_field_comments.png

Experts

Find out who is knowledgeable about this field and streamline the communication process to directly get in touch with that person. There are two types of experts in Tree Schema:

  1. Power Users: the users that use this Data Field the most often.

  2. Volunteer SMEs: the users who raise their hands and volunteer as experts

../../_images/data_field_experts.png

Lineage

Lineage tracks the relationships between fields and displays those relationships as they exist within Data Schemas and Data Stores. Lineage provides you a way to interact and ask questions to your data, such as “Where does this field come from?” or “Is this field saved with the other NPI / PII data?”.

When you view the lineage from a field it initially only loads the linege that either goes into or out of the field.

../../_images/data_field_lineage.png

To learn more about how to use lineage, visit the Lineae and Exploration page.