...
Data Dictionary provides a method for documenting case properties by grouping them, adding descriptions, labels , and the expected data type. By doing so, it is easier to visualize and contextualize the property within the context of the case.
The documentation of case properties will aid in understanding their purpose and possible behaviour, facilitating collaboration, troubleshooting , and maintenance.
The Data Dictionary Administration Page
The Data Dictionary administration page provides access to all items in the Data Dictionary. Thus, all All case types and properties are readily accessible , as well as including the following features:
Importing and exporting case type definitions.
Deprecating and adding case properties.
Deprecating and adding case property groups.
Deprecating and adding case types.
...
Name of the case type.
Options for exporting and importing definitions to Excel.
Deprecated case properties can be displayed button that displays deprecated properties for the current case type, by default, they are not displayed. The default display conditions do not show the deprecated case properties.
Each property includes the data type, label, description, valid values, formats , and the option to archive the case property.
An option to add a new case property and define it.
The ability to add a new group of case properties group.
Data Dictionary during Application Building
View Descriptions in the Form Builder
Position Hover your mouse over the case properties in the App properties section of the form builder , and you can see the definitions of the case properties contained 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 over the property.
...
Upon selecting the case summary, each property in the case will be displayed along with its description underneath.
View and Add Descriptions when saving a Property to the Case
When a case property contains a description, it will be displayed just 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.
...
Any time a new application is created, or a question-to-property mapping is saved in the Case Management of a form, the Data Dictionary is automatically updated to reflect the latest case types and property mappings.
Manually Add New Case Properties to the Data Dictionary
A new case property can be added to a case type in the Data Dictionary in two different ways:
- 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 case properties in small batches
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
The Case Property Group can be used to group case properties. To manage which properties are associated with the Case Property Group, drag and drop case properties into or out of the group. To complete the process, click the button at the top right of the page.
...