Versions Compared

Key

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

Multiexcerpt include macro
macro_uuid9078ada9-7c16-4fe4-af1c-4ddd91c1ebe9
nameSoftware Plan - Advanced
templateDataeJyLjgUAARUAuQ==
pageCommCare Help Site Design Guidance
addpanelfalse

...

The screenshot below displays an example of the case data page. In this example, the data dictionary was used to configure the way the case properties are presented. We can see different data sets represented in different tables, with the black "i" icon, that provides additional information about the case property when hovered over.

...

All properties in the data dictionary show up on CommCareHQ's Case Data page, whether they were saved in Case Management or otherwise. The "---" indicate that no value has been set. Blank means the property has been set to an empty string ("") - often when it's been cleared out deliberately by a user.

Case properties that exist but were not saved using Case Management will show up in an "Unrecognized" category until they're added to the Data Dictionary. The “Unrecognized” category will only show up if Case Property Groups exist in the Data Dictionary.

...

Case Data Export integration with Data Dictionary

Data Dictionary is also integrated with When you create a new Case Data Export. You can use Data Dictionary of a case type to create a new Case Data Export configuration for that case type. As per this functionality, you can see the option “Export Case Data“ on Data Dictionary of case type .

...

Upon clicking on this button, you will be redirected on to the Case Data Export configuration of the case type with prepopulated case properties defined on the data dictionary along with apps and other sources.

...

image-20240626-104621.pngImage Removed

The newly created Case Data Export configuration contains for a specific case type, the Case Data Export configuration may contain a new tag for certain case properties. This tag specifies the name of the ‘Group' of the case property which was defined on the Data Dictionary of the case type. If a case property is not associated with a case property group in Data Dictionary, then this tag will be empty for that case property.

...

3. Import the file: Select the file and select the "upload data dictionary" option. After the import is completed, CommCare will display a message about the import. 

...

  • If an invalid case property name or case type name is included in the import spreadsheet, appropriate error messages will be displayed until all issues are resolved. You can refer to the screenshot below for an example.

4. Check the updated definitions: On the left menu, click the Data Dictionary option to view the updated definitions.

...

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#EAE6FF

There are certain criterias to the name of case-types and case properties,

  • In Data Dictionary, CommCare doesn't allow special characters in the names of case-types and their case-properties.  It can only start with a letter, and only contain letters, numbers, hyphens, and underscores. 

  • In case of invalid names of case-types and case-properties, CommCare will show an error :

    b8da86df-bdb1-4bb2-9473-ce3ec18057bc.png

     

    25a30398-5ee8-44ab-b104-513a417656a2.png