Create coding templates for entities
An entity coding template is a list of the fields that you want reviewers to code for each entity item. Reviewers code values when they add records for new entity items. Reviewers can also update the values for existing entity items.
When you create an entity, the application creates a coding template that includes the default fields for the entity. If you add additional fields to an entity and want to allow reviewers to code the fields, you must add the fields to a coding template.
The coding templates for an entity appear in the Conditional Coding pane on the Documents page.
Note: Reviewers can edit the values of some fields directly in the List pane. For information about how to configure which fields appear as columns in the List pane, see Create column templates for entities.
About entity coding templates
Coding templates for entities are similar to conditional coding templates for documents.
In an entity coding template, the value that is coded to one item determines which additional items should be coded. As reviewers code each item in an entity coding template, the colors of the remaining items change to indicate which items must still be coded. The relationship between the value that is coded in one item and the additional items that should be coded is called a condition.
For example, say that the custodian entity includes fields for custodian name and collection status. If a reviewer codes the custodian name field with a person's name, you want the reviewer to also code the collection status field with a yes or no value. To implement this in the application, you create a condition based on the value that is coded for the custodian name field.
Create or modify an entity coding template
You can edit the coding templates that are created by the application, create new coding templates, or copy and then modify existing coding templates.
An entity coding template provides visual cues that help reviewers know what fields they are expected to code based on the values that they have already coded.
To help visualize the conditions in an entity coding template, draw a flowchart of the coding workflow that you want reviewers to follow. On the flowchart, list the fields that you want reviewers to code and the possible values for each field. For each possible value, determine which additional fields you want reviewers to code.
To create or modify an entity coding template:
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.
Note: When an entity exists in multiple data models, the entity's coding templates are the same in every data model that the entity belongs to.
Click the name of an entity.
In the navigation pane, click Conditional Templates.
You can create a new coding template or edit the coding template that is created by the application. If you want to create a new coding template, select from the following:
To create a blank coding template:
Click Add.
Type a unique Name for the coding template. Reviewers see this name in the Conditional Coding pane on the Documents page.
Click Save.
To create a copy of an existing coding template:
Click Clone.
In the Conditional template list, select the coding template that you want to copy.
Type a unique Name for the coding template. Reviewers see this name in the Conditional Coding pane on the Documents page.
Click Save.
Click the name of the coding template.
To add a section to the template, click Section label. Type a name for the section, and then press Enter.
To add a field to the template, do the following:
In the Add Field list, select a field to add to the template. Then click the Add field button.
To require reviewers to code the field, select the Required check box.
Tip: Include at least one required field on the entity coding template. After reviewers code all of the fields that are required based on the relevant conditions, a Next button that allows reviewers to navigate to the next entity item appears directly in the Conditional Coding pane. If an entity coding template does not include any required fields, reviewers must use the arrows on the Documents page toolbar to select the next entity item to code.
If the field is a pick list, by default, reviewers must expand the list to select a value. To display all possible values on the coding template, select the Expanded check box.
Note: If a list has many possible values, the coding template may take a long time to load when reviewers move from entity item to entity item. We recommend that you clear the Expanded check box for lists that have many values.
If you want to prevent reviewers from editing the value of a field, select the Read-only check box. For example, you can display reference information to reviewers on a coding template.
Repeat the previous steps to add additional fields to the template.
Note: If you include an entity field on multiple entity coding templates, reviewers can code the field from each template. The value that applies is the most recently coded value.
To add conditions to the template, do the following:
Click Condition.
In the When coding field list, select a field. The value that is coded to this field determines the additional fields that you want reviewers to code.
In the Is set to area, select a value for the field.
In the Code list, select the additional fields that you want reviewers to code.
Click outside the Code list, and then click OK.
Repeat the previous steps to add additional conditions to the template.
To edit the fields that appear on the coding template, do any of the following:
To rearrange fields, hover over a field, and then drag the handle to move a row up or down.
To delete a field or a section label, select the check box next to the item. Click Delete, and then click OK.
Note: If you delete a field that includes a condition, the condition is removed.
To delete a condition, click the condition. Click Delete, and then click Yes.
Set the security for the coding template. For more information, see Set security for entity coding templates.
Set security for entity coding templates
You can set the security for an entity coding template based on user groups. By default, the security setting for a new entity coding template is set to Allow for the group in which you create the template.
To set security for entity coding templates:
To access the coding templates 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 coding templates are the same in every data model that the entity belongs to.
Click the name of the entity.
In the navigation pane, click Conditional Templates.
Click the name of a coding template.
In the navigation pane, click Security.
Depending on which groups you want to set security for, select from the following:
To set security for one 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 entity coding template. |
|
Allow
|
Allows the group access to the entity coding template. |
Rename an entity coding template
To rename a coding template for an entity:
To access the coding templates 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 coding templates are the same in every data model that the entity belongs to.
Click the name of the entity.
In the navigation pane, click Conditional Templates.
Click the name of a coding template.
In the navigation pane, click Properties.
Type a unique Name for the coding template, and then click outside the box.
Next steps
After you create a coding template for an entity, create column templates for the entity. For more information, see Create column templates for entities.