Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: REQ-16533
The Suspect Concept

Overview

With R4J you can structure your requirements/issues with allows you to use Jira issue links . This allows you to clearly define the relationships and dependencies between requirements .Suspects take this concept of dependency management one step further. They bring in the functionality to monitor changes in your issues automatically and mark their direct relationships "suspect" or other types of issues. When one requirement depends on another requirement, it can be useful to know when the latter requirement changes, since that may require corresponding changes in the dependent requirement.

R4J introduces the concept of suspect links to help you spot such cases and take appropriate action. R4J automatically monitors changes in your requirements and flags linked issues as "suspect" in order to identify them for review. This feature allows you users to change your requirements and immediately know what other issues then determine which other requirements might be affected by the changes you made.You can display the identified issues either in the issue detail view in . After review, the suspect flag can be removed.

Suspect links are identified in the following ways:

  • The Suspect Report (see below) provides a list of requirements with suspect links in a given project.

  • In the section "Issue Links"

as textual and graphical representation, in the coverage and traceability matrix or as suspect report. It's also possible to search for identified issues with the advanced search functionality
  • in a requirement's Detail view, any link types with suspects are marked as “(suspect)”.

  • Requirements with suspect links are marked in the Coverage View and Traceability Matrix.

  • Requirements with suspect links can be identified in the Jira Issue Navigator using the search functionhasSuspectLink()- see Advanced Search.

To configure the rules for flagging suspect triggers links see Configuring the Suspect Logic.

Table of Contents
indent20px

Suspect Report

Generating

To create a Suspect Report

Select 

, select Requirements > 

Suspect Report

Suspect Report from the main navigation bar

Select

, select the relevant project

Optional: Configure filters to apply on the report:
  • Include links to other projects: if checked the report will also contain relationships to and from issues of different JIRA projects
  • Period: if checked the report will only contain suspects whose timestamp is

    and the “Go” button. The report is a table with a row for every suspect link. The Search field can be used to search the report for rows containing a given piece of text.

    Include links to other projects

    Include cross-project links flagged as suspect.

    Period

    Restrict to issues with suspect flags created within the specified time period.

    Link type(s)

    : if checked the report will only contain suspects whose link type matches one of the specified types
    (lightbulb) Selecting "All Types" is the same as not using the "Link Type"-filter at all
  • User: if checked the report will only contain suspects whose modifier of the changed issue matches one of the specified users
  • Click on the Go button to generate the report
  • What information does the Suspect Report contain?

    The suspect report consists of a table with the following columns:

    Restrict to specific link types.

    The link type name, not the link description, is used to specify the link type (e.g. “Trace”, not “trace to”). The report shows the link description from the point of view of the changed issue (e.g. “trace to”).

    User

    Restrict to changes made by the specified users.

    Changed Issue

    The

    changed

    issue

    that triggered the suspect.

    Contains the project id (linked to the issue in the project tree or issue navigator), the summary of the issue that changed and the revision for every suspect.

    (info) The table will contain a separate row for every relationship of a changed issue marked as suspect

    whose change triggered a suspect rule.

    Linked Issue

    The

    linked

    dependent issue that might be affected by the

    changes.

    Contains  the project id (linked to the issue in the project tree or issue navigator), the summary of the linked issue and the revision for every suspect link.

    change.

    Link Type(s)

    The

    link type between

    outward description of the link (or links if there are more than one) from the changed issue

    and

    to the

    linked

    dependent issue.

    User

    The user who made the

    changes that triggered the suspect

    change.

    Suspect Timestamp

    The date and time of the

    suspect was triggered the end of every table row allows you to remove the suspect mark from the corresponding relationship

    change.

    Action

    Contains three buttons to either compare/review the changed issue and the linked issue or to clear the suspect.

    Working with the Suspect Report

    Search the report

    To search the report for specific suspects click into the Search field located at the upper right corner of the report. It is possible to search for every entity of the report except for the available actions.

    Compare Changed and Linked Issue

    The Compare button at the end of every table row brings up a dialog to compare the changed issue against the linked issue.

    Review Changed Issue

    The Review button at the end of every table row brings up a dialog to compare the revision of the issue caused the suspect entry against the revision before.

    Clear Suspect

    The Clear button at

    Provides the following actions:

    • Compare the differences between the two issues.

    • Review the exact change that triggered a suspect rule.

    • Clear the suspect flag.

    How to clear the suspect flag

    There are two ways to clear the suspect flag:

    • Suspect Report: In the Report in the Action column of a given requirement, use the option Clear.

    • Detail view: In the section "Issue Links” in a requirement’s Detail view, use the option Clear.