The Review Support extension consists of two views: Review Setup and Review Support. The Review Setup view aids in setting up reviews and distributing tasks to people involved in a review. The Review Support view supports users in performing reviews. This article describes how to configure both of these views. The configuration is identical with the exception of the top two tags. 


Prerequisites


Example Meta Model



Example Review Setup View

 

Example Review Support View


Configuring the Views

Review Setup

  1. Go to File > Configure the explorer
  2. On the Item views tab, select Review Setup to configure the setup of the Review.



  3. Click View example XML and copy the script as a starting point for your configuration. 
  4. Click Edit configuration and paste the script in the Edit XML window. (If there are existing <ReviewSetupConfig> sections there, just add this new config below them within the <ReviewSetupConfig> tag.) 
  5. Modify the configuration to meet the needs of the use case. (See the explanation of available elements below.)
  6. When you are ready to test and make it available to users, check the Active box. Users must log out and back in to see the new option.

Review Support

  1. On the Item views tab, select Review support to configure the view used by users to conduct the review. 
  2. Repeat the above steps to complete the configuration.


Explanation of the Configuration Elements


For Review Setup Only:

<ReviewSetupConfigs> is the top tag which can include one or more <ReviewSetupConfig>.

<ReviewSetupConfig> is the top tag of each configuration and must have an id attribute. The id attribute in identifies the specific configuration, and should be a unique string value when multiple configurations exist. 


For Review Support Only:

<ReviewSupportConfigs> is the top tag which can include one or more <ReviewSupportConfig>.

<ReviewSupportConfig> is the top tag of each configuration and must have an id attribute. The id attribute identifies the specific configuration, and should be a unique string value when multiple configurations exist. 


<ViewSettings> enables you to set a custom view menu label, menu group, hover-tip, icon, for the view. See How to Configure Item View Menu Button Settings. Example: 

        <ViewSettings>
            <Caption>ABC Model Review Setup</Caption>
            <RibbonGroup>Review Test</RibbonGroup>
            <Description>Use for ABC Model reviews</Description>
            <Image guiImage="12"/>
        </ViewSettings>


<Project/> contains the id attribute (project handle) which indicates the handle of the project that contains the Issue Types defined for performing a Review. See Where do I Find the Project ID? for where to obtain the id for your project. 


<Review/> contains an issueType attribute which should indicate the name of the issue type representing a Review. 


<Task/> contains an issueType attribute which should indicate the name of the issue type representing a Task in the Review.  


<Comment/> contains an issueType attribute which should indicate the name of the issue type representing a Comment for a reviewed Item in a Task.


Example Issue Types, i.e., Review, Review Task, and Comment in the Project


 


<ReviewToItem/> contains a relationType attribute which should indicate the SID of the Relationship Type that connects a Review to an Item, defining the Item structure that is the target of the Review.


<TaskToItem/> contains a relationType attribute which should indicate the SID of the Relationship Type that connects a Review Task to an Item, defining the Item in question that the task activity is made on.


<CommentToItem/> contains a relationType attribute which should indicate the SID of the Relationship Type that connects a Comment to an Item, defining the Item in question that the remark is made on.


<ReviewToTask/> contains a relationType attribute which should indicate the SID of the Relationship Type that connects a Review to a Task, defining the activities to be performed in the Review.


<TaskToComment/> contains a relationType attribute which should indicate the SID of the Relationship Type that connects a Task to a Comment defining a remark made in the Review.


<AllowDeleteIssues/>  defines if Reviews, Comments, and/or Review Tasks can be deleted using the attributes deleteComments="true" deleteReviews="true", and deleteTasks="true".

XML

Example Review Setup Configuration

<ReviewSetupConfigs>
    <ReviewSetupConfig id="1">
        <ViewSettings>
            <Caption>Review Setup</Caption>
            <RibbonGroup>Review</RibbonGroup>
            <Description>This view supports in performing reviews</Description>
            <Image guiImage="12"/>
        </ViewSettings>      
        <Project id="x260000000000095B"/>
        <Review issueType="Review"/>
        <Task issueType="Review Task"/>
        <Comment issueType="Comment"/>
        <ReviewToItem relationType="IREL"/>
        <TaskToItem relationType="ITAS"/>
        <CommentToItem relationType="ICOM"/>
        <ReviewToTask relationType="TASK"/>
        <TaskToComment relationType="COMM"/>
        <AllowDeleteIssues deleteComments="true" deleteReviews="true" deleteTasks="true"/>
    </ReviewSetupConfig>
</ReviewSetupConfigs>




XML



Example Review Support Configuration
<ReviewSupportConfigs>
    <ReviewSupportConfig id="1">
        <ViewSettings>
            <Caption>Review support</Caption>
            <RibbonGroup>Review</RibbonGroup>
            <Description>This view supports in performing reviews</Description>
            <Image guiImage="12"/>
        </ViewSettings>      
        <Project id="x260000000000095B"/>
        <Review issueType="Review"/>
        <Task issueType="Review Task"/>
        <Comment issueType="Comment"/>
        <ReviewToItem relationType="IREL"/>
        <ReviewToTask relationType="TASK"/>
        <TaskToComment relationType="COMM"/>
        <CommentToItem relationType="ICOM"/>
        <TaskToItem relationType="ITAS"/>
        <AllowDeleteIssues deleteComments="true" deleteReviews="true" deleteTasks="true"/>
    </ReviewSupportConfig>
</ReviewSupportConfigs>


Note: The configurations for Review Setup and Review Support are identical, with the exception of the top two tags.

What's Next?

Initiating a Review Using the Review Setup View

XML