Modelling your data
There a 4 types of settings which must be defined for a Model or Sub Model:
Business Area - A required value which represents a parent grouping for the model, this is purely for reconciling the model with its business function and serves for your understanding of how you've organised your data. e.g. Finance
Details - Describes the model and what is presented within Workplace AI e.g. Invoice with an invoice icon
Attributes - Defines the data values (attributes) within the model, each attribute can have a distinct data type and link to other models e.g. Organisation, Line Item, Paid status (Attributes which are grouped/associated with a business area)
Display - Defines how the model is presented throughout Workplace AI
You can create a model and edit it later. To start create a new model
Details
ID - Enter a unique ID for the model. (This must be lowercase and letters only. e.g.invoice)
Display Name - Enter a user friendly name that users will recognise e.g. Invoice
Description - Enter a short description. (This is only visible within Control Hub)
Default Colour - To have the data model name and its attributes themed with a colour on your results select from the pre-defined palette.
Default Icon - To use a custom icon enter a file name. The icon needs to be within the custom icons directory which is defined in app settings.
Model Type - Select Standard, Sub Model or Message. For each model type there are nested options
Standard - Used for top level objects e.g. Invoice or Person
Applies to Files - Property mappings will be added to the indexes which store the data
Applies to Collection - Property mappings will be added to Collections
Applies to Users - Property mappings will be added to User settings
Sub Model - Used for repeated sub data e.g. Invoice > Line items or Person > Employment history
General - This doesn't come with any predefined attributes and is used to nest repeated data within a parent model.
Event - For use within the event timeline visualisation
Linking - Used to link records and required to support the Network Diagram, by default includes 4 required attributes. These attributes can be renamed and supplemented with additional attributes.
Message - Used for the Teams and Slack connectors
Triggers the message display (not usable unless you use a message data like Teams or Slack) Initial number of messages to load either side of the selected message when previewing. This setting will also control how many messages are retrieved per page when loading more in preview.
Attributes
A model can have many attributes for instance a PO may have the authorisation code, each attribute must be defined within the model
If you are updating to Primo you will need to update your Geo-points attributes to work on the map lens.
Attribute ID - Add a Unique ID for the model attribute. (This must be lowercase letters only.)
Display Name - Enter a user friendly name for the model.
Data Type - Select a Data Type for this attribute from the dropdown. Defines how you want to search or use the field (list the use case for all
Keyword - Exact match string Keyword (enables data navigation) - can be linked all others can't be lined stuff that you want to match exactly e.g. Invoice Type. Stuff that you can search for but can be linked as a whole - categorical that you want to match exactly
Link to: Model - Link attributes to other data models by selecting the Model from the dropdown. This enables data navigation features within the app. PO field and Customer data model (11:11 timestamp)
Long - For bigger numbers 64bit integer value from > to (gpt what is the range of a signed 64bit integer) e.g. Number of units
Float - Stores a single precision (decimal) floating point number
Double - Stores a double precision (decimal) floating point number which is more precise than (float). Use this over float unless you have a reason not to. e.g. Invoice total
Date Time - Date & time string with optional timezone
Address - Dedicated sub model that handles address line 1, street, city/county
Geopoint - Latitude and Longitude
Text - Free text field e.g. Long form text in a doc or a whole doc (multiword descriptive thing) that you want to search the copy within long form thing you want to search within
Boolean - True False
User - Keyword which matches a user in the system
URI - Keyword which renders as a clickable link
Submodel - For nested data - choose from a pre-defined sub model you wish to be nested in this model e.g. Line item submodel within an Invoice model
Permissions - Enter the user groups that can see this attribute. If your data item says HR can see this data, certain attributes can be hidden from all else if user groups are opted into.
Notes - Your own personal notes about the purpose of the attribute, will not be displayed within the system anywhere else.
Checkboxes (some change if sub model is selected) List the full list here and explain which type that they apply to (e.g. only applies to Geopoint and Keyword)
Required - Check if the attribute field is mandatory. If selected Workplace AI will enforce that this attribute being present when trying to ingest data using this model.
Multi-value - Check if this attribute can have multiple values. e.g. a list of Product codes on an Invoice
Surface on Map - Check this box to display this data record using this geopoint location on the map visualisation.
Surface on Timeline - Check this box to display this data record using this datetime on the Timeline visualisation.
Searchable as Text - Check this to make this attribute full text searchable e.g. query by part of an Organisation name within the Invoice
Visible - Check this to show the attribute in the front end. Leave unchecked if the attribute should not be presented to users.
Document Link - Check this if this attribute is linked to an entity used to show matching unstructured data.
Not exportable - Check this to restrict users including this attribute in exports from the system
Exclude from comparison - Check this to stop Workplace AI from seeing this attribute change represent a new version
Display
How should the data model be displayed within the user app
Enter the Number of Visible Data attributes should show per data result on page load.
Controls the default display but consider how the presentation correlates to the data type e.g. invoice
Controls hit highligting on the item Check Show Hit Highlights to Highlight content in the search results.
Hit highlights will highlight the terms from your search that match your results.
Check Show text on details page to view surface this information within the Details view. Decides whether people can export it for an onward journey
Upon creation of a model it is stored in an unpublished state. Once a model has been published, it's not possible to delete, edit the name of or change the data type of attributes within the model.
Last updated