Google Git
Sign in
eclipse / r4e / org.eclipse.mylyn.reviews.r4e / dbd04a2039121697b4f390f4d654e5c0d657c5f0 / . / org.eclipse.mylyn.reviews.r4e.help / doc / Tasks.html
blob: aaaec2271000b61083d017176a707e5e4849b025 [file] [log] [blame]
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>R4E Documentation - Tasks</title>
<link type="text/css" rel="stylesheet" href="book.css"/>
</head>
<body>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<th style="width: 100%" align="center" colspan="3">Tasks</th>
</tr>
<tr>
<td style="width: 20%" align="left">
<a href="Concepts.html" title="Concepts">
<img alt="Previous" border="0" src="images/prev.gif"/>
</a>
</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right">
<a href="Advanced-Topics.html" title="Advanced Topics">
<img alt="Next" border="0" src="images/next.gif"/>
</a>
</td>
</tr>
<tr>
<td style="width: 20%" align="left" valign="top">Concepts</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Advanced Topics</td>
</tr>
</table><hr/>
<h1 id="Tasks">Tasks</h1>
<h2 id="Working_with_the_Navigator_View">Working with the Navigator View</h2>
<p>The R4E Navigator View is the main component of R4E. It shows all the information that is available to the user and it is also the place where most user commands are available. The Review Navigator information is organized in a hierarchical tree structure and is presented in a Navigator panel. Elements shown in red are read-only. Commands are available in the view toolbar and in context menus that appear when right-clicking the navigator elements. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="ReviewNavigatorView.png"/>
</p>
<p>
<br/>
</p>
<p>When a Review is open, the Navigator view can focus on and display the Review elements in an alternate display that show them in a more compact and table-like way. Both representations can be toggled on by using the
<i>Change Display</i> toolbar command.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="ReviewNavigatorViewAlt.png"/>
</p>
<p>
<br/>
</p>
<h3 id="Disabling_and_Restoring_Elements">Disabling and Restoring Elements</h3>
<p>When Review Navigator elements are not relevant anymore (e.g. completed reviews), they can be removed from the view by using the ''Disable ''command from the element's context menu. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="DisableElement.png"/>
</p>
<p>
<br/>
</p>
<p>Disabled elements data is kept, but they will not appear in the navigator view anymore. Take note that currently it is not possible to completely remove references to an element once it is created. </p>
<p>To see disabled elements in the Navigator view, go to the R4E Preferences Filter Tab and select the
<i>Show Disabled Elements</i> checkbox and apply the preferences. The disabled elements will show in the Navigator grayed out and with the little disabled decorator icon
<img border="0" src="Dsbldovr_tsk.gif"/>
</p>
<p>Ideally, disabled elements should never be shown, but there could be a need to restore mistakenly disabled elements. To do so, first go to the Eclipse preferences R4E page, on the
<i>Filters</i> tab and enable the
<i>Show Disabled Elements</i> filter, then return to the Navigator view and select the ''Restore ''command from the disabled element context menu
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="RestoreElement.png"/>
</p>
<p>
<br/>
</p>
<h3 id="Sorting_Review_Navigator_Elements">Sorting Review Navigator Elements</h3>
<p>The Navigator elements can currently be sorted alphabetically or by review type, by selecting the appropriate sorter in the Review Navigator Toolbar menu. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="Sorters.png"/>
</p>
<p>
<br/>
</p>
<h3 id="Filtering_Review_Navigator_Elements">Filtering Review Navigator Elements</h3>
<p>The Navigator view provides different filters that can be used to limit the visibility of elements within the navigator tree. Filters are available in the Review Navigator Toolbar menu. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="Filters.png"/>
</p>
<p>
<br/>
</p>
<p>The filters available are: </p>
<ul>
<li>
<i>Show Reviews Only</i>: Show only Review Groups and Review elements
</li>
<li>
<i>Show My Reviews</i>: Show only Review Groups and Review elements in which the current user is a Participant
</li>
<li>
<i>Show Reviews for Participant...</i>: Opens a dialog box where a User ID can be specified. The Navigator will then show only Reviews in which this User is a Participant
</li>
<li>
<i>Show My Assigned Elements</i>: Show review elements that are unassigned or assigned to the current User
</li>
<li>
<i>Show Assigned Elements for Participant...</i>: Opens a dialog box where a User ID can be specified. The Navigator will then show only Review elements that are unassigned or assigned to the specified participant.
</li>
<li>
<i>Show Unassigned Elements</i>: Show only review elements that are not currently assigned to any participant.
</li>
<li>
<i>Show Anomalies Only</i>: Only show the Anomalies for the currently open Review and their parent containers
</li>
<li>
<i>Show My Anomalies</i>: Only show the Anomalies for the currently open Review that the current User created and their parent containers
</li>
<li>
<i>Hide Completed Reviews</i>: Hide all the reviews that are in phase
<i>COMPLETED</i>
</li>
<li>
<i>Hide Reviewed Elements</i>: This filter will hide all elements that have been marked as Review by the current User
</li>
<li>
<i>Hide Rule Sets</i>: This filter will hide all Rule Sets elements and their children
</li>
<li>
<i>Hide Deltas</i>: This filter will hide all Selection and Delta elements.
</li>
<li>
<i>Remove All Filters</i>: Remove all currently applied filters and restores the full display of all enabled elements in the Navigator tree.
</li>
</ul>
<p>
<br/>
</p>
<h3 id="Setting_Elements_Reviewed_State">Setting Elements Reviewed State</h3>
<p>To help Users to keep track of the content that was reviewed it is possible to mark relevant Review Navigator elements as reviewed using the context menu Mark/Unmark as User Reviewed command. This will put a little done decorator
<img border="0" src="Revovr_tsk.gif"/> icon. The marking can be removed by using the same command to toggle the state.
</p>
<p>
<br/>
</p>
<h3 id="Setting_Elements_Due_Date">Setting Elements Due Date</h3>
<p>A due date can be set for the Review and Anomalies elements to specify a latest date after which the review (or anomaly) should be completed (i.e. set to a terminal state). After this date has passed, if the elements are still not completed, they will be highlighted in the Review Navigator, using icon decorators, red text and additional info in their respective tooltips, so that the review participants are aware of the situation and can take action quickly. Take note that does not apply to anomalies in basic reviews, since they are stateless.</p>
<p>
<br/>
</p>
<h3 id="Other_Review_Navigator_Commands">Other Review Navigator Commands</h3>
<p>These other commands are also available from the Navigator view toolbar and/or drop-down menu: </p>
<ul>
<li>
<i>Progress Element</i>
<img border="0" src="nxtstate_menu.gif"/>: Change the state of a stateful element (e.g. Review, Anomaly) to its next logical state. This is a shortcut and can also be done through the R4E Properties view for the element.
</li>
<li>
<i>Regress Element</i>
<img border="0" src="prevstate_menu.gif"/>: Change the state of a stateful element (e.g. Review, Anomaly) to its previous logical state. This is a shortcut and can also be done through the R4E Properties view for the element. Take note that this is the only way to change the state of a
<i>COMPLETED</i> Review.
</li>
<li>
<i>Go Into</i>
<img border="0" src="Focus_menu.gif"/>: This is a special filter that will take the selected element of the Navigator and put it at the root of the Navigator tree. This is useful to focus on a particular element and its children.
</li>
<li>
<i>Collapse Navigator tree</i>
<img border="0" src="Clpseall_menu.gif"/>: Collapse the current Navigator tree.
</li>
<li>
<i>Expand Navigator tree</i>
<img border="0" src="Expndall_menu.gif"/>: Expand the current Navigator tree to the lowest level.
</li>
<li>
<i>Select and Open Next Element</i>
<img border="0" src="Nxtelem_menu.gif"/>: Move the selection to the next (lower) element in the tree and opens it in an editor if possible (for File Contexts elements and children)
</li>
<li>
<i>Select and Open Previous Element</i>
<img border="0" src="Prvelem_menu.gif"/>: Move the selection to the previous (higher) element in the tree and opens it in an editor if possible (for File Contexts elements and children)
</li>
<li>
<i>Refresh Navigator Data</i>
<img border="0" src="Refrsh_menu.gif"/>: Fetches data from disk and rebuilds the Navigator tree. This will also show new data that has been added by other users.
</li>
<li>
<i>Show UI Legend</i>
<img border="0" src="icons-legend.gif"/>: Shows a legend that displays and explains all R4E icons in a pop-up dialog.
</li>
</ul>
<p><div>
<br/></div>
</p>
<p>Take note that not all filters and toolbar commands are available on all Review Navigator representations.</p>
<p>
<br/>
</p>
<h2 id="Handling_Review_Groups_and_Reviews">Handling Review Groups and Reviews</h2>
<h3 id="Creating_a_Review_Group">Creating a Review Group</h3>
<p>When using R4E for the first time, the first thing to do is to create Review Groups that will hold the R4E review data. Typically, Review Groups include common settings that will be used for multiple reviews. For instance, one can create a Review Group for a design organization, for a given project or task etc. </p>
<p>A given Review Groups is created only once, typically by a "super-user" selected among people that are part of the group. </p>
<p>In order to create the Group, select the
<i>New Group</i> icon in the Review Navigator Toolbar.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewReviewGroup.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Review Group dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewReviewGroupDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Review Group Name and (optionally) a brief description in the appropriate text fields. </li>
<li>Select a shared folder location where team members have access and write permissions (i.e. Review Group shared folder) </li>
<li>Under the Extra Parameters section, more information can optionally be entered to further characterize the Group: Default Project, Default Components and Default Entry Criteria values will be available for all Reviews created under this Review Group. Rule Sets defines the available Rule Sets for Review created under this Review Group (see Rule Sets below).</li>
</ul>
<p>
<br/>
</p>
<h3 id="Opening_an_Existing_Review_Group">Opening an Existing Review Group</h3>
<p>When you create a new Review Group, its references are automatically included in your workspace. To add other Review Group references, open the R4E Preference Group Tab (Window-&gt;Preferences-&gt;R4E, then switch to tab "Groups")</p>
<p>
<br/>
</p>
<p>
<img border="0" src="R4E_preferences_general_groups.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add a new Review Group reference file by clicking the ''Add ''button and select the appropriate Group File. Take note that all Review Group filename end with "_group_root.xrer" suffix. </li>
<li>The Review Group Name and Description are also shown in the Preferences Group tab.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Creating_a_Review">Creating a Review</h3>
<p>The Review is the main element of R4E. It is used to group together file that are to be reviewed. There are three type of reviews, Basic, Informal and Formal review (See concepts section for an explanation of the different types of reviews). </p>
<p>To create a new Review, right-click on the parent Review Group under which you want to create the review and select the
<i>New Review</i> Command from the R4E Context Menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewReview.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Review dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewReviewDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Review Name and a brief description in the appropriate text fields. </li>
<li>Under the Extra Parameters section, more information can optionally be entered to further characterize the Review:
<ul>
<li>A due date can be set to specify a date before which the review should be completed</li>
<li>Project and Components values can be selected from the values entered in the parent Review Group Default Projects and Default Components respectively </li>
<li>Entry Criteria is taken by default from the parent Review Group value </li>
<li>Objectives and Reference Materials can be set by the Review creator</li>
</ul>
</li>
</ul>
<p>
<br/>
</p>
<h3 id="Opening_and_Closing_of_Review_Groups_and_Reviews">Opening and Closing of Review Groups and Reviews</h3>
<p>In order to be able to see the Review Group child Reviews, a Review Group must be open. Closed Review Group are shown with hollow Group icons. You can open a closed Review Group by right-clicking on it and selecting the
<i>Open Element</i> command, or simply by double-clicking on it. &nbsp;Closing unused Review Groups make navigation easier and free up memory and resources, so the Groups should be closed when they are unused.
</p>
<p>Likewise, reviews can also be open and closed using the same mechanism. The only difference is that only one review (called the Active Review) can be open at any given time. Opening another Review closes the currently open one. </p>
<p>Take note that Review Groups and Reviews are automatically open after they are first created. </p>
<p>
<br/>
</p>
<h3 id="Adding_Participants_to_a_Review">Adding Participants to a Review</h3>
<p>Participants are automatically added to the current Review as soon as they add review items to it or create an anomaly. It is also possible to add them manually. </p>
<p>To do so, right click on the parent review and select the
<i>New Participants</i> Command from the R4E Context Menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewParticipant.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the
<i>Enter Participants details</i> dialog.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewParticipantDialog.png"/>
</p>
<p>
<br/>
</p>
<p>The dialog is divided into 2 sections:</p>
<ul>
<li>Participants: This is where the participants are added. Use the field above to enter the IDs on the participants to add, separated by semicolons (;). If you defined Participants Lists in the preferences, the list name can be added here. Once the participants are entered, hit the return key, or use the
<i>Add</i> button to add them to the list of participants. The participants will now appear in the participants list just below. If present, participants lists from Preferences are resolved and their contents is added to the list as well. If an LDAP database is setup up and configured in the preferences, R4E will also try to resolve the added users and automatically fetch the information from the database. Participants can be removed from the list by using the
<i>Erase</i> button, and the list can be reset by using the
<i>Clear</i> button. If an LDAP database is set up, it can also be accessed using the
<i>Find</i> button (see below). The participant id entered within the R4E review data will be in lower case and R4E will enforce that (this to prevent duplicated users Ids for the same user).
</li>
<li>Basic Parameters: Once participants are added to the participants list. This section displays the basic information for the currently selected entry in the list. The email address can be edited, but not the Id or the participant details field (which in only filled if an LDAP database is set up and there is information about the user in it).</li>
</ul>
<p>
<br/>
</p>
<p>If an LDAP database is configured and connected, the user information could be searched and filled-in automatically using the
<i>Find</i> button, which will open the Find User Dialog
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="FindUserDialog.png"/>
</p>
<p>
<br/>
</p>
<p>Any field can be entered in the Search Filters section and by clicking the Search button, an LDAP query will be sent to the database. If any matches are found, the results will be displayed in the Query Results section. Once the results are in, users can be added by double-clicking on them in the results table, or by selecting them and using the
<i>Add Users</i> button. Pressing the
<i>OK</i> button will result in the users being added to the New Participants dialog participant list.
</p>
<p>
<br/>
</p>
<h3 id="Creating_a_Review_Item">Creating a Review Item</h3>
<p>In R4E, Review Items are a collection of one or more files, or parts of files, that are to be reviewed. There are two types of Review Items that exist: Commit Review Items and Resource Review Items. </p>
<p>
<br/>
</p>
<h4 id="Creating_a_Resource_Review_Item">Creating a Resource Review Item</h4>
<p>This item type is created by manually selecting a workspace resource (i.e. File) or a portion of a resource (i.e. line ranges within a given file). </p>
<ul>
<li>To create Resource review items for a whole file, right-click a File on a Package Explorer, Navigator or Project View and select the
<i>Add Review Item</i> command from the R4E context menu.
</li>
</ul>
<p>
<br/>
</p>
<p>
<img border="0" src="AddResourceReviewItemFile.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>To create Resource review items for a portion of a file, right click a line range selection in an editor or compare editor, or on an element of the outline view and select the
<i>Add Review Item</i> command from the R4E context menu.
</li>
</ul>
<p>
<br/>
</p>
<p>
<img border="0" src="AddResourceReviewItemRange.png"/>
</p>
<p>
<br/>
</p>
<p>Once a Resource Review Item is created, it will be shown in the Review Navigator. If you expand the Review Item, you will see the child elements: The file on which the Review Item is applied and the line range selection that is part of the item. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="ResourceReviewItem.png"/>
</p>
<p>
<br/>
</p>
<h4 id="Creating_a_Commit_Review_Item">Creating a Commit Review Item</h4>
<p>This item type is created by selecting files that were committed to a Version Control System repository. Currently, the only Version Control System supported is Git. </p>
<p>To create a Commit Review Item, right click on a project attached to the Egit team provider (see Project Configuration) and select the
<i>Find Review Items</i> command from the R4E Context menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="FindReviewItems.png"/>
</p>
<p>
<br/>
</p>
<p>This will show the Version Control System Commit Dialog (Here shown for the Git connector). </p>
<p>
<br/>
</p>
<p>
<img border="0" src="FindReviewItemsDialog.png"/>
</p>
<p>
<br/>
</p>
<p>Use the
<i>Available Commits</i> combo box to browse through all available commits and select one. For the selected commit, the commit information and affected files appear in the Commit Information and Committed Components sections respectively.
</p>
<p>Once a Commit Review Item is created, it will be shown in the Review Navigator. If you expand the Review Item, you will see the child elements: The file on which the Review Item is applied and, optionally if the option is selected in the preferences, the line ranges for the Deltas (or differences between the committed file and its direct ancestor) that are part of the Item. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="CommitReviewItem.png"/>
</p>
<p>
<br/>
</p>
<p>The icons for the files that are new and were added in the commit will be shown decorated with a little
<img border="0" src="Addovr_tsk.png"/> icon The icons for the files that were removed in the commit will be shown decorated with a little
<img border="0" src="Removr_tsk.png"/> icon Files in the commit that are out of sync i.e. for which the version to review and the version present in the users workspace differ will be shown with the &gt; sign prepended to the filename. Such files can be reviewed, but to use the full navigatability provided by the editors, it is strongly recommended that the files be in sync with the workspace whenever possible.
</p>
<p>
<br/>
</p>
<h3 id="Assigning_Review_Elements">Assigning Review Elements</h3>
<p>It is possible to assign specific review elements (i.e. Review Items, File Contexts, Selections and Deltas) to specific participants. To do so, use the context command
<i>Assign to Participant</i> for the desired elements.
</p>
<p>
<img border="0" src="AssignParticipant.png"/>
</p>
<p>To remove an assignment, use the context command
<i>Unassign Participant</i>.
</p>
<p>
<img border="0" src="UnassignParticipant.png"/>
</p>
<p>Take note that if a parent is assigned to given participants, then all its children will also be assigned. It is possible to override the parent's values and to change the children's assignments by operating on the child element directly.</p>
<p>Assignments can also be managed by using the Properties view for the selected element.</p>
<h3 id="Creating_an_Anomaly">Creating an Anomaly</h3>
<p>R4E Anomalies are raised by reviewers to flag problems or add comments on specific parts of the contents as part of the review process. </p>
<p>Anomalies are added in a similar way Resource Review Items are, either from a selected Resource or from a portion/range of a resource, by selecting the
<i>Add Anomaly</i> command from the R4E context menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewAnomaly.png"/>
</p>
<p>
<br/>
</p>
<p>Anomalies that are directly tied to a specific selection/delta range can also be created by selecting the
<i>Add Linked Anomaly</i> command from the context menu of the affected selection/delta in the Review Navigation View
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewLinkedAnomaly.png"/>
</p>
<p>
<br/>
</p>
<p>Anomalies can also be created at the review level. This is useful to flag problems that are not specifically tied to a given file or file part. To do this, use the
<i>Add Anomaly</i> Command from the context menu of the Global Anomalies element in the Review Navigator view.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewGlobalAnomaly.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Anomaly dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewAnomalyDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Anomaly Title and Description in the appropriate text fields. </li>
<li>Under the Extra Parameters section, you can also specify the class, rank, due date and participant that will be assigned to this anomaly. If Rule Sets are associated to the parent Review Group, the Rule Sets hierarchy will be shown and, optionally, a design rule can be toggled selected/de-selected and if selected its values will be applied to this anomaly. This will override the previous Anomaly values.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Cloning_an_existing_Anomaly">Cloning an existing Anomaly</h3>
<p>Anomalies can be duplicated so that their information is applied to a new location and/or file. Anomalies are cloned be selecting a new range in an editor and using the
<i>Clone Anomaly</i> contextual command
</p>
<p>
<img border="0" src="CloneAnomaly.png"/>
</p>
<p>This will trigger the Clone Anomaly Dialog, where the source anomaly to clone can be selected.</p>
<p>
<img border="0" src="CloneAnomalyDialog.png"/>
</p>
<p>Once this is done, a new Anomaly will appear at the new location with the same information as the source one.</p>
<p>Anomalies can also be cloned to a specific Delta or Selection element by dragging and dropping them over the desired Delta or Selection, by using the Copy and Paste Review Navigator Contextual commands or by using the generic Copy (CTRL+C) and Paste (CTRL+V) hotkeys. </p>
<p>
<img border="0" src="DragDropAnomaly.png"/>
</p>
<p>
<img border="0" src="CopyAnomaly.png"/>
</p>
<p>
<img border="0" src="PasteAnomaly.png"/>
</p>
<p>Take note that the child comments on the source anomaly are not copied to the new cloned anomaly. It is however possible to copy the comments manually (see below).</p>
<h3 id="Creating_Comments_on_an_existing_Anomaly">Creating Comments on an existing Anomaly</h3>
<p>It is possible to add comments to an existing anomaly. This could be useful in discussing the anomaly or for tracking purposes. To create a Comment, use the
<i>Add Comment</i> command on the context menu on the selected Anomaly.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewComment.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Comment dialog, where the comment can be added. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewCommentDialog.png"/>
</p>
<p>
<br/>
</p>
<h3 id="Cloning_existing_Comments_to_an_Anomaly">Cloning existing Comments to an Anomaly</h3>
<p>As for anomalies, it is also possible to copy comment information to another anomaly. It is done in a similar way than for cloning anomalies, by dragging and dropping the source comment(s) unto the target anomaly, by using the Copy and Paste Review Navigator contextual commands or by using the generic Copy (CTRL+C) and Paste (CTRL+V) hotkeys</p>
<p>
<img border="0" src="DragDropComment.png"/>
</p>
<p>
<img border="0" src="CopyComment.png"/>
</p>
<p>
<img border="0" src="PasteComment.png"/>
</p>
<h3 id="Importing_Postponed_Anomalies">Importing Postponed Anomalies</h3>
<p>Postponed Anomalies are Anomalies that were written in previous Informal/Formal Reviews, but were not handled then and were instead set to
<i>POSTPONED</i> state. If the current Review include files on which these anomalies were written, whether it is the same or a different version of a file, it is possible to import them in the current review so that they can be addressed. Currently, only Postponed Anomalies that belong to Reviews under the same Review Group can be imported. Global Anomalies that were written in other Reviews in the same Review Group can also optionally be imported.
</p>
<p>To import Postponed Anomalies, just select the current Review in the Navigator View and use the context menu:</p>
<p>
<img border="0" src="ImportAnomalies.png"/>
</p>
<p>R4E will scan all Reviews under the current Review Group and will copy all Anomalies in
<i>POSTPONED</i> state that were written on files also included in the current Review, and also Global Anomalies in
<i>POSTPONED</i> state written in other Reviews, if the option is selected in the preferences. Once the command is done, the imported elements will appear on their own container elements under the Review element in the Review Navigator tree.
</p>
<p>From then on, Postponed anomalies will behave like any other Anomaly and can be handled in the same way. All changes except the state changes will be local to the imported anomaly i.e. changing the imported anomaly will not change the original one. When a Postponed Anomaly is modified, the state changes will also be reflected in the original Anomaly (i.e. the one filed in the previous Review). For instance if the imported anomaly is fixed, the original one will be marked as fixed to convey the fact that the postponed issue is now closed. </p>
<p>Take note that Postponed Anomalies that have their state changed from POSTPONED will be disabled. If they are set back to Postponed, they will be restored as Postponed elements.</p>
<h2 id="Handling_Design_Rules">Handling Design Rules</h2>
<h3 id="Creating_a_Rule_Set">Creating a Rule Set</h3>
<p>R4E support the use of Design Rules, to help reviewers enforce consistent design conventions and rules. A Rule Set is a container that includes multiple related Rules. Rule Sets are independently defined and can be shared among multiple Review Groups. Take note that the use of Design Rules is completely optional. </p>
<p>To create a new Rule Set, select the New Group icon in the Review Navigator Toolbar. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleSet.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Rule Set dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleSetDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Rule Set Version and Name in the appropriate text fields. </li>
<li>Select a shared folder location where team members have access and write permissions (i.e. Rule Set shared folder)</li>
</ul>
<p>
<br/>
</p>
<h3 id="Importing_an_Existing_Rule_Set">Importing an Existing Rule Set</h3>
<p>When you create a new Rule Set, its references are automatically included in your workspace. To import other Rule Set references, open the R4E Preference Rule Sets Tab </p>
<p>
<br/>
</p>
<p>
<img border="0" src="R4E_preferences_general_ruleSets.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add a new Rule Set reference file by clicking the ''Add ''button and select the appropriate Rule Set File. Take note that all Review Group filename end with "_rule_set.xrer" suffix. </li>
<li>The Rule Set Version and Name are also shown in the Preferences Group tab.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Creating_a_Rule_Area">Creating a Rule Area</h3>
<p>In order to create Design Rules, a Rule Area et a Rule Violation containers first need to be created. </p>
<p>Rule Areas represent a logical grouping of Rule Violations. They can, for instance refer to a specific language of element of the architecture. To create a Rule Area, right-click on the parent Rule Set and select the
<i>New Rule Area</i> command.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleArea.png"/>
</p>
<p>This opens the New Rule Area dialog. </p>
<p>
<img border="0" src="NewRuleAreaDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Rule Area Name in the appropriate text field.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Creating_a_Rule_Violation">Creating a Rule Violation</h3>
<p>Rule Areas contain Rule Violation. A Rule Violation is a logical grouping and Design Rules. They refer to a specific problem highlighted by the Rule e.g. Syntax Error, Bad Naming Convention etc. </p>
<p>To create a New Rule Violation, right-click on the parent Rule Area and select the
<i>New Rule Violation</i> command.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleViolation.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Rule Violation dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleViolationDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Rule Violation Name in the appropriate text field.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Creating_a_Rule">Creating a Rule</h3>
<p>A Rule is the smallest unit in the Design Rule hierarchy. It refers to a specific code convention that is to be followed. The values of the rules are automatically set in anomalies that are created using the Rule as a reference. This can speed up and put some consistency in the review process. </p>
<p>To create a New Rule, right-click on the parent Rule Violation and select the
<i>New Rule</i> command.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRule.png"/>
</p>
<p>
<br/>
</p>
<p>This opens the New Rule dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="NewRuleDialog.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>Add the Rule Violation Id, Title and Description in the appropriate text fields. </li>
<li>Select the Rule Class and Rank in the appropriate combo boxes.</li>
</ul>
<p>
<br/>
</p>
<h2 id="Working_with_Editors">Working with Editors</h2>
<h3 id="Opening_files_in_editors">Opening files in editors</h3>
<p>Once the Navigator view is open and Review Items are present. The items can be reviewed. Files are reviewed using various editor views to browse the content. Currently R4E is fully integrated with the Java JDT and C/C++ CDT editors and will take advantage of the special features these editors provide. &nbsp; </p>
<p>Files can be open in editors by double-clicking on them or their children in the Review Navigator. By default, files belonging to resource review items will be open in single-file editors, whereas files belonging to commit review items will be open in a compare editor. If the file is open using the child Selection/Delta/Anomaly element, then the cursor will automatically be positioned to the start of the line range that corresponds to the element. Files and also be open in the single-file editor by using the
<i>Open File in Editor</i> command from the selected element context menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="OpenFile.png"/>
</p>
<p>
<br/>
</p>
<p>Once the file is open, anomalies can be added on the contents by selecting a range in the file and using the New Anomaly command in the R4E context menu. </p>
<p>
<br/>
</p>
<h3 id="Using_Review_Annotations_and_Inline_Comments">Using Review Annotations and Inline Comments</h3>
<p>When to Review Navigator is open, Selections, Deltas and Anomalies elements will be shown as annotations in the Editor window left ruler. The text area of the editor that correspond to the position range of the element will also be highlighted.</p>
<p>The
<img border="0" src="anomalyAnnotationMarker.png"/> icons show anomalies and associated comments, the
<img border="0" src="deltaAnnotationMarker.png"/> icons show Deltas and the
<img border="0" src="selectionAnnotationMarker.png"/> icons show Selection elements.
</p>
<p>
<img border="0" src="CompareEditorAnnotations.png"/>
</p>
<p>Additionally, the single editor will also show them as markers in the overview ruler on the right side.</p>
<p>
<img border="0" src="SingleEditorAnnotations.png"/>
</p>
<p>The appearance of the annotations (highlighting colors, widgets etc.) can be chaged by going to the
<i>Window-&gt;Preferences</i> under the
<i>General-&gt;Editors-&gt;Text Editors-&gt;Annotations</i> preferences page
</p>
<p>
<img border="0" src="AnnotationPreferences.png"/>
</p>
<h3 id="Navigating_through_and_using_R4E_Annotations">Navigating through and using R4E Annotations</h3>
<p>In the compare editor, it is possible to navigate through the R4E Annotations by using the
<i>Goto Next Anomaly</i> and
<i>Goto Previous Anomaly</i> commands
</p>
<p>
<img border="0" src="CompareEditorNavigateAnnotations.png"/>
</p>
<p>In the single editor, we use the normal annotation navigations command in the main R4E toolbar. It it possible to restrict navigation to go only through the R4E Annotation by removing the navigation to other annotation type as shown below</p>
<p>
<img border="0" src="SingleEditorNavigateAnnotations.png"/>
</p>
<p>When hovering over the R4E annotation markers, information about the corresponding R4E element will be displayed in the hovering popup window. It is also possible to use contextual commands on the associated R4E element in the hovering window. This has the same effect as using contextual command on the element in the R4E Navigator.</p>
<p>
<img border="0" src="EditorAnnotationHover.png"/>
</p>
<p>Annotations are a nice and effective tool to help in performing reviews without having to go outside of the editor window.</p>
<h2 id="Working_with_R4E_Properties">Working with R4E Properties</h2>
<p>Updates to any review elements are performed via the R4E Properties View. The R4E Properties view uses the Generic Eclipse Properties View to display the R4E Properties and will show up when any Review Navigator element is selected to display the properties that are associated with this element. </p>
<p>The R4E Properties View is a tabbed properties view that consists of two tabs. </p>
<ul>
<li>The
<i>Detailed Tab</i> show properties in a custom view where they can be edited.
</li>
<li>The
<i>Classic Tab</i> displays all properties at a glance, using the default Eclipse properties layout. Take note all properties will be read-only in this tab.
</li>
</ul>
<p>Editable properties can be changed directly in the properties view. Take note that some properties can only be set when the element is created, while others could be editable only under specific circumstances (e.g. a specific element state or review phase for Formal Reviews). </p>
<p>By default, the Properties view is linked with the Review Navigator. This means that if an element of the Review Navigator is selected, the Properties view will be activated and will show the element's properties. It is possible, to remove this link by toggling on and off the
<i>Link with Properties</i> command, which is located in the Review Navigator View drop-down menu.
</p>
<p>
<img border="0" src="LinkProperties.png"/>
</p>
<p>When the Review Navigator view in unlinked, the Properties view will not be started automatically upon element selection. To activate the Properties view and see the element's properties in this case, right-click on the element and use the
<i>Show Properties</i> contextual command.
</p>
<p>
<img border="0" src="ShowProperties.png"/>
</p>
<p>A more detailed description of the properties for each element is shown below. </p>
<h3 id="Working_with_Review_Groups_Properties">Working with Review Groups Properties</h3>
<p>
<img border="0" src="ReviewGroupDetailedProperties.png"/>
</p>
<p>Properties for the Review Group Element includes: </p>
<ul>
<li>Directly in the property view:
<ul>
<li>The Group name </li>
<li>The location of the root folder where the information is stored on disk </li>
<li>The Group description</li>
<li>The Default Entry Criteria that will be set when creating child reviews </li>
</ul>
</li>
</ul>
<ul>
<li>In the Projects and Components expandable section:
<ul>
<li>The Available Projects that can be used in child reviews </li>
<li>The Available Components that can be used in child reviews </li>
</ul>
</li>
</ul>
<ul>
<li>In the Rule Sets expandable section:
<ul>
<li>The Applied Rule Sets that specify Design Rules that can be used when creating anomalies in child reviews. If the ruleset is not loaded, a little disabled icon will appear besides its name in the table. Otherwise a little checkmark icon will be displayed.</li>
</ul>
</li>
</ul>
<p>
<br/>
</p>
<h3 id="Working_with_Reviews_Properties">Working with Reviews Properties</h3>
<p>
<img border="0" src="ReviewDetailedProperties.png"/>
</p>
<p>Properties for the Review Element includes: </p>
<ul>
<li>Directly in the property view
<ul>
<li>The Review name. </li>
<li>The current Review phase. Basic and Informal reviews can have only 2 phases,
<i>Started ''and ''Completed</i>. Formal reviews have multiple phases. Refer to the formal review section for more information.
</li>
<li>A brief description of the review. </li>
</ul>
</li>
</ul>
<ul>
<li>In the Review Details expandable section
<ul>
<li>The review start (or creation) date. </li>
<li>The review due date (i.e. the date the review should be completed by).</li>
<li>The review end (or completion) date. If the review is not completed, this will show as
<i>In Progress</i>.
</li>
<li>Project Id. The value is taken for the list of possible values from the parent Review Group </li>
<li>Components. The values are taken for the list of possible values from the parent Review Group </li>
<li>The Entry Criteria that has to be met for the review to start. The default value is taken from the parent Review Group but can be modified here. </li>
<li>The Objectives for the review. </li>
<li>The Reference Materials (documents etc.) that can be used during the review </li>
</ul>
</li>
</ul>
<ul>
<li>In the Decision Information expandable section (Informal/Formal reviews only)
<ul>
<li>Meeting data for the decision meeting (Subject, Time, Duration, Location). This can be updated at any time using the
<i>Update ''button. The data can be fetched using the ''Refresh</i> button
</li>
<li>The Exit Decision that tell whether the review is accepted or if some rework has to be done </li>
<li>Participants that were part of the exit decision </li>
<li>The Total Time spent in the decision meeting.</li>
</ul>
</li>
</ul>
<ul>
<li>For formal reviews only, a phase map that show all phases and the progress of the review. Completed phases are highlighted in green and the current phase is highlighted in cyan. It also show the state and end date for the phase as well as the participant that is the phase owner. Only the phase owner can change the current phase and can thus update progress on the review.</li>
</ul>
<h3 id="Working_with_Review_Items_Properties">Working with Review Items Properties</h3>
<p>
<img border="0" src="ReviewItemProperties.png"/>
</p>
<p>Properties for the Review Item Element includes: </p>
<ul>
<li>The Participant Id of the participant that added the Item </li>
<li>The Email address of the participant that added the Item </li>
<li>The Project(s) Id(s) the file(s) included in this Item belong to </li>
<li>The Id of the change e.g. he commit Id. This is only applicable for Commit Review Items. </li>
<li>The date the change was included e.g. the commit date. This is only applicable for Commit Review Items. </li>
<li>A brief description of the changes. For Commit Review Items, this is set to the commit message.</li>
<li>The participants this Review Item is assigned to for review purposes.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Working_with_File_Contexts_Properties">Working with File Contexts Properties</h3>
<p>
<img border="0" src="FileContextProperties.png"/>
</p>
<p>Properties for the File Context Element include a section for the base (predecessor) and target (current) files. Each section contains: </p>
<ul>
<li>The Name of the file.</li>
<li>The Version tag or Id for the file.</li>
<li>The Path Information for the file.
<ul>
<li>The Repository path show the path to the remote version-controlled repository where the file is located.</li>
<li>The Absolute path show the local absolute path to the file.</li>
<li>The Project Relative Path show the relative path to the file in the Eclipse workspace.</li>
</ul>
</li>
<li>The participants this File is assigned to for review purposes.</li>
</ul>
<p>
<br/>
</p>
<h3 id="Working_with_Selections_and_Deltas_Properties">Working with Selections and Deltas Properties</h3>
<p>
<img border="0" src="ContentsProperties.png"/>
</p>
<p>Properties for the Selection and Delta Elements include the Position (i.e. the line range) where the selection or delta is located within the parent file and the participants it is assigned to for review purposes. </p>
<p>
<br/>
</p>
<h3 id="Working_with_Anomalies_Properties">Working with Anomalies Properties</h3>
<p>
<img border="0" src="AnomalyDetailedProperties.png"/>
</p>
<p>Properties for the Anomaly Element includes: </p>
<ul>
<li>Directly in the properties view
<ul>
<li>The Anomaly title. If this anomaly includes a design rule, this will be set to the title of the design rule by default. </li>
<li>The Description of the Anomaly. If this anomaly includes a design rule, this will be set to the description of the design rule by default.</li>
<li>The Anomaly current state (Informal and Formal reviews only).</li>
<li>The participant this Anomaly is assigned to for rework purposes.</li>
</ul>
</li>
</ul>
<ul>
<li>In the Anomaly Details expandable section
<ul>
<li>The Creation Date for this Anomaly.</li>
<li>The Position (i.e. the line range) where this Anomaly is located within its parent file. This is not applicable for Global Anomalies.</li>
<li>The Anomaly Class. The class describes the type of problem that is highlighted by this Anomaly (Informal and Formal reviews only).</li>
<li>The Anomaly rank. The rank sets the seriousness of the problem highlighted by this Anomaly (Informal and Formal reviews only).</li>
<li>The Rule ID that Anomaly uses, if any (Informal and Formal reviews only).</li>
<li>The Due Date for this anomaly to be resolved or addressed (Informal and Formal reviews only).</li>
<li>The Reason for Rejection. This is only applicable for anomaly that are rejected (Informal and Formal reviews only).</li>
</ul>
</li>
</ul>
<ul>
<li>In the Participant Details expandable section
<ul>
<li>The Id of the participant that added this Anomaly.</li>
<li>The Id of the participant that decided how to handle this Anomaly (Informal and Formal reviews only).</li>
<li>The Id of the participant that fixed this Anomaly (Informal and Formal reviews only).</li>
<li>The Id of the participant that does the follow-up of this Anomaly (Informal and Formal reviews only).</li>
</ul>
</li>
</ul>
<h3 id="Working_with_Comments_Properties">Working with Comments Properties</h3>
<p>
<img border="0" src="CommentProperties.png"/>
</p>
<p>Properties for the Comment Element includes: </p>
<ul>
<li>The Participant Id of the participant that added the Comment </li>
<li>The Time when the Comment was created </li>
<li>The Comment contents</li>
</ul>
<p>
<br/>
</p>
<h3 id="Working_with_Participant_Properties">Working with Participant Properties</h3>
<p>
<img border="0" src="ParticipantDetailedProperties.png"/>
</p>
<p>Properties for the Participant Element includes: </p>
<ul>
<li>Directly in the properties view
<ul>
<li>The Participant Id.</li>
<li>The Participant Email address.</li>
<li>The Number of anomalies that were added by this Participant.</li>
<li>The Number of comments to anomalies that were added by this Participant.</li>
<li>The Focus Area for the Participant for this review.</li>
</ul>
</li>
</ul>
<ul>
<li>In the User Details expandable section
<ul>
<li>Extra User details. This will show the raw information returned by a query to the LDAP database, if one is configured.</li>
</ul>
</li>
</ul>
<ul>
<li>In the Role Management expandable section
<ul>
<li>The Participant roles for the current review. A participant can have more than one role concurrently. </li>
</ul>
</li>
</ul>
<ul>
<li>In the Time Management expandable section
<ul>
<li>A table that tracks the Time Spent by the participant reviewing the file. Entries can be added (or removed) by the participant at any time by using the
<i>Add ''(or ''Remove</i>) button. The table will also show the cumulative time spent in its header.
</li>
</ul>
</li>
</ul>
<h3 id="Working_with_Rule_Sets_Properties">Working with Rule Sets Properties</h3>
<p>
<img border="0" src="RuleSetProperties.png"/>
</p>
<p>Properties for the Rule Set Element includes: </p>
<ul>
<li>The Rule Set version </li>
<li>The Rule Set name </li>
<li>The Path to the file that contains the Rule Set data</li>
</ul>
<p>
<br/>
</p>
<h3 id="Working_with_Rule_Areas_and_Rule_Violations_Properties">Working with Rule Areas and Rule Violations Properties</h3>
<p>
<img border="0" src="RuleAreaProperties.png"/>
</p>
<p>Properties for the Rule Are and Rule Violation Elements only include the name of the Area or Violation. </p>
<p>
<br/>
</p>
<h3 id="Working_with_Rules_Properties">Working with Rules Properties</h3>
<p>
<img border="0" src="RuleProperties.png"/>
</p>
<p>Properties for the Rule Element includes: </p>
<ul>
<li>An Identifier that uniquely identifies this Rule. </li>
<li>The Title. The Anomaly that include this rule will have its title set to this by default. </li>
<li>The Description. The Anomaly that include this rule will have its description set to this by default. </li>
<li>The Class. The Anomaly that include this rule will have its class set to this by default. </li>
<li>The Rank. The Anomaly that include this rule will have its rank set to this by default.</li>
</ul>
<p>
<br/>
</p>
<h2 id="Using_Key_Bindings_and_Hotkeys">Using Key Bindings and Hotkeys</h2>
<h4 id="Keys">Keys</h4>
<p>Eclipse allows you to customize your keyboard using
<i>General&gt;Keys</i> preference page. Within Eclipse, key strokes and key sequences are assigned to invoke a command.
</p>
<h4 id="Bindings">Bindings</h4>
<p>R4E defines some keys as accelerator keys to help the user to perform reviews. Each command starts with ALT +4 as below: </p>
<p>
<img border="0" src="DefaultKeyBindings.png"/>
</p>
<p>
<img border="0" src="DefaultKeyBindings2.png"/>
</p>
<p>
<br/>
</p>
<ul>
<li>ALT +4 A&nbsp;: Add Review Anomaly. Available from any editor View. There must be a selection in the editor to create a new Anomaly. </li>
<li>ALT +4 -&nbsp;: Collapses the Review Navigator View tree. </li>
<li>ALT +4 D&nbsp;: Change Display type. Toggles between the Tree and Tree Table displays for the Review Navigator View. </li>
<li>ALT +4 =&nbsp;: Expand all elements of the Review Navigator View tree. </li>
<li>ALT +4 F&nbsp;: Opens a dialog used with the Version Control System connector to Find new Review Items. A Project needs to be selected first before using this shortcut. </li>
<li>ALT +4 I&nbsp;: Add Review Item. Available from any editor View. There must be a selection in the editor to create a new Review Item. </li>
<li>ALT +4 L&nbsp;: Add a new Linked Anomaly to the selected Review Navigator Selection/Delta element, if any.</li>
<li>ALT +4 N&nbsp;: Progress the selected element (Review or Anomaly) to its next logical state </li>
<li>ALT +4 O&nbsp;: Open the default editor on the selected Review Navigator element, if any</li>
<li>ALT +4 P&nbsp;: Regress the selected element (Review or Anomaly) to its previous logical state</li>
<li>ALT +4 R&nbsp;: Refresh the Review Navigator View.</li>
<li>ALT +4 S&nbsp;: Mark/Unmark the selected Review Navigator element as Reviewed, if any. </li>
<li>ALT +4 X&nbsp;: Remove (disable) the selected Review Navigator element, if any.</li>
</ul>
<p>When selecting the accelerator key ALT + 4, if the user waits before selecting the next accelerator key, a commands list like the one shown above will be displayed at the bottom right corner of the Eclipse window.</p>
<p>The default Copy and Paste accelerators (CTRL+C, CTRL+V) are also available in the Review Navigator view to clone Anomalies and Comments.</p>
<h2 id="Using_Notifications">Using Notifications</h2>
<p>R4E support sending Meeting and E-mail notifications directly from the Eclipse workbench. Notification send are pre-filled with all the relevant information, making it easy to have standardized communication between the Review participants. </p>
<p>Meeting notifications also can be used to schedule various meetings (e.g. decision meetings) automatically. </p>
<p>
<br/>
</p>
<h3 id="Using_Email_Notifications">Using Email Notifications</h3>
<p>E-mail notification can be sent on Review Navigator elements by using the
<i>Send Email/Notification</i> command from the selected element context menu.
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="SendEmail.png"/>
</p>
<p>
<br/>
</p>
<p>Once the command is triggered, a dialog appears asking the kind of notification to be sent. Take note that not all the options are available depending on the element selected, the review type and other factors. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="SendEmailDialog.png"/>
</p>
<p>
<br/>
</p>
<p>Selecting one option and closing the dialog will show up a simple email client pre-filled with all the relevant information. The user is free to modify the information as he sees fit and send the email by clicking the ''OK ''button. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="SendEmailClientForm.png"/>
<br/>
</p>
<p>
<br/>
</p>
<h3 id="Using_Meeting_Notifications">Using Meeting Notifications</h3>
<p>Meeting can also be scheduled directly in the workbench using R4E. Meeting data generated is in a VCalendar format that is attached to the Email that will be sent. Meeting data for decision meeting is mandatory for Formal Reviews and optional for other review types. </p>
<p>To add meeting data, use the ''Update ''button in the Extra property tab, under the Decision Information section, for the selected Review element. This will open the Meeting Information dialog. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="MeetingInfoDialog.png"/>
</p>
<p>
<br/>
</p>
<p>The meeting information to enter include the time of the meeting, the duration and location where the meeting will take place. To make the time entry easier, you can use the date selector button (the
<i>"..."</i> button on the right side of the
<i>Starts</i> text field).
</p>
<p>
<br/>
</p>
<p>
<img border="0" src="MeetingInfoDate.png"/>
</p>
<p>The meeting info stored in the system can be retrieved at all times by using the ''Refresh ''button in the Extra property tab, under the Decision Information section, for the selected Review element. </p>
<p>
<br/>
</p>
<h2 id="Using_Statistical_Reports">Using Statistical Reports</h2>
<p>Statistical reports provide useful information to analyze the efficiency of one or several reviews.
To have this functionality available, you need to install the report feature on top of the R4E feature.</p>
<h3 id="Generating_Reports">Generating Reports</h3>
<p>To generate a statistical report, select in the Review Navigator view one or more review, the right click and select "Generate Report"</p>
<p>
<img border="0" src="GenerateReport.png"/>
</p>
<p>Two types of report can be generated.</p>
<ul>
<li>Inspection record: when you select only one review to generate a report, this type of report will be initiated. You will see a list of anomalies at the end of the report.</li>
</ul>
<ul>
<li>Global report: when two or more review are selected. It gives a summary of information based on the selected reviews.</li>
</ul>
<p>The report folder is located under the group folder. The group folder is specified in the R4E Preferences,</p>
<p>If the user is not allowed to create a report in the existing group report directory, a new pop-up allows the user to select or to create a new directory to save the requested report. The user can enter a path or select the Browse button to select a location where to store the report. </p>
<p>
<br/>
</p>
<p>
<img border="0" src="r4e_report_dir_selection.png"/>
</p>
<p>
<br/>
</p>
<p>When the report generation is completed, a pop-up window will indicate where the report was stored.</p>
<p>
<br/>
</p>
<p>
<img border="0" src="GeneratingReport.png"/>
</p>
<p>
<br/>
</p>
<p>Once the OK button is clicked, the HTML report will be displayed in the default web browser or in the Eclipse web browser depending on the Eclipse web browsing preferences.</p>
<h3 id="Report_Contents">Report Contents</h3>
<p>
<br/>
</p>
<p>
<img border="0" src="Inspection1.png"/>
</p>
<p>
<br/>
</p>
<h4 id="Report_Summary">Report Summary</h4>
<p>This section lists the reviews that were selected for the report. The review name, group, component, review item type, review type and project information are displayed for each review. The total number of reviews is also displayed at the bottom of this section when more than one review was selected.</p>
<h4 id="Review_Anomaly_Statistics">Review Anomaly Statistics</h4>
<p>This section provides the following anomaly counts.</p>
<ul>
<li>Totals: Total number of anomalies. </li>
<li>Ranking: Breakdown of minor and major anomalies. </li>
<li>Class: Breakdown of anomalies per class. </li>
<li>State: Breakdown of anomalies per state. </li>
</ul>
<h4 id="Review_Efficiency_Statistics">Review Efficiency Statistics</h4>
<p>This section provides several interesting review efficiency statistics divided in the following groups.</p>
<h5 id="Review_Items">Review Items</h5>
<ul>
<li>Total number of files: Total number of files for which review items have been specified. </li>
<li>Total Review Items: Total number of review items. </li>
<li>Total LOC: Total number of reviewed lines of code as specified by the review items. This total includes blank lines and lines with comments. </li>
<li>Number of Participants: Total number of participants. </li>
<li>LOC / Participant: Number of reviewed lines of code per participant. </li>
<li>Preparation Review Rate: Number of reviewed lines of code per hour spent to perform the examination of review items (preparation time). </li>
<li>Decision Review Rate: Number of reviewed lines of code per hour spent at the decision meeting. </li>
</ul>
<h5 id="Review_Anomalies">Review Anomalies</h5>
<ul>
<li>Preparation Review Rate: Number of created anomalies per hour spent to perform the examination of review items (preparation time). </li>
<li>Decision Review Rate: Number of created and imported anomalies per hour spent at the decision meeting. The decision time is based on the meeting time multiplied by the number of meeting participants. For example, if a decision meeting lasts 1 hour and has 3 participants, the decision time is 3 hours. </li>
<li>Defect Density: Number of accepted anomalies (in states Accepted, Fixed and Verified) per reviewed lines of code. </li>
<li>Anomaly / Participant: Number of created anomalies per participant. </li>
</ul>
<h5 id="Average_Time_Line">Average Time Line</h5>
<ul>
<li>Review Start: Review start date. This is only valid when only one review was selected for the report. </li>
<li>Review Completion: Review completion date. This is only valid when only one review was selected for the report. </li>
<li>Review Cycle: Average number of days for a review cycle (all review phases). </li>
<li>Planning Phase: Average number of days spent in the planning phase. This statistic is only valid for formal reviews. </li>
<li>Preparation Phase: Average number of days spent in the preparation phase. This statistic is only valid for formal reviews. </li>
<li>Decision Phase: Average number of days spent in the decision phase. This statistic is only valid for formal reviews. </li>
<li>Rework Phase: Average number of days spent in the rework phase. This statistic is only valid for formal reviews. </li>
</ul>
<h5 id="Average_Effort_per_Participant">Average Effort per Participant</h5>
<ul>
<li>Preparation Time: Average time spent to perform examination of review items per participant. </li>
<li>Decision Time: Average time spent at the decision meeting in hours per participant who participated in the meeting. </li>
<li>Average Review Time: Average review time spent per participant.</li>
</ul>
<h5 id="Total_Review_Effort">Total Review Effort</h5>
<ul>
<li>Preparation Time: Total time spent to perform examination of review items (preparation time). </li>
<li>Decision Time: Total time spent at the decision meeting. The decision time is based on the meeting time multiplied by the number of meeting participants. For example, if a decision meeting lasts 1 hour and has 3 participants, the decision time is 3 hours. </li>
<li>Total Review Time: Total review time.</li>
</ul>
<h5 id="List_of_Anomalies">List of Anomalies</h5>
<p>This section is only available for the inspection record. The list of anomalies raised during the review with the following information:
File Name, line range, tile of the anomaly, class, ranking and the due date.</p>
<h2 id="Performing_Reviews">Performing Reviews</h2>
<h3 id="Performing_Basic_Reviews">Performing Basic Reviews</h3>
<p>In R4E, basic reviews are the simplest form of reviews available. Basic reviews are stateless and the anomalies that are raised are also stateless. This means the participants must track progress of the Review and of the raised Anomaly externally. </p>
<p>Typically, the workflow of a basic review will go as follows: </p>
<ol>
<li>Review is created </li>
<li>Review Items are added, either by manually selecting resources or by automatically selecting files committed using the Find Review Items command on the target project .</li>
<li>Optionally, review elements are assigned to specific participants.</li>
<li>Organizer/Lead notifies reviewers that the items are ready for review. his can be done externally or by using the Email notification functionality provided by R4E </li>
<li>Reviewers review their items and raise anomalies as they encounter them. </li>
<li>At any time there could be communication between the reviewers and the authors of the code under review. Since there is no anomaly state tracking, they will have to agree on how to handle the anomalies raised. </li>
<li>Once all the reviewers are done and the anomalies are fixed, the review can be set as completed.</li>
</ol>
<p>
<br/>
</p>
<h3 id="Performing_Informal_Reviews">Performing Informal Reviews</h3>
<p>Informal Review workflow is pretty much the same as the Basic Review workflow, so the steps described above still apply. However, the main difference is the fact that anomalies are now stateful and they need to be addressed/resolved before the review can be closed. </p>
<p>The state diagram for the anomaly workflow is as follows: </p>
<p>
<img border="0" src="InformalAnomalyStates.png"/>
</p>
<ul>
<li>Assigned: This is the state set when the anomalies are created. This is the only non-terminal state </li>
<li>Deferred: The Anomaly will is valid but will not be fixed now, but at a later time </li>
<li>Duplicated: The Anomaly is a duplicate of another one </li>
<li>Rejected: The Anomaly is invalid and will not be fixed </li>
<li>Fixed: The Anomaly is valid and was fixed. This is normally a terminal state, unless the Review Exit Decision is set to Accepted with Follow-up, in which case the Verified state is the terminal one. </li>
<li>Verified: The Anomaly was fixed and verified by the participant that raised it. This state is normally optional, but all Anomalies that are fixed should be subsequently set to verified is the Review Exit Decision is set to Accepted with Follow-up.</li>
</ul>
<p>
<br/>
</p>
<p>Once all the Anomalies are in a terminal state, the review can then be closed as it is done for Basic Reviews. </p>
<p>
<br/>
</p>
<h3 id="Performing_Formal_Reviews">Performing Formal Reviews</h3>
<p>Formal Review follow the IEEE 1028-1997 standard. They are stateful and divided into Review Phases. As in Informal Reviews, anomalies created are also stateful. </p>
<p>The state diagram for Formal review workflow is as follows: </p>
<p>
<img border="0" src="FormalReviewStates.png"/>
</p>
<h4 id="Planning_Phase_2">Planning Phase</h4>
<p>The Planning phase is the active phase when the review is initially created. In this phase, the Review Organizer and/or Lead adds the contents that is to be reviewed, either manually or by selecting items from the Version Control System and adds participant that will be part of the review. Optionally, review elements are assigned to specific participants. At the end of this phase, a notification is sent to the participant that the items are ready to be reviewed, and an invitation to a decision meeting set-up by the Organizer/Lead. Once this phase is completed, it is impossible to go back to it. </p>
<h4 id="Preparation_Phase_2">Preparation Phase</h4>
<p>The Preparation phase is the phase where participants review the items included in the review and potentially raise anomalies. Once all reviewers have completed their tasks (and notified the Organizer/Lead), then the review can progress to the next phase. </p>
<h4 id="Decision_Phase_2">Decision Phase</h4>
<p>The Decision phase is where all the anomalies that were logged are analyzed and a decision is made on each of them on how to handle them. Potential outcomes include fixing the problem flagged by the anomaly, deferring it, or rejecting it if it is not valid. Once all the Anomalies are examined, a decision can be taken on how to close the review. The possible outcomes for the review at this stage is that it could be rejected and more reviewing/rework is necessary, it could be accepted as is, or it could be conditionally accepted, provided that the outstanding anomalies are fixed. </p>
<h4 id="Rework_Phase_2">Rework Phase</h4>
<p>The Rework phase is an optional phase, only used when a review is conditionally accepted, in which valid anomalies are fixed. Once the fixed are included, the anomalies will need to be re-checked to verify that the fixes are acceptable. When all the fixes are verified, the Review can be completed. </p>
<h4 id="Other_Considerations">Other Considerations</h4>
<p>Take note that there is a slight difference between the anomaly states in Informal Reviews and the ones used in Formal Reviews, as it can be seen below: </p>
<p>
<img border="0" src="FormalAnomalyStates.png"/>
</p>
<p>A new Anomaly in a Formal Review is set to
<i>CREATED ''by default. During the decision phase, it could be set to the same values as in Informal Reviews, and it can also be set to ''ACCEPTED</i>, which means that the anomaly is deemed valid and will be handled and fixed. There is no ''ASSIGNED ''state for Anomalies in Formal Reviews. The rest of the anomaly flow is essentially the same as with Informal Reviews.
<br/>
</p><hr/>
<table class="navigation" style="width: 100%;" border="0" summary="navigation">
<tr>
<td style="width: 20%" align="left">
<a href="Concepts.html" title="Concepts">
<img alt="Previous" border="0" src="images/prev.gif"/>
</a>
</td>
<td style="width: 60%" align="center">
<a href="_r4eOpenUser.html" title="R4E Documentation">
<img alt="R4E Documentation" border="0" src="images/home.gif"/>
</a>
</td>
<td style="width: 20%" align="right">
<a href="Advanced-Topics.html" title="Advanced Topics">
<img alt="Next" border="0" src="images/next.gif"/>
</a>
</td>
</tr>
<tr>
<td style="width: 20%" align="left" valign="top">Concepts</td>
<td style="width: 60%" align="center"></td>
<td style="width: 20%" align="right" valign="top">Advanced Topics</td>
</tr>
</table>
</body>
</html>