The Reference Data definition template in Excel format helps you to define and manage the reference data definitions and mappings of attribute properties across all domains mastered in the application.
Worksheets in Reference Data Model Template
The template allows you to define your data model using different worksheets in the template.
| Worksheets | Description |
|---|---|
| Reference Metadata | You can select whether to load or import the specific reference data model details to the application or not in this worksheet. |
| Reference Entities | You can manage the entity definitions and properties such as city, color and so on in this worksheet. |
| Reference Entities Locale | You can manage reference entity definitions across different locales in this worksheet. |
| Reference Attributes Locale | You can manage the reference attribute definitions across different locales in this worksheet. |
| Reference Relationships | You can manage the mappings of reference data's relationship name with relationship type in this worksheet. |
| Reference Relationships Locale | You can manage the reference data's relationship definitions across different locales in this worksheet. |
| Reference E-A-R Model | You can manage the mappings of reference data with its relationship name, mapped attribute, and mapped relationships in this worksheet. |
| Reference E-C Model | You can manage the mappings for entities to different contexts and context types in this worksheet. |
| Variant model | You can define and manage the entity variants of Reference Data domain. |
Sample Model Sheet
A sample Reference Data Model is attached here.
For more details, see Reference Data Domain Model.
Map reference attributes via Reference Data Model:
To map a reference attribute via reference data model:
- On the navigation menu, click on Configurations > Thing Data Domain Model.
Result: The Reference Data Domain Model page is displayed.
- In the Upload or Download Reference Data Domain Model widget, click the Download button.
Result: The Download Model page is displayed.
-
Expand the Select Entity Types accordion and perform any of the following.
a. Click ">>" to move the values in batches of 100 from the Available column to the Selected column.
b. Click ">" to move the selected values from the Available column to the Selected column.
c. Click "<" to move the selected values from the Selected column to the Available column.
d. Click "<<" to move all the values from the Selected column to the Available column.
You can also choose the required Locales, Attributes, and Relationships.
- Click Download All to download the model file.
Result: A confirmation message is displayed along with the Finish & Close and Show task details buttons.
5. Open the downloaded Excel file and click the Entities sheet.
Result: All the reference entities are displayed here.
Do not modify the out-of-the-box reference entities and attributes.
- Click Attributes sheet to view the reference attributes.
You must not modify these attributes.
- Click the Relationships sheet, all the relationships between reference entities are displayed.
-
Click E-A-R sheet and map the reference entity types to reference attributes. Then, Save the excel file.
- For the documentlist entity type, you can map attributes such as referencedatacode, referencedatavalue, isrequireddocument, and isrequiredexpirationdate.
- On the Reference Data Domain Model page, upload the updated Reference Data Model by dragging or dropping the file or click the Upload button in the Upload or Download Reference Data Domain Model widget.
- Click on Show task details.
Result: The Base Data Model Import task is displayed.
To validate the attributes,
- On the Thing Data Domain Model page, click the Refresh icon on the summary model widget.
- Click on View Details link corresponding to the entity type.
Result: The Search page displays a list of all the attributes.
