Create entity fields
Entity fields are properties, or attributes, of an entity. For example, the evidence entity can have fields for description, serial number, and storage location.
When reviewers create data records associated with an entity, called entity items, the entity fields determine what data the reviewers can enter about the entity item.
You determine what fields to add to an entity based on the data that you want to track or analyze for the entity. Each entity can include a different set of fields.
When you create an entity, the application automatically adds default fields to the entity, such as Name and ID.
Entity fields are standard application field types, such as date fields, text fields, and pick lists. For more information about field types, see Field types.
Add fields to an entity
To add fields to an entity:
To access the entities in a data model, do the following:
On the Case Home page, under Case Setup, click Data Models.
Click the name of a data model.
Click the name of an entity.
In the navigation pane, click Fields.
Click Add.
In the Type list, select the field type.
Type a unique Name for the field.
Note: In the List pane on the Documents page, reviewers can display fields that belong to an entity and that belong to connected entities at the same time. Because of this, consider using a field name that allows reviewers to understand which entity the field belongs to, especially if multiple connected entities contain similar fields. For example, include the name of the entity in the field name.
If the field can have more than one value per entity item, clear the One-to-one check box.
Note: The One-to-one setting is mandatory for Yes/No fields.
Click Save.
If you added a pick list field, add items to the field. Do the following:
Click the name of the pick list field.
In the navigation pane, click Items, and then do the following:
Click Add.
Type a Name for the item.
Click Save.
Repeat the previous steps to add additional items to the pick list.
Set the security for the field. For more information, see Set security for entity fields.
Repeat the previous steps to add additional fields to the entity.
To allow reviewers to view and code the fields on the Documents page, add the fields to a coding template and a column template. For more information, see Create coding templates for entities and Create column templates for entities.
Set security for entity fields
Administrators can set the security for entity fields.
By default, the security setting for new entity fields is set to Allow for the group in which you create the field.
To set security for entity fields:
To access the fields associated with an entity, do the following:
On the Case Home page, under Case Setup, click Data Models.
Click the name of the data model that the entity belongs to.
Note: When an entity exists in multiple data models, the entity's security settings are the same in every data model that the entity belongs to.
Click the name of the entity.
In the navigation pane, click Fields.
Click the name of a field.
In the navigation pane, click Security.
Depending on which groups you want to set security for, do the following:
To change the security for a user group, hover over the row for the group, and then select an option.
To change the security for all user groups, select an option in the heading row. Then click OK.
The following security settings are available.
Permission |
Description |
Deny |
Denies the group access to the field. |
Allow |
Allows the group access to the field. |
Write |
Allows the group to edit the field. |
Next steps
After you create fields for an entity and set security for the fields, add the fields to a coding template for the entity. For more information, see Create coding templates for entities.