[Collapse]Collaborator 10
 [Expand]General Information/viewarticle/80040/
 [Expand]Getting Started/viewarticle/80359/
 [Expand]Collaborator Server/viewarticle/80060/
 [Collapse]Web Client/viewarticle/80107/
   Web Interface Client - Overview/viewarticle/80124/
  [Expand]Account Management/viewarticle/80076/
  [Collapse]Performing Reviews/viewarticle/80371/
    Action Items/viewarticle/80103/
    Creating a Review/viewarticle/80080/
    Review Summary Screen/viewarticle/80078/
    Sending Calendar Notifications/viewarticle/91141/
   [Expand]Reviewing Materials/viewarticle/80370/
    Types of Review Comments and Defects/viewarticle/80132/
    Review Chats, Comments and Defects/viewarticle/80079/
    FAQs/viewarticle/80390/
  [Expand]Searching & Reporting/viewarticle/80391/
   Troubleshooting/viewarticle/80368/
 [Expand]Desktop Clients/viewarticle/80151/
 [Expand]Version Control Integration/viewarticle/80048/
 [Expand]External Integrations/viewarticle/80340/
 [Expand]Techniques & Best Practices/viewarticle/80403/
 [Expand]Appendices/viewarticle/80117/
Updated: 12/23/2016 Applies To: Collaborator 10 Rating: No votes Click to rate: PoorNot badAverageGoodExcellent

Web Client > Performing Reviews

Top |Previous |Next

Review Summary Screen

You will know that you are part of a review because it will show up in your Action Items list, clicking the link for a review will take you to the Review Summary screen.

ws-review-actionitems-reviewtodo

The Review Summary Screen is displayed any time you are creating, editing or participating in a review. It is split up into several sections:

Each section of the Review Summary screen can be collapsed and expanded, individually, by clicking the icon in the upper right hand corner of each section:

ws-review-summary-collapse

General Information Section

The General Information section provides a graphical overview of the current status of the review. The image below shows the information about a review during the rework phase:

ws-review-details

The General Information section is divided into thirds. The left third includes information about your status within the review. The middle third shows a graphical representation of the current stage that the review is in. The right third lists the number of participants, defects, chat messages and files. The right third also has a number of buttons: Edit, Details, Cancel, Reject, Reopen or Save To ZIP.

Selecting "Edit" will take you to the Edit Review screen. To have permission to do this, you must be either a participant in the review or an administrator, and the review must be in progress (that is not canceled or complete), and the role rules for your role must allow you to do this.

Selecting "Details" will direct you to the Review Details Report tailored to the open review.

Selecting "Cancel" will cancel the review. To have permission to do this, you must be authorized to do so by the administrator, and the review must be in progress (that is, not already canceled or complete).

Warning: Once a review is canceled it can only be reactivated by an admin. Users will still be able to find this review when searching and can view it in a read-only capacity, but the review cannot be restarted by users without administrative rights.

Selecting "Reject" will open the following dialog which allows you to select a reason for rejecting the review:

ws-reject-review-list

Rejecting a review differs from cancelling in two ways:

- When rejecting a review a reason for the rejection can be required by the administrator and will be displayed in the review details.
- A rejected review cannot be re-opened.

You might also be able to Reopen a review after a review is finished. You must be allowed to do so by the system administrator (the Reopen button is not shown in the screenshot above).

Selecting "Save To ZIP" will create an ZIP archive containing all the information related to the review. This button is displayed only for the reviews in the completed phase.

The table in the lower part of the General Information section shows the overall information about the review.

ws-review-overview-general

Most of the fields mirror the title and custom fields supplied by the review creator, though your role and any custom fields will also be displayed here.

Checklist Section

If your current review template uses checklists, the Checklist section is displayed. Unchecked items have a red background, checked items have a check on the left and a green background.

checklistrevsumpg

You can sort checklists by Status, Title, User or Date. If checklists are mandatory, all items must be checked before the review can be approved. Checklists are managed in the admin section and added to review templates. Any user can check or uncheck items on the checklist and the system will record each event in the chat log while showing only the latest state on the actual checklist items.

Participants Section

The Participants section lists all participants in the review, their status, and their role:

ws-review-overview-participants

The drop-down list at the top left allows you to select the way participants are grouped when displayed in this section. The options are "Group by Role", "Group by State" or "Group by None". The "Group by None" option lists all participants in the review in a single list which is sortable by clicking the headers for each column (name, role, state).

From the Participants section you can send different types of notifications to other participants. Collaborator has the following types of notifications:

E-mail - Launches your e-mail client and creates a draft letter which you can edit as you like and then send it.
To send an e-mail notification to a specific participant, click the Email icon (ws-email-icon) next to the desired participant.
To send e-mail notifications to all participants, click the "Email Everyone" button at the top of the Participants section.
Poke - Sends an e-mail with auto-generated content. Poke notifications may be useful when a certain participant has stalled the review or when you would like to invite a "finished"/"waiting" participant back into the review.
To send poke notification to a specific participant, click the Poke icon (ws-poke-icon) next to the desired participant.
To send poke notifications to all participants, click the "Poke Everyone" button at the top of the Participants section.
Calendar - Creates an email with a meeting request in iCalendar format. Calendar notifications may be useful for scheduling formal meetings on review.
To send Calendar notifications to all participants, click the "iCal Everyone" button, in the ensuing Collaborator iCal Invite dialog specify proposed date and time and click Send.
JIRA Ticket - Creates a ticket in pre-configured JIRA project. SeeCreating JIRA Tickets From Collaborator for details.
To send JIRA notification to a specific participant, click the "Create JIRA ticket" next to the desired participant.
To send JIRA notifications to all participants, click the "JIRA Ticket Everyone" button at the top of the Participants section.
Defect Log Section

The Defect Log lists all defects found in the review:

ws-review-overview-defectlog

Initially the log will be empty. As defects are created for the review as a whole or on individual files and line numbers, all defects are collected and listed here. For defects associated with particular files, links to that file and line number appear in the table for fast access. All defect custom fields are shown in the table.

When, as the reviewer, you have verified that a defect you found has been fixed, you can indicate this by clicking Mark Fixed.

ws_review_defect-mark-fixed

The defect is then redrawn to reflect this:

ws-review-overview-defectlog-fixed

You can mark the defect open again if you change your mind. Open the defect by clicking Reopen.

ws-review-defect-reopen

You can also externalize a defect if you want to indicate that the defect will be fixed sometime after the review is complete. The defect must first be created, as normal, and then a user can click Edit and select Track Externally to use the external defect tracking software (if it has been configured by the administrator). If a defect is tracked externally, it will be indicated by a blue bug with a blue arrow icon as shown below:

ws-review-overview-defectlog-externalized

Only certain participants will be able to mark defects fixed. Which roles are allowed to do this depends on the system configuration. Also the user that created the defect is allowed to mark it fixed, and administrators are always allowed to mark any defect fixed.

Most of the time you will create defects and mark them fixed on individual lines (in text files) or on specific areas (in other types of documents).

Overall Review Chat

You can chat with other users about this review as a whole, rather than chatting on individual lines:

ws-review-overview-chat

You can also use this section to enter defects related to the review. Clicking the "As Defect" button will change the interface to include a drop-down list that will allow you to select a defect Severity (required for all defects):

ws-review-overview-chat-defect

There is much to say about chat and defects, but this interface is identical to the one in the Review Chats, so please see that section for details.

Review Materials Section

ws-review-overview-materials

The Review Materials section is the heart of the review: All files are displayed and users can view content and differences and create comments and defects on specific lines or coordinates within a file.

Below, we will describe each of its elements in details.

Toolbar

Toolbar

The toolbar of the Review Materials section holds the following items:

Download

Allows to download review materials to your local computer. The item holds the following sub-items:


Download Files- Download a ZIP file to the local drive containing all files with subdirectory structure preserved.

This means you can test the proposed file changes locally: Just download the ZIP file and expand it in your own development environment. This is also useful in the single-committer model for when you want to actually commit the changes. This can take the place of a patch file.

Warning: Downloading files to your local hard drive can have unintended consequences. Make sure you do not have changes of your own that you are overwriting. Also, remember that the author of these changes might not be synched to exactly the same versions of all files in version control, so if your local test fails this might be the reason.

You can also download individual file versions from the diff viewer, but the Download Files toolbar link is the more common way because you get all files at once.


Download Diff- Download a unified diff of all files in the review.

Upload

Allows to upload data from your local computer to current review. Uploads can be disabled by review creator and by administrator. The item holds the following sub-items:


<Name of Version Control System> - Attach changes from one of pre-configured version control repositories.


Files - Attaches arbitrary files from your computer.


URL - Attaches live URL link.


Local Changes - Attaches local files using the command-line client, GUI Client, or P4V integration.

View as

Allows to change the format of how the review materials are listed. If a review contains only one changelist, this command is inactive. The view options are:


Overlay (default) - Display all files from multiple changelists or uploads in one list.


Separate - Display files from each changelist or upload in a separate list.

External Diff

Download a diff file for viewing in an external diff viewer.

Delete

Deletes a changelist from the review materials. If you have multiple changelists in the review, you will need to go to separate view in order for the button to be enabled. You cannot delete an arbitrary file from a changelist. You can only delete the entire changelist. You cannot delete changelists that have comments to any file. Ability to delete review materials can be disabled by review creator and by administrator.

ws-review-overview-materials_changelist-info

The Changelist infosection displays information about the uploaded files - who and when has submitted files, version control system, changelist IDs, commit messages, diff command and so on. Depending on how the materials were added, this information may vary a little. In Overlay view this section combines information from each changelist, while in Separate view this section precedes each particular changelist.

File list

File list

The File list shows the files in this review. This part of the screen may look different depending on the selected View as setting. The icon next to the file name indicates what operation was performed to the file.

Icon

Meaning

icon-document-16

File was modified

icon-document_add-16

File was added

icon-document_revert-16

File was removed from a changelist

File was reverted before the review has started

icon-document_delete-16

File was deleted

icon-document_refresh-16

File was reverted during the review

To open the content of a file and view all comments associated with that file, just click its name in the file list.

The Conversation section of the Files list shows where comments and defects have been made, their location within a file as well as whether these comments have been approved by other participants.

Conversation status icons and Location column

Conversation status icons and Location column

Icon

Meaning

icon-comment-16

User has made a comment

icon-accepted

User has clicked "Mark Accepted" upon your or other users comment

icon-bug_red-16

User has created a defect, which is currently "Open"

icon-bug_green_checked-16

User has created a defect, which is currently marked "Fixed"

icon-bug_green_arrow_blue-16

User has created a defect, which is currently marked "Tracked Externally"

The Location column indicates where within the file the conversation represented by this row is located. Yellow alert bubbles icon-message-16 mean there is activity on that line that the current user has not yet marked read. Click on a line number to open the content of that file and view that conversation.

Metrics, Status and Notes columns

Metrics, Status and Notes columns

The next three columns show the number of text lines or lines of code (LOC) that have been added, changed, and deleted, with special cases for situations like added or deleted files.

Icon

Meaning

icon-lines-added

The number of lines that have been added

icon-lines-changed

The number of lines that have been modified

icon-lines-removed

The number of lines that have been removed

The lines of code metrics (LOC metrics) are calculated only for source code and other text-based files and only if the files are stored in a version control system. Otherwise, for other types of review materials (Word, Excel, PDF or Image files), or when the files were uploaded from the Web Client, the metrics are not calculated and return 0.

If the Overlay view is selected (default), the LOC metrics are calculated comparing the latest uploaded revision of file against the baseline revision of that file. Here, the baseline revision stands for the revision at the moment the review was created.

If the Separate view is selected, the LOC metrics are calculated comparing each individual file revision against its previous revision.

The Status column shows cumulative status of a file based on combining the actions of all previous changelists uploaded to the review.

The Notes column allows any user to annotate the files. To edit the note click in the note column. This is typically used for messages to all reviewers such as "review this file first", or "ignore this file".

Drag-and-Drop Support

You can add files to current review by dragging and dropping files directly on to the Review Summary screen. (Please note, for Internet Explorer to support multi-file drag and drop Adobe Flash Player must be installed.)

Next Steps

At the bottom of the Overview screen, you can find a "Next Steps" section that allows each review participant to move the review from one phase to another, or to wait in the current phase until certain specified activity occur. To learn more about review phases, see the Review Overview topic.

The choice options in "Next Steps" vary depending on the current and the expected phases of the review and the role of the participant. The choice options can be: Wait, Begin Review, Annotate Review, Send to Completed, Send to Rework, Send to Inspection and so forth.

ws-review-next-steps1

Pressing any of the "Next Steps" buttons (except for Wait) indicates that you have passed through the current review phase and moves the review to another phase.

Pressing the Wait button keeps the review in its current phase.

ws-review-next-steps-wait

Most of the choices also allow to select in which case Collaborator will notify you of certain activities related to the given review. The action options are:

Any Activity Occurs - any action that occurs in the review; for example, comments, file uploads, or added participants
Activity by Author Occurs - any action that occurs in the review that is initiated by the author
File Activity Occurs - any action that occurs to change the file content of the review; for example, the upload of a new file or the upload of a new version of an existing file
You are Poked - only notifies you in the event that you are poked

The "Home" link in the lower part of "Next Steps" section will lead you to Home screen of web client. The "Next Review" link will open the next review in your Action Items list.

Electronic Signatures in Next Steps

When electronic signatures are enabled, users will see Sign and Decline buttons. Clicking either button requires a user to provide their login and password to complete the action. This makes the electronic signature compliant with FDA regulations.

ws-review-overview-sign-review

When a reviewer signs or declines a review, the Next Steps section of the Review Summary page says, "This Review has been Signed Off" or "This Review has been Declined". The Chat section shows the signature information. Collaborator notes the name of the reviewer and the date and time the review was signed or declined.

For auditing purposes, you can go to the Review Details Report. Make sure that Comments Section Format is set to Display All Comments, and in the Overall Review Conversation section, you can see the signature information.




© 2019 SmartBear Software. All rights reserved.
Email Send feedback on this document