Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: R4J v4.13: REQ-14035

Overview

The requirement detail view displays the information about a requirement. The view is located on the right side of the project tree view and is visible if a requirement is selected in the project tree. Requirements are Jira issues, so the information in the detail view is, in principle, the same as the information in the standard Jira issue view, but extended with additional features provided by R4J.

Each section in the detail view retains its expanded or collapsed state for folders and issues.

Table of Contents

R4J Detail View

R4J Section/Feature

Description

Operations

Child Requirements

This section lists the issue key and summary of the child requirements of the selected requirement.

Create a new child issue: Select the + icon in the section header to open the Create Issue dialog.

Add an existing issue: Select the boxed + icon in the section header to open the Add Existing Issues dialog. If there are no child requirements, you can select the Click to add a child requirement from existing issues label. 

Reorder child requirements: There are two ways to reorder:

  • Drag the child requirement up and down.

  • Hover on the child requirement and then select the up and down arrows. 

Delete a child requirement: Hover on the requirement then select the delete icon to open the dialog.

This section displays the links of the selected requirement and provides additional features for requirement management.

Create a new linked issue: Select the + icon in the section header to open the Create Linked Issue dialog.

Add link: Select the link icon in the section header to open the Link dialog. If there are no links, you can select Click to add a link. The Link dialog allows linking the issue to another Jira issue, a Confluence page, or a web link.

Modify link: Hover on the issue link then select the pencil icon to open the Modify Issue Link dialog. The dialog allows you to change the link type and manually mark it as suspect. 

Unlink: Hover on the issue link then select the unlink icon to open the Unlink dialog.

Compare current issue with linked issue: Select the Compare button to open the Comparison Tool. See Comparison Tool.

Show more: Up to five links are displayed by default. To display the remaining links select the Show ... more links.

Link Graph

Select the Display as graph icon in the link section header to open the Link Graph tool. This tool displays the selected requirement and its linked requirements as nodes in a graph, with links displayed as edges between the nodes. The nodes can be expanded and collapsed to reveal other linked requirements. 

Show options: Select the Show Options link to display the options for filtering the requirements displayed in the view. Here you can specify which issue types and link types are used to select the requirements to be shown, as well as the fields to display. Select the option Hide Link Types to remove the link labels from the graph.

When a link is marked as a suspect in the link section, additional options for evaluating the link become available.

Review: Select the Review link to review the changes that caused the link to become suspicious.

Clear: Select the Clear link to cancel suspicion. 

Revisions

This section displays the revisions of the selected requirement, including the revision number, timestamp, the user responsible for the changes and the changes themselves are displayed. A link to a list of baselines that include a revision is also provided.

R4J provides the custom field "R4J Issue Revision", which your Jira administrator can add to screens so that it is visible to users.

Compare revisions: Compare two revisions by selecting their check boxes. See Comparison Tool.

View revision details: Click on the revision number to open a dialog that shows the selected revision’s details including the baselines it was included in.

Show more: Up to five revisions are displayed by default. To display all revisions select Show ... more revisions at the bottom of the section.

T4J Test Steps

When Test Management for Jira (T4J) is installed and the selected project is enabled for both R4J and T4J, the test steps section is displayed in the detail view.

Display Fields

There are fields that must be displayed in the detail view regardless of screen field configuration because they are intrinsic to requirements management. These fields are Status, Summary, Description, Attachment(s), Linked Issues. All of which are located in the header or as its own section in the detail view.

In the “Details“ section, multi-line fields are displayed using the full width of the detail view. The rest of the field types follow a two-column layout.

Screen Field Configuration Tabs

The “Details“ section displays selected essential fields in a fixed order regardless of screen field configuration. These essential fields are Path, Issue Type, Priority, Resolution, Assignee, Created, Updated, and Labels, respectively. Other fields are displayed according to their order in the view screen field configuration and only when they have a value.

View Screen
Has Fields

View Screen
Has Tabs

R4J Detail View
Display Format

(error)

(error)

“Details“ section contains essential fields only.

(tick)

(tick) Single Tab

“Details“ section contains essential fields, followed by other fields in configuration

(tick)

(tick) Multiple Tabs

“Details“ section contains essential fields only.

A new section will be created for each tab, with the section name being the field tab’s name. Each section will be filled with the fields assigned to the corresponding tab.

If all fields of a section do not have values, it will not be displayed.

The R4J administrator maintains a so-called “blacklist” of fields that are not included in the R4J R-4J Detail View but would be displayed in the standard Jira issue view. See Managing the Field Blacklist.

Editing

The summary and description of requirements and folders can be edited inline in the detail view. Changes applied to items in the detail view are saved automatically when navigating away from the field. Additionally, changes can be saved or cancelled explicitly through the Save and Cancel buttons.