Creating and managing reviews for assets in forms creating-and-managing-reviews-for-assets-in-forms

AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.

Review review

A Review is a mechanism that allows one or more reviewers to comment on an asset that is available in a form.

Setting up a review setting-up-a-review

  1. Navigate to the Forms tab and select a form.

  2. If the asset does not have a review in progress, a Start Review aem6forms_review_chat_comment icon appears in the Action bar. Click the Start Review aem6forms_review_chat_comment icon.

  3. Enter the following information:

    • Review name: Mandatory, can contain alphanumeric characters, hyphen, or underscore.
    • Review description: Optional, description of the purpose / content for review.
    • Review deadline: Optional, the date on which the review ends. When past the deadline the task appears as ‘Overdue’.
    • Reviewers: A minimum of one is mandatory. Use the combo-box to add reviewers. Typing a name lists all matching names; select a name and click Add.
  4. Fill in all the remaining details, and then click Start.

Actions that occur when a review is set up actions-that-occur-when-a-review-is-set-up

This section describes what happens when a review is created or set up.

  1. A new review task is created and assigned to the initiator of the review.

  2. All reviewers are assigned a review task. The task appears in their Notifications section. A reviewer can click a notification, or go to the Inbox to view the task. A reviewer can click to open the review task, to view the form, and start adding comments.

    Reviewer Notification Alert
    Figure: Reviewer Notification Alert

  3. The comment box is available to the initiator and reviewers of the asset. Others can view the comments, but cannot write comments.

Managing a review managing-a-review

Only reviews that are in progress can be modified. Reviews that are complete cannot be modified.
  1. Navigate to the Forms tab and select a form.

  2. If an asset has a review in progress and you are the initiator of the review, a Manage Review aem6forms_review_chat_comment icons appears in the Action bar. Only review initiator can manage (update/end) the review.

    Click the Manage Review aem6forms_review_chat_comment icon.

    For user other than initiator the Manage Review icon is disabled.

  3. You get a screen that displays information:

    • Review name: Cannot be edited.
    • Review description: Available for editing.
    • Review deadline: Available for editing. One can modify the deadline to any date and time beyond the current date and time.
    • Reviewers: Available for editing. You can add or remove reviewers. If a task is overdue, you can add reviewers only after extending the deadline beyond the current date.
  4. Edit the necessary fields, and then click Update.

    Review updated state in Task Manager
    Figure: Review updated state in Task Manager

  5. To end the review, click End.

Actions that occur when a review is modified actions-that-occur-when-a-review-is-modified

This section describes, what happens on Review end / modification:

  1. If the Review description is modified, the corresponding task of reviewers and the initiator is updated.

  2. If the Review deadline is modified, the corresponding task for the reviewers is updated with the new date.

  3. If a reviewer is removed:

    Removing a reviewer
    Figure: Removing a reviewer

    1. If incomplete, the assigned task is terminated.
    2. The reviewer can no longer comment on the asset.
  4. If a reviewer is added:

    Adding a reviewer
    Figure: Adding a reviewer

    1. A review task is created and assigned to the newly added reviewer.
    2. The newly added reviewer can add comments for the asset.
  5. When a review ends:

    1. Reviewers: For each reviewer, the incomplete task related to the review is terminated. The task no longer appears as ‘Pending’ in the reviewer’s Notifications section.
    2. Initiator: The task assigned to the Review initiator is marked complete. The task is removed from the Notification section of the review initiator.
    3. All: The review appears in the Previous Reviews section. No further comments can be added.