Names of organisations, users, people and teams are frequently used in either document or configuration within the system. This page gives a quick overview of how to use names within the application and when tagging documents.
Where Are Names Stored?
Names are stored on the master data record of an entity, the ods record.
Organisations and teams have a single name field and short name field.
Person records have multiple name fields, depending on your configuration, including first name and last name.
How Do I Make Sure I Am Using the Correct Name Tag?
What is The Context?
If you are tagging documents use the document template tag browser to add in your tags. As data context is provided on the template configuration this will give you the correct tags for your document.
This table summarised other places where you may need to think about the context of data
| Common Query | Context | Example |
|---|---|---|
I want to find the tag for a participant on a work type |
Work Type (Modeller > Work Type Modeller > Work Type Name > Data Composer) | workitem.roles.client.ods.name |
| I want to created a calculated field on a ods entity type e.g. greeting based on ods type e.g. Dear Sirs / Dear Mrs Johnson | ODS Entity (Modeller >Participant Type Modeller> ODS Data Composer) | workitem.roles.client.ods.name |
| I want to display the name of a document recipient | Document Template (Admin > Documents > Document Templates > Your Template > Tag Browser) |
document.recipient.ods.name
|
| Adding a tag for a document | Document Template (Admin > Documents > Document Templates > Your Template > Tag Browser) | Use the tag browser on the document template as this will provide you with the correct context |
Which Name Field Should I Use?
In general use the role.name tag for your display name for example workitem.roles.client.ods.name shows the display name for a client on a work item.
Using the display names means that you don't have to know if the entity is a person / organisation etc.
If you want to use specific elements of a name e.g. the first name for a person entity then go to the specific 'person' data element this then gives you the granular breakdown of names
e.g.
workitem.roles.client.person.firstName
If the name is not shown in the right format for your organisation you have the option to create a calculated field which will format the names in the right format for your organisation.