Sections in the Review page
When a participant opens a review that is listed in the Reviews viewlet on the Web client dashboard, the Review page appears with two collapsible sections: the Participant Review and the Overall Review. Participants can switch between the two sections by clicking in the section headers.
In the Participant Review, the participant sees the participant role and the artifacts that comprise the review. The participant views an artifact by clicking on it, which displays the artifact in read only mode. Then, depending on the role assigned to the participant, the participant either approves, marks as reviewed, disapproves, or abstains.
In the Overall Review, the participant sees the artifacts and the participants that comprise the review, but only the creator of the review (or an administrator) can make changes to the review. The creator of the review can change the review by clicking pause and then making changes. The creator can change the participants, their roles, or the artifacts that comprise the review. The creator can even replace the current version of the artifacts in the review with the latest version of the artifacts in the project.
When you add a participant to a review, you assign a role to the participant that determines the actions that are required to complete the review. The following table describes these roles and actions.
Participant Role | Required Action |
---|---|
Approver | This participant must either approve ( ![]() ![]() ![]() |
Reviewer | This participant must either review an artifact
(![]() ![]() |
Optional | This participant can optionally review or abstain from reviewing an artifact; however, the review can move to the Reviewed or Finalized state regardless of what this participant does. |
Lifecycle Review States
Review States | Description |
---|---|
Draft | The initial state of a review in which the creator of the review assigns a due date, adds review instructions, adds participants, assigns roles to participants, and adds artifacts to the review. Participants are not notified when the review is in the draft state. |
In Progress | When the creator of the review clicks the Start Review button, the review moves to the In Progress state. Participants join the review by clicking on the review title, which appears in their dashboards. When all participants have finished reviewing the artifacts, the review moves to the Reviewed state. |
Paused | An interim state in which the review has been paused. This state enables the creator of the review to change the participants, their roles, or the artifacts that comprise the review. In a Formal review, the creator can also elect to get the latest version of the artifacts, in which case all artifacts that were initially captured in the review are replaced with the latest versions of the artifacts. Note that participants cannot add review comments or mark artifacts as reviewed when the review is paused. The creator of the review must click the Continue button to resume the review. |
Reviewed | Reviewers have added comments to the artifacts and have clicked the Done button on their review. The creator of the review (or an administrator) can still make changes to the review at this point by pausing the review and making changes. |
Finalized | All necessary reviewers have completed the review and the creator has clicked the Finalize Review button. The review is saved and can no longer be modified. In the case of a Formal review, those specific versions of the artifacts that were approved are also saved. You can now create a collection containing the reviewed artifacts to continue working with these artifacts outside of the review. |
E-mail Notification
Notification Recipient | Events that cause e-mail notifications to be sent |
---|---|
All Participants | When the review is started or when there are additions or changes to certain properties, such as due date, status and review instructions . |
All Participants | Artifacts are added to or removed from the review |
Specific Participants | Participants are added to or removed from the review. |
Specific Participants | Change to their status or to an artifact status that affects them. This event occurs when the creator of the review resets the participant status. |
Specific Participant | Reviewer role changes. |