The research module

Prev Next

The classic search mode

The main element of the report is the search module that will allow you to select and filter information.

Search interface for task reports with various filter options and a search button.

You can select and edit the report you want by choosing it from the selection menu.

Overview of tasks report with highlighted sections for better visibility and organization.

You can add or remove search criteria using the drop-down Dropdown menu displaying various criteria options for filtering data in a user interface. menu on the right.

To validate the search criteria and get a result, click on the search button.

Search button prominently displayed, inviting users to initiate a search action.

Depending on the types of fields, different searches can be performed.

"Text" fields

Summary section indicating a bug report for software or application issues.

 It is possible to search for strings in the "text" fields. Here we look for the term "Bug" in the "Summary" field of the artifacts.

Leaving the criterion blank is tantamount to not using it.

Practical information

The search ignores the differences between upper and lower case letters.

"Simple List" or "Multiple-Choice List" fields.

The fields below are multiple choice lists, for these types of fields it is possible to choose a value from the drop-down menu, in the example above we will select all the artifacts of the tracker whose status is "New" and whose severity is "Critical impact".

Severity marked as critical impact and status indicated as new in the system.

"Any" means any value, choosing this option means not using a filter on that particular field.

Filters for severity and status options in a user interface for data management.

"None" means that the field has not been filled in or is empty, by choosing this option, we select only the artifacts whose corresponding fields are empty.

Dropdown menus for selecting severity and status options in a user interface.

The drop-down menu next to the field name allows you to select several values from the list:

Options for severity and status selection in a project management interface.

Artifacts are filtered by their "New" or "In Progress" status, and by their "Major Impact" or "Critical Impact" severity.

Task list showing various statuses and assigned individuals for project management.

"Date" fields

It is possible to search in the date fields of the artifacts.

Submission date field with options for sorting and a calendar icon for selection.

Leaving the date blank means not using the criterion.

On the right, the image representing a calendar Calendar icon representing scheduling or planning events and activities effectively. allows you to choose a date.

On the left, a drop-down list allows you to choose the type of search:

  • Dropdown menu labeled 'After' with upward and downward arrows for selection. : Later than configured

  • Dropdown menu labeled 'As of' with an arrow indicating selection options. : Same date as configured

  • Dropdown menu labeled 'Before' with an upward arrow indicating selection options. : Earlier than configured

Finally, the date window option can be accessed by expanding the selection criterion with the "+" to the left of the criterion name.

Submission dates for a project, including start and end dates in a form.

In this mode, it is therefore possible to select a search window between a start date and an end date.

Table displaying tasks with titles, artifact IDs, statuses, and submission dates.

Multi-criteria search

Of course, it is possible to select several criteria at the same time in a report.

For an artifact to be selected, it must meet all the criteria configured in the search module.

Expert mode: advanced TQL searches

If you have complex research to do or your reports lack relevance, it's best to switch to expert Diagram illustrating the process flow of project management with key steps highlighted.mode.

Search query example demonstrating logical operators for database queries.

Here, searches must be done with our TQL (Tuleap Query Language) query language.
The syntax for a criterion is: ARGUMENT OPERATOR FIELD

Practical information

If you have any doubts, consider using completion (CTRL+Space) to check/complete the field names.

On the right, you will find the list of fields that can be used in your queries.

List of allowed fields including comments, assigned to, and dates for project management.

At the top, you have the option to return to the classic search mode: Diagram illustrating key components of a marketing strategy with highlighted sections.

As in the classic module, the search button allows you to validate your search.

Search button prominently displayed, inviting users to initiate a search action.

The Fields:

In queries you will use the names of the fields.

As a reminder, the field name is used to uniquely identify the tracker field, while the label (field title) is the text that is displayed in the graphical interface.

For example, the assignment field:

  • The label is "Assigned to (multiple)"

  • The name is "multi_assigned_to"

The field selection menu on the right lists the fields that can be used in expert mode (not all of them are). These are the labels of the fields that are displayed, but when you select one it will be its name that will be used.

Depending on the type of field chosen, different operators will be usable.

Operators:

Comparison operators, which can be used to compare a field with a value (text, integer, float, date, list, etc.)

  • =   "is equal"

  • <   "inferior"

  • >   "superior"

  • !=  "is unequal"

Logical operators, usable between 2 different criteria

  • AND

  • GOLD

The date operator, which can be used to define a window

  • BETWEEN(value1, value2)

List operators, which can be used to define a list of values to include or exclude

  • IN(value1, value2, value3, ...), list of values to include

  • NOT IN(value1, value2, value3, ...), list of values to exclude

Special operators: dynamic assignment values

  • NOW() domain, allows you to use today's date as the

  • MYSELF() file, allows you to use the current user as the test value

Practical information

To make your queries readable, it is strongly recommended to put parentheses around each criterion.

Save a search result