The Review Setup extension view aids in setting up reviews and distributing tasks to people involved in a review. It is built upon the SystemWeaver Change Management System (CMS). So while the option is always available to you to work in Projects to create and/or view reviews and review tasks, the Review Setup view lets you work "closer" to the items during setup.
This article describes how to use the view to create a review and its tasks.
- Getting Acquainted with the View
- Creating a Review
- Changing Review Status and Description
- Locking and Unlocking Review Setup View
- Creating a Review Task
- Assigning and Un-assigning a Review Task
- Changing Task Status and Description
- Unlinking an Item from a Review Task
- Linking an Item to an Existing Review Task
- Deleting Reviews and Tasks
- Things to Consider
- An installation of the SystemWeaver Explorer client (swExplorer) version R35 or later
- The SystemWeaver SWExtension.ReviewSupport extension views have been configured and activated by an Architect
- The SWExtension.ReviewSupport extension file is located in the Client's swExplorerExtensions directory
- The Review Project is configured and "Write" access rights given to all users participating in the review
The view is accessible via menu options on the ribbon that have been configured by an Architect. Below is an example of a configured option.
Example Menu Option
The view is also available via the View drop-down at the bottom of the list by ribbon group name.
Getting Acquainted with the View
The view consists of two panes - Review and Tasks.
The Review section is where you create and view reviews for the selected item structure. The following information about the review is provided:
- Name: The name of the review
- Status: The status of the review
- Assigned to: The user who is assigned to the review
- Reporter: The reporter of the review, i.e., the user who created the review
- Description: The description content of the review issue
There is support for one or multiple reviews. A drop-down list is provided.
The Tasks section is where you create and view review tasks linked to a selected review.
There is a pane splitter that can be used to adjust the size of the Review and Tasks panes to fit your needs.
The colored border on the far left side of each Review and Review Task entry is an indicator of its status.
Example Review and Tasks
Creating a Review
The first step is to create a Review issue. To do this, click the Add review button located to the far right.
The New issue dialog will display with the Project pre-populated, and issue Type pre-set to "Review". This is the same dialog used in CMS Projects so you will likely recognize it.
You must enter a Name for the review, and you have the option to set an Assigned to, change the Status (if allowed), and/or enter some Description content.
The Review issue that is created will automatically be linked to the selected item in the tree by default. When ready, click Create to complete the creation of the Review issue. An entry for the newly created Review will display in the view:
Additional reviews can be created for the same selected item if needed by repeating the above steps. Below is an example of an item that has 3 reviews linked to it.
Changing Review Status and Description
You can update the Status, and enter content in the Description at any time by double-clicking in the white area to open the Description editor.
Locking and Unlocking the Review
The view provides a very useful Lock option so that you can navigate away from the selected item and move throughout the tree while keeping the view locked in place. We recommend that you lock the review during your review work. To lock the view, first select the review that you want to lock from the drop-down, then click the lock button to the far right of the review.
In the below example, the "Review of naming consistency" review that is linked to "ClassicNode" item, will be locked in place.
This feature is useful when creating tasks in a review that will be linked to different items in the structure.
To unlock the view at any time, click the lock button again.
Creating a Review Task
Once the review is created, you can add tasks to it. To start, select the item that the new task should be linked to. To do this, you may want to use the Lock option described above so that you can navigate freely. Once you have selected the item, click the + button to create and link a task to it.
Just like with review creation, the New Issue dialog will appear with the Project pre-populated. The issue Type will be pre-selected to "Review Task".
You must enter a Name for the task, and you have the option to set an Assigned to, change the Status (if allowed), and/or enter some Description content. These later three can be set later as well.
The Review Task issue that is created will automatically be linked to the selected review and item.
When ready, click Create to complete the creation of the task. An entry for the newly created task will display in the view:
In the below example, two tasks are linked to the "Review for naming consistency" review, and each task is linked to a different item, i.e., "ClassicNode", "AdaptiveDefrosterExample".
Assigning and Un-assigning a Review Task
As mentioned above, when you create a new task, you can assign it to someone upon creation by selecting a user from the Assigned to list.
To assign an existing task to a user, there are two options - Choose user and Assign to reporter.
Choose user is used to assign the task to any user who has access to the review project
Assign to reporter is used to assign the task to the user who created the review.
Changing Task Status and Description
You can update the Status of the task or add content, e.g., instructions or comments, to the Description at any time. To modify the Description, first click on the expand button, and then double-click in the white area to open the Description editor.
Unlinking an Item from a Review Task
If an item is mistakenly linked to task, there is a Disconnect/Connect tool to unlink and link items and tasks.
To unlink an item, click the unlink button located to the right of the On Item: value. The item is immediately unlinked from the task.
Another way to unlink from one item and link to another, is to select the new item in the tree and click directly on the current On Item value. In the below example, the item will be changed from "SystemExample" to "ClassicNode"
Click Yes to the Item selected confirmation dialog.
Linking an Item to an Existing Review Task
To link an item to an existing review task, select the item in the structure tree and click the link button next to On Item for the task you want to link the item to.
Deleting Reviews and Tasks
The view provides an easy way to delete tasks from a review. Load the review and then find the task you want to delete and click the X.
To confirm the deletion, click Yes in the confirmation pop-up.
The task is now deleted from the database.
To delete an entire review, click the X on the review entry.
To confirm the deletion of the review, click Yes in the confirmation pop-up.
The review and all of its linked tasks will be deleted from the database.
Things to Consider
- Remember that all users performing review tasks must have "Write" access to the review project.
- All reviews and review tasks, and all relationships between them that are created via the view are also viewable and editable via Projects. The below example shows a selected Review issue with its linked Item "SystemExample", and its two linked tasks.
Once the review is set-up, users can use the Review Support view to perform their review tasks and add comments.