...
3) You will be directed to the Data Dictionary page, similar to the image below
The left-hand menu shows all the case types in the domain and highlights the definition of each.
...
When a case property contains a description, it will be displayed beneath the name of the property. If that description is updated, it will be reflected in the data dictionary as well. Each time a new property is added to the case, it will be added to the data dictionary. In the event that the description of a property is updated, the update will also be reflected in the data dictionary.
Data Dictionary in Linked Project Spaces
...
- Firstly, this can be accomplished by adding new rows to the exported Excel file and then importing this file into the Data Dictionary.
- The second option is to fill in the text box next to the "Add Case Property" button at the bottom of the page (see the below image), and then click "Add Case Property" to create a new entry. After creating all your case properties in this manner, click the button
.png?version=3&modificationDate=1688150190676&cacheVersion=1&api=v2&width=45)
to complete the process.- It is advised to create and save case properties in small batches
- If an error is made during the process , simply refresh the page and the unsaved changes will be removed.
Add Case Property Group
Case properties can be grouped using the Case Property Group. You can manage which case properties are associated with the Case Property Group by dragging and dropping them into or out of it. Click the button at the top right of the page to complete the process.
Add/Remove Properties to the Case Property Group
...
In Data Dictionary, it is possible to export case property definitions for the current case type to Excel. This can be accomplished by selecting Export to Excel.
Upon export, an Excel file will appear as follows:
...
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. Excel sheets were created for each type of case, and sheets with the suffix "-vl" will be created for each type. While the sheet with the property name describes each case property, the sheet with the suffix "-vl" describes each property that has multiple-choice data.
Import Data Dictionary Definitions
Data dictionary definitions can be downloaded to Excel, updated, and then imported back into CommcareCommCare. With this process, data dictionary definitions can be shared among different stakeholders, improving updates and accuracy. Furthermore, it allows for efficient changes to be made and keeps the application and data dictionary up-to-date.
...
1) The first step is to initiate the import process. Select the Import from Excel option.
2) Prepare the file to import: CommCare will show a page for importing the Excel file, which includes the option for downloading the data dictionary definition since it is always a good idea to download the definition first. Here is an example of a file definition we are using for the same file that we downloaded from the export data definitions step. A new property will be added to the file definition by adding a new line.
...
Here is an example of an Excel file definition for a patient case type, each row has the case property and each column contains the property's details.
As shown in the image below, the Excel sheet patient-vl displays all properties of the patient case type marked as multichoice.
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.
...
4) Check the updated definitions: On the left menu, click the Data Dictionary option to view the updated definitions.
FAQ
Can I import only the case properties definitions?
Commcare expects the Excel document to have two sheets, one with the case property and the other with the case property and the suffix vl. In the Excel file below, a sheet named person-vl was expected, but it wasn't found, resulting in an error message "Missing valid "household-vl" multi-choice sheet for case type household".
