Filter, Sort and Search Requirements

Documentation / Manage

Filter Requirements

You can filter requirements from the current document by entering a condition in the Filter field, which is placed in the top right corner of the screen. To move quickly to the Filter field, press CtrlShiftF.

To display a list of suggestions for available filtering conditions, press or just start typing.

To activate or deactivate the current filter, click the icon, or press CtrlAltF.

Note: When the current filter is active, the Description column is not indented according to the section level.

Filter Enumeration Values

To filter all objects with a given value of an enumeration (enum) custom attribute, choose attribute and then an enumeration value from the filter suggestions list.

Examples:

  • Status: Implemented matches document objects with status set to “Implemented”
  • Type: Functional Requirement matches document objects with type set to “Functional Requirement”
    How to filter functional requirements.

Filter Text Values

To filter all objects matching a given text condition in a text (int, real and date) attribute or in a Template Column, choose an attribute or template column item from the filter suggestions list, and choose a keyword from the list or enter a "substring" or a /regular expression/ condition.

Note: If you choose a keyword from the list without first specifying an attribute, the keyword is matched in all text attributes.

Examples:

  • Text: traceability matches document objects with text descriptions containing the keyword “traceability”
  • Text: "will" matches document objects with text descriptions containing the substring “will”
  • Text: /\Wwill\W/ matches document objects with text descriptions containing the word “will” (case insensitive)
  • Satisfies "NEEDS-58" matches document objects containing the string “NEEDS-58” in the template column Satisfies

Filter Logical Values

To filter all objects with a given value of a Boolean (bool) attribute, choose an attribute item from the filter suggestions list.

Examples:

  • Deleted matches document objects marked as deleted
  • Dirty matches document objects changed since the last time the project was saved

Filter Numeric Values

To filter all objects with a given value of a numeric (int, real and date) custom attribute or a template column displaying just a number or date, choose an attribute or template column item from the filter suggestions list and enter one of these <, >, <=, >=, = conditions.

Examples:

  • Story Points => 5 matches document objects with estimation set to at least 5 story points
  • Costs < 1000 matches document objects with costs lower than $1000
  • Deadline <= 2018-06-30 matches document objects with deadline set to 30 June 2018 or after

Filter Null Values

You can filter all objects with a null value of a numeric or text attribute. Choose attribute from the filter suggestions list and press Enter without entering a value.

Example:

  • Text: is null matches document objects with null text attribute

Filter Section Numbers

To filter all objects from the given section, choose Section from the filter suggestion list and enter a section number.

Example:

  • Section: 1.2 matches document objects in section 1.2 and its subsections

To filter all objects with outgoing or incoming links of a given type, choose link type or link type respectively from the filter suggestions list.

Similarly, you can filter all objects with a reference origin (see Copy Objects). Choose Origin or Copies item respectively from the filter suggestion list.

Optionally, to add condition that the given link type should have Suspect Link Flag set, choose Suspect link from the filter suggestion list before a link type.

To find all dangling links, choose Dangling link from the filter suggestion list.

Examples:

  • Satisfies matches document objects with at least one outgoing satisfaction traceability link
  • Is Satisfied matches document objects with at least one incoming satisfaction traceability link
  • Origin matches document objects which were copied with enabled Link to Origin option
  • Copies matches document objects which were pasted with enabled Link to Origin option
  • Suspect link Satisfies matches document objects with at least one outgoing satisfaction traceability link with the suspect flag
  • Dangling link matches document objects with at least one outgoing dangling traceability or origin link

To filter all objects with a specific link, create a traceability column displaying all links of a given link type and filter text value.

Example:

  • Satisfies: "NEEDS-13" matches SRS requirements linked with the user story NEEDS-13 using the template column Satisfies displaying all outgoing satisfaction links.

You can use filters to find missing links. For example, to filter all functional requirements missing a satisfaction link combine filtering by object type and link type.

Example:

  • Type:FR NOT Satisfies matches Functional requirements missing satisfaction links to higher level requirements.

Filter History

To filter all objects with history of attribute changes, choose Changed from the filter suggestions list.

Afterwards, you can choose a specific attribute from the filter suggestions list and/or enter a date in YYYY-MM-DD format to filter objects that were modified on or after that date. Press Enter to finalize the condition.

Note: The word “since” is added automatically when you enter a valid date.

Examples:

  • Changed matches document objects with an attribute change entry in their history
  • Changed since 2019-06-30 matches document objects whose attributes changed on or after end of June 2019
  • Changed Status matches document objects with a status attribute change in their history
  • Changed Text since 2022-01-01 matches document objects whose text attribute changed on or after January 1, 2022

Filter Discussion

It is often useful to see comments of other users while reviewing a document, update commented requirements, and eventually delete resolved comments.

To filter all commented objects, choose Commented from the filter suggestions list.

Afterwards, you can enter a date in YYYY-MM-DD format to filter objects that were commented on or after that date. Press Enter to finalize the condition.

Note: The word “since” is added automatically when you enter a valid date.

Examples:

  • Commented matches document objects with any discussion comments
  • Commented since 2021-03-01 matches document objects commented on or after March 1, 2021
  • Commented NOT Commented since 2021-03-01 matches document objects commented before March 1, 2021
  • Commented since 2021-01-01 NOT Commented since 2021-03-01 matches document objects commented between January 1, 2021 and March 1, 2021

Note: Directly adjacent conditions (gray boxes) are implicitly joined by the AND logical operator. See below for explanation.

Logical Operators

To filter a combination of several conditions, use AND, OR and NOT logical operators in disjunctive normal Form (DNF) according to the following rules:

  • Filters can consist of one or more logical clauses joined by logical OR. The filter matches an object if any clause is valid for the object.
  • Each logical clause can consist of one or more conditions joined by logical AND. A clause is valid for an object if all conditions are valid.
  • Any logical condition can be negated by logical NOT operator.
  • Each logical condition is valid if of the provided values match the condition criterion.

Example: Filter all document objects with attribute type set to “User Story” AND attribute status set to “Verified”.

Example: Filter document by object attribute type and status

Example: Filter all user stories in which an editor can open or save, or an architect can create.

Example: Filter user stories by user roles and keywords

Sort Requirements

To sort the current document, click on a chosen column heading. To change the sort order, click on the same column heading again. To reset to the default sorting with the natural document order, click on the Description column heading.

Note: You cannot sort by Custom Attributes, Discussion, and Links columns.

Go to Requirement

To navigate directly to the document object with a specific ID, click Document and select Go To, or press CtrlG. In the Go To dialog, enter the object ID, including the document ID prefix if the object is from a different document.

Go To dialog with Requirement ID

Search Requirements

You can search for a keyword in the current document using the Search input field placed next to the Filter in the top right corner of the screen. To activate the Search field, click Document and select Search, click the icon, or press CtrlF.

When you enter a searched keyword in the Search field, all document objects containing the keyword in any of its string or xhtml attributes are highlighted. To navigate to the next or previous highlighted object, click on the icon on the right of the search input field or press F3 or ShiftF3 respectively.

Updated for version 2.15.0