Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: REQ-20129

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 includes the same information in the standard Jira issue view, but also includes additional sections for features provided by R4JeaseRequirements.

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

Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse
R4J

easeRequirements Detail View Features

Child Requirements

Section

Feature

Status
titleUltimate
Review

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

Issue Links

displays the Review sub-tasks necessary to execute a review of requirements. See Review Cockpit.

This section is only available for the detail view of issue types configured as a Review issue in the Review Scheme associated with the selected project.

Status
titleuLTIMATE
Diagrams

This section displays the UML diagrams created for the requirement. See UML Diagrams.

Linked Issues

This section displays the links, issue key and summary of the child requirements of the selected requirement, and provides additional features for requirement management.

The section also provides the Link Graph tool, which 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. 

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

View all link entries in one unified link table. The following sections in older versions have been merged where different link operations are available based on the origin.

  • Issue Links

  • Child Requirements

  • Sub-Tasks

  • Issues in Epic

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 easeRequirements provides the custom field "R4J easeRequirements Issue Revision", which your Jira administrator can add to screens so that it is visible to users.

T4J

Test Steps

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

Operations

Child Requirements

Linked Issues

Purpose

Action

Comment

Create a new child issue

Open Link Graph

  • Select the

+ icon in the section header.
  • Complete the Create Issue dialog. 

  • Select Create.

  • Add an existing issue as child

    Select the boxed + icon in the section header
    • Display as graph option in theellipsis menu to open the Link Graph.

    Select the Show Options link in the Link Graph 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.

    • Select the Add link option in the ellipsis menu. If there are no

    child requirements
    • links, you can also

    select the 
    • select Click to add a

    child requirement from existing issues label. 
    • link.

    • Complete the

    Add Existing Issues
    • Link dialog.

    • Select

    Add

    Purpose

    Action

    Comment
    • Link.

    Reorder child requirements

    • Either drag the child requirement up and down or hover on the child requirement and then use the up and down arrows.

    Remove a child requirement

    • Hover on the requirement and then select the delete icon.

    • Select Unlink in the Unlink Child Issue dialog.

    This issue is unlinked from the parent issue, not actually deleted.

    Issue Links

    The dialog also allows linking the issue to a Confluence or web page.

    Issue link types may be restricted if there is a Data Model active for selected project.

    Create a new linked issue

    • Select

    the + icon
    • Create linked issue option in the

    section header
    • ellipsis menu.

    • Complete the Create Linked Issue dialog.

    • Select Create.

    • Complete the Create Issue dialog.

    Issue link types may be restricted if there is a Data Model active for selected project.

    Add

    link

    an existing issue as child

    • Select the

    link icon in the section header. If there are no links, you can also select Click to add a link
    • Add child issue option in the ellipsis menu.

    • Complete the Add Existing Issues dialog.

    • Select Add.

    Create a new child issue

    • Select the Create child issue option in the ellipsis menu.

    • Complete the

    Link
    • Create Issue dialog.

    • Select

    Link
    • Create.

    The dialog also allows linking the issue to a Confluence or web page

    Compare with linked issue

    • Select Compare option in the ellipsis menu on an issue to open the Comparison Tool.

    This action is available for an issue link with LINK origin.

    See Comparison Tool.

    Hover on
    • Select the

    issue link and then select the pencil icon
    • Modify link option in the ellipsis menu.

    • Complete the Modify Issue Link dialog.

    • Select Update.

    This action is available for an issue link with LINK origin.

    The dialog allows you to change the link type or mark it as suspect.

    Hover on
    • Select the

    issue
    • Remove link

    and then select the unlink icon to open the Unlink dialog
    • Select Review to review the changes that caused the link to be flagged as suspect.

    These actions are only available for links flagged as suspect.

    Clear Suspect Flag

    Select Clear to cancel the suspect flag
    • option in the ellipsis menu.

    • Select Unlink.

    Compare with linked issue

    • Select Compare on an issue to open the Comparison Tool.

    See Comparison Tool.

    • Select Show ... more links to display any links that are not displayed.

    By default at most five links are displayed.

    Open Link Graph

    Select the Display as graph icon in thesection header to open the Link Graph.

    Select the Show Options link in the Link Graph 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.

    This action is available for an issue link with LINK origin.

    • Select the Review suspect option in the ellipsis menuto review the changes that caused the link to be flagged as suspect.

    This action is available for an issue link flagged as suspect with LINK origin.

    Clear Suspect Flag

    • Select the Clear suspect option in the ellipsis menuto cancel the suspect flag.

    This action is available for an issue link flagged as suspect with LINK origin.

    Remove Confluence Page

    • Select the Remove Confluence page option in the ellipsis menu.

    • Select Remove in the Remove Confluence Page dialog.

    This action is available for a Confluence page with LINK origin.

    • Select the Remove web link option in the ellipsis menu.

    • Select Remove in the Remove Web Link dialog.

    This action is available for a web link with LINK origin.

    Remove a child requirement

    • Select the Remove child issue from tree option in the ellipsis menu.

    • Select Remove in the Remove Child Issue dialog.

    This action is available for a child issue with TREE origin.

    This issue is unlinked from the parent issue, not actually deleted.

    Convert sub-task to issue

    • Select the Convert to issue option in the ellipsis menu.

    • Complete the Convert Sub-task to Issue steps in Jira in a new tab.

    This action is available for a child issue with SUB-TASK origin.

    Remove from Epic

    • Select the Remove from Epic option in the ellipsis menu.

    • Select Remove in the Remove Issue dialog.

    This action is available for a child issue with IN EPIC origin.

    • Select Show more to display any entries that are not displayed.

    By default at most five entries are displayed.

    Revisions

    Purpose

    Action

    Comment

    Compare revisions

    • Select the check boxes of two revisions to open the Comparison Tool. ​

    See Comparison Tool.

    View revision details

    • Select the revision number to open the Revision Details dialog.

    The dialog shows the selected revision’s details and the baselines in which it is included.

    Show more revisions

    • Select Show ... more revisions to display any revisions that are not displayed.

    By default at most five revisions are displayed.

    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 easeRequirements 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 easeRequirements administrator maintains a so-called “blacklist” of fields that are not included in the R-4J Detail View but would be displayed in the standard Jira issue view. See Managing the Field Blacklist.

    Inline Editing

    The summary, description, and most fields under the “Details“ section of requirements and folders can be edited inline in the detail view.

    While most fields have been verified as supporting inline editing, custom field types and fields coming from third-party vendors may not be editable.

    Issue editing and field editing permissions, as well as Edit screen configurations, apply when inline editing. Read-only fields also remain un-editable. 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.

    Jira administrators can enable/disable inline editing capabilities in R4J easeRequirements by setting “Allow inline editing“ permissions.