Overview

Annotations are a collaborative tool that enables users to add notes and responses directly to specific fields within a record. By using field-level annotations, users can modify particular fields and respond to comments without altering the rest of the record. This article will guide you through utilizing and configuring the annotation collaboration feature as part of an application review process.

Note:

You must be a Global Administrator to configure this feature.
The interface and recommended configuration practices for the annotations feature have been updated as part of the July 2024 upgrade.
You can only edit the values of a single field at a time using the annotations feature. Validation will only run on the field being modified. Therefore, if you are using dynamic field visibility controls or need to run full validation on the entire form, you may need to exit annotation mode and go to an unlocked status to achieve this.

How Annotations Work

Let's walk through how the annotation feature can be configured as part of an application process involving an applicant, a program manager, and a reviewer.

1. Applicant Submits Application

The applicant enters the required information into a form and submits it.

2. Program Manager Assigns a Reviewer

The program manager assigns a reviewer to the application and advances the application to the next stage.

3. Reviewer Conducts Initial Review and Creates Annotations

The reviewer is notified of their assignment to review the application. In this scenario, the application is not yet ready to be approved or rejected, prompting the reviewer to make field-level suggestions (annotations) for changes or clarifications. The reviewer hovers over and left-clicks the desired field to open a new annotation window. Here, they enter a message asking the applicant to change or clarify something related to this field, and then the reviewer saves the annotation.

(Insert Image: Show new Annotation window)

This process is repeated for all fields requiring changes or clarifications. Once all annotations are added, the reviewer clicks the annotation submission button to send the record back to the applicant.

(Show annotation submission button in annotation mode)

4. Applicant Reviews Annotations, Modifies Values, and Adds Clarifications

The applicant is notified that action is required on their application. The applicant navigates to their application, which opens in Annotation Mode. In Annotation Mode, fields without annotations are locked. The applicant sees a list of annotations in the right panel and can click on any annotation to engage in a specific field-level discussion.

(Insert Image: Show annotation list)

When focused on an annotation, the applicant can click the Reply button to open a modal window, where they can modify the field value and add a clarifying message.

(Insert Image: Show reply button when drilled into an annotation)

Annotations from other users (such as the reviewer) are highlighted in yellow, indicating they may require a response, while annotations you create (as an applicant) are highlighted in blue.

(Show drilled into an annotation with blue and yellow messages)

After responding and modifying field values, the applicant clicks the annotation submission button to move the status forward, triggering a workflow that notifies the reviewer of the changes made.

5. Reviewer Conducts a Subsequent Review and Marks Annotations as Resolved

The reviewer is notified that action is required and navigates to the application. The reviewer evaluates the changes and the applicant's replies. If no further changes or clarifications are needed, the reviewer marks each field-level annotation as resolved.

(Insert Image: Show resolved button on drilled into annotation)

Resolved annotations are indicated with a green check mark, showing no further action is required.

(Insert Image: Show annotation list with an Item marked as resolved)

If all outstanding changes are addressed, the reviewer advances the application using the annotation submission button.

6. Exiting Annotation Mode

Users can exit annotation mode by clicking the close icon (“X”) in the gray box. This may be necessary to access the left navigation or other record-related elements not visible in annotation mode. To re-enter annotation mode, click the "annotation mode" toggle located in the high availability area at the top right of the record.

(Insert Image: Show picture of X to close)

(Insert Image: Show picture of annotation mode toggle)

Configuration

text

Template:Annotation Mode