Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents

About the Feature

The Data Dictionary provides a method for documenting case properties by grouping them and adding descriptions and labels. By doing so, it is easier to visualize and contextualize the property within the context of the case.

...

2) Choose the Data Dictionary option in on the left menu of the Data Page

...

View Descriptions in the Form Builder

Hover your mouse cursor over the case properties in the App properties section of the form builder to view the case property definition as saved in the Data Dictionary.

...

If the case property is referenced in the form question, the description can also be viewed by hovering the mouse cursor over the property.

View Descriptions in the Application Summary

...

Data Dictionary in Linked Project Spaces 

It is It’s possible to synchronize the Data Dictionary across linked domains. In addition, an An upstream domain with the Data Dictionary privilege may push its case type definitions to a downstream domain without the privilege. This scenario will result in the a downstream domain without the privilege of having which does not have access to the synchronized Data Dictionary definitions, but not to any Data Dictionary UI components, including the Data Dictionary admin (Admin page and app builder labelsApp builder functions) having access to synchronized data dictionary definitions.

Managing the Data Dictionary

...

  • In the sheet corresponding to the Case Type, you will find the following columns corresponding to Case Properties:

    • Label: the label of the property

    • Group: the property group, CommCare creates a new data dictionary property group and associates it with the Case Property;

    • Description: for a more detailed description of the property, it is useful to include validations, expected values, or relationships with other properties. 

    • Deprecated: accepts TRUE if the property is deprecated, FALSE otherwise.

An Excel file exported from the data dictionary is shown below. As there are no descriptions or groups in the data dictionary, the columns appear empty, and the label duplicates the property name.  There There are tabs for each for each case type within the project space. 


Import Data Dictionary Definitions

...