Create a New Model

1. Within Models of the Control Hub.

2. Select Create New Model.

Business Area

1. Select a business area from the drop down.

   • Business areas are a way of grouping data models.

Or

1. Select + Create New.

2. Enter a name for the new Business Area.

   • To go back to the dropdown select cancel.

Details

1. Enter the a unique ID for the model within ID.

   • This must be lowercase and be letters only.

2. Enter a user friendly name for the model within Display Name.

3. Enter a short description for the model within Description.

4. Enter a hex code colour within Default Colour.

   • This will help distinguish between different models.

5. Enter a file name within Default Icon.

   • The icon needs to be within the custom icons directory.

   • The icon directory is defined in app settings.

6. Select the model type from Standard, Map or Sub Model.

   • Standard

     1. Check Applies to Files to have any property mappings added to file indices.

     2. Check Applies to Collection to have any property mappings added to file collections.

   • Map

     1. Check Root Level Model to indicate the top most level of a data map.

   • Sub Model

     1. Select the related model from the dropdown.

     General - No predefined attributes and is used to nest repeated data with a parent model.

     Event - Presents data in a timeline. By default this includes 6 required attributes they can be renamed and added to.

     Linking - Used to link records and required for Network Diagrams. This includes 4 required attributes, they can be renamed or added to.

Attributes

Create and add the attributes to the model.

1. Add a Unique ID for the model attribute.

   • This must be lowercase and be letters only.

2. Enter a user friendly name for the model within Display Name.

3. Select a Data Type for this attribute from the dropdown.

4. Link attributes to other data models by selecting the Model from the Link to: Model dropdown.

   • This enables data navigation features within the app.

5. Enter the user groups that can see this attribute.

6. Add Notes to the attribute to describe the attribute.

• Check Required if the attribute field is mandatory.

• Check Multivalue if this attribute can have multiple values.

• Check Searchable as Text to show a text field below for full-text search.

• Check Visible to show the attribute in the front end.

• Check Document Link if this attribute is linked to an entity used to show matching documents.

Display

1. Enter the Number of Visible Data Properties that show per data result on page load.

2. Check Show Hit Highlights to Highlight content in the search results.

   • Hit highlights will highlight the terms from your search that match your results.

3. Check Show text on details page to view surface this information within the Details view.

Summary

Review all of the settings within the summary tab before saving.

Please Note - Once you have published a model you can't edit existing attributes