Review Cockpit: Quickstart
- David Sedlock
- Angelica Salazar
Overview
The Review Cockpit of easeRequirements Ultimate for Jira provides a convenient way to manage the review of requirements or other types of issues. To get the most out of the Review Cockpit, the Jira administrator should configure the Jira instance to support it. This page explains the concepts of the Review Cockpit and describes how to set up both Jira and easeRequirements Ultimate for Jira to implement a straightforward Review Management configuration.
This configuration is only one of many possible configurations. easeRequirements Ultimate for Jira is very flexible and using the full potential of its configuration options, you will be able to meet the specific needs of your organization.
Concepts
easeRequirements Ultimate for Jira builds on Jira’s existing features like issue types and custom fields to implement Review Management processes. This gives you full flexibility to customize the tool according to your organization’s needs without adding unnecessary overhead to your Jira instance.
The following table explains the key concepts of the Review Cockpit and shows how Jira can be configured to support them. It is assumed the Jira administrator knows how to implement this configuration in Jira.
The recommended names in the table are just that - recommended. If your Jira instance is already configured with appropriate data types, but with different names, or if different names make more sense in your organization, easeRequirements Ultimate for Jira can be configured to use those names instead of the recommended ones.
Concept | Explanation | Jira Data Type | Recommended Name | Note |
|---|---|---|---|---|
Review | A review brings together a number of issues and a group of users that will examine them individually to determine whether to accept or reject them. | issue type | Review | A Review is represented by a Jira issue of a predefined issue type. The Review issue type should be configured in Jira to have a workflow and fields appropriate for your organization's review processes. It is recommended the workflow contain in progress and completed statuses. |
Review Scope | These are the issues that are the subject of the review. | N/A | N/A | The review scope is supported directly by the application. |
Reviewer Subtask | Each reviewer is assigned a subtask associated with the review. | sub-task issue type | Sub-task | The standard Jira sub-task issue type can be reused here. It is recommended the workflow contain in progress and completed statuses. |
Moderators | These are the users that are responsible for conducting the review and who determine when it is complete. | users custom field | Moderators |
|
Reviewers | These are the users that are responsible to review the issues in the scope of the review. | users custom field | Reviewers |
|
Jira Configuration
To implement the above-suggested configuration, you need to perform the following actions in Jira Administration:
Create the Review issue type. If it doesn’t exist already, create the Sub-task issue type and ensure that the Jira sub-task feature is enabled.
Associate the Review and Sub-task issue types with your projects using Jira Issue Type schemes.
Create the Moderators and Reviewers custom fields of type User Picker (multiple users).
Associate the fields Moderators and Reviewers with the Review issue type screen configuration.
Associate the fields Moderators and Reviewers with the Review issue type field configuration.
If the names used for the various data types in your Jira configuration differ from those recommended above, be sure to use the ones used in your instance instead of the recommended names in the configuration options below.
App Configuration
easeRequirements Ultimate for Jira is configured using Review Schemes. A Review Scheme is a collection of configuration options that can be applied to several projects - see Managing Review Schemes. The use of schemes simplifies the setup effort and ensures that the Review Management practices are applied uniformly in your organization.
At least one scheme must be created and associated with the desired projects:
Go to Jira navigation > Requirements > Review Schemes.
Select Add Scheme.
Specify the options as shown below and select Save.
Select Associate next to the new scheme.
Select the projects for the scheme and select Associate.
Review Scheme Options
Option | Recommended Value | Explanation |
|---|---|---|
Name | Default Review Scheme | Or use any name that makes sense in your organization. |
Review Issue Type | Review | The issue type used to represent reviews. |
Sub-task Issue Type | Sub-task | The issue type used to represent review subtasks. |
Reviewers Fields | Reviewers | The custom fields used for reviewers. |
Moderators Fields | Moderators | The custom fields used for moderators. |