17.4 Adding review comments

Reviewers can make their comments directly from the Review page itself by clicking on   View/Change  |  Respond to Review   or from an action in the Tasks In column (see section 15.4.3.1 - Tasks in) on the review or one of the documents associated with it. For a review with which a set of reviewers has been associated, anyone listed as a reviewer will see a task in their Tasks In column for each document in the review. For an Open Distribution (see section 17.8 - Open Distribution), every member of the folder will see a task in their Tasks In column for the review and beside each document in the review.

The page where responses are made is very similar to the Review page (see Figure 17.2-3) but the Responses section of the page is replaced with a set of boxes via which responses can be entered. The specific format of these boxes - text box, drop-down list, checkbox etc. is determined by the field sets used by the issue type set on this review. An example of a Respond to Review page is shown in Figure 17.4-1. Note how much simpler than a comparable Respond to Issue page this is since the issue comments are per document per user and the review comments are simply per user.

Figure 17.4-1: The Respond to Review page

Clicking on "Save Comments" saves your comments but does not make them visible to other users. You will be able to see your own comments at the bottom of the Review page, in the Responses section. (For an Open Distribution, a new row will appear in this section of the Review page to show that a user has made comments without submitting them.) Any saved, but not yet submitted, comments can later be edited. Saving your comments does not complete your task and so the task remains in your Tasks In column.

Clicking on "Submit Comments" saves your comments and makes them visible to other users. The entry in the Complete column of the Responses section of the Review page will change to "Yes" for this user. Submitting your comments also automatically completes your task and so any tasks related to this review disappear from your Tasks In column. If all nominated reviewers in a Closed Distribution have completed their tasks, the status of the relevant tasks in the Tasks Out column for the person who created the review will change to for Completion.

An individual user has therefore completed their tasks for a review as soon as they have Submitted their comments on the review. As there are not multiple documents on which they could be commenting, there is no need to have an additional explicit Complete Review action for each reviewer in the way that there is for an issue - see section 15.4.5 - Completing an issue.

There is no equivalent for reviewing to the which indicates that a document has been issued. Similarly, the Issue History (see section 15.6.2 - Issue History ) and Document Distribution History (see section 15.5.2 Document Distribution History) of the documents are completely unaffected by reviewing. Making review comments leads to a had comments added event on the review itself. No events related to reviewing appear in the event history of the documents under review.