Filtering Reports
This is the most important section of the screen. To add a filter for a field, you can either use Add filter or drag the field to the filter section. After you select or drag a field, a control overlay appears in which you can set the desired options. These controls depend on the field type. The following sections explain the supported field types.
Choice fields or meaning type selectors
The possible values of these fields depend on the trackers that are selected in the tracker selector. The field values are grouped by the selected trackers. After you select or clear trackers in the tracker selector, these fields are automatically refreshed and remain consistent.
Furthermore, if you select Status or Resolution, you can also filter by meanings of the field values. Set the Status and Resolution meanings for values on the tracker customization page. In the Query widget the meanings do not depend on selected trackers, but have the following fixed values:
• Status—Unset, In progress, Resolved, Closed, Obsolete
• Resolution—Unsuccessful, Successful, Obsolete
You can use the Filter option in the selector to filter meanings or field values.
Group by Section
You can group the result by project, trackers, and some fields. If you start dragging from the left pane, the Group by section is highlighted if grouping is available for the field (grouping by custom field is also available). For grouping by project or tracker, you must click Add in the Group by section. Multiple grouping is also supported (maximum 3 levels).
When you group by date type fields, you can use truncate functions (Day, Week, Month, Quarter, Year). You can change the truncate function by clicking the dark-grey background truncate function badge.
Grouping is necessary to use the Aggregate functions (see below).
 |
You can Group by custom fields, but only if you select exactly one tracker in the tracker selector. The custom fields are available under Add Group on the context menu only if you select exactly one tracker in the tracker selector. If the selected tracker’s custom field is available in the Group by section, and later you select another tracker or set the tracker selector to Any, the selected custom field in the Group by section is removed.
|
Order by Section
Order by is possible for most of the fields. You must drag the desired fields. For ordering by tracker or item ID, you must use Add in the Order by section. Multiple ordering is also possible (maximum 3 levels).
You can change the direction of ordering (ASC or DESC) by clicking the dark background direction badge.
Order Groups by Summarized Values
In certain cases, you can order the groups by the summarize function values. The control badge for that is available only under the following conditions:
• The report is grouped, and grouped by only one field.
• Some of the summarize functions are set for a number type field (SUM, AVG, MIN, MAX).
• The number type field is selected in the Order by section.
The order-by-aggregate badge appears after the ASC or DESC badge and contains the selected summarize functions and the NONE option. If you select NONE, the default ordering is applicable, that is, the tracker items and not the groups are ordered by the field value.
NOT and EMPTY options
You can negate the condition for all field types using the NOT badge at the top-right of the selector. If selected, the light-gray background of the badge becomes darker and NOT is visible before the selected conditions.
You can also filter on an empty field value. A field value of a tracker item could be empty if the field is not mandatory, but it is not set. For example, to see the items which do not belong to a release, you can add the Release field to the filter list and set it to empty. If selected, the light-gray background of the badge becomes darker and empty is visible.
You can combine the NOT and EMPTY badges as follows:
• NOT badge is on—Negation of the selected condition.
• EMPTY badge is on—Filter for empty field values. In this case, the selectable elements in the setting container are disabled (For example, the choice options of a choice field).
• NOT and EMPTY badges are on—Filter for not-empty field values. Selectable elements are also disabled.
AND/OR Logic
By default, there is an AND condition between the filters in the Filter list, but you can define custom logic (using AND or OR and parentheses) by clicking Add AND/OR next to Add filter in the Filter list. Subsequently, the Filter list is in the AND/OR Logic mode, and the structure changes as follows:
• A number is assigned to all the added filters; the numbers represent the filters.
• An AND/OR Logic box is available, in which you can enter the custom logic using the filter numbers, the AND, OR logical operators, and parentheses if necessary.
The logic that you enter in the AND/OR Logic box is immediately validated. If the logic is invalid, a message appears. After you correct it to a valid logic, the text color changes to green and the message disappears. You can run the report only if the AND/OR logic is valid.
• Invalid logic—
• Valid logic—The logic validation is case insensitive
|
|
If you switch to the Advanced mode while using the AND/OR logic, the cbQL is not editable. If you need to modify it anyway, you must either copy the cbQL and create a nem Report in the Advanced mode, or return to the Simple mode and switch off the AND/OR logic mode.
|
To switch off the AND/OR logic mode, click X.
Project and Tracker selectors
The two most-used filter options are by project and tracker. After you select a project, the trackers of the selected project are visible in the Trackers list. After you select a tracker, the field pane on the left expands to include the custom fields of the selected tracker (the fields which are not under the Default fields and Common Reference fields). Furthermore, if you choose only one tracker, the labels of the Default Fields and Common Reference Fields change to the field labels of the selected tracker.
Branch Support
You can select the branches of the trackers. In the tracker selector under each tracker, you can see the hierarchy of the branches of the tracker. Select branches in the same way as you select trackers..
User fields
You can use the following features in the filter of Member type fields.
• An autocomplete-enabled box to select users and user groups.
• The pencil icon 
to find the member.
to find the member.• The role list of the current project (or selected projects), below the autocomplete-enabled box. You can also select Me.
Filter by Members in previous versions
After you select these conditions, you can see a list of users based on the projects that you have selected in the project selector. If you do not select a project, all visible members of the projects assigned to the current user are visible.
You can select Me, at the beginning of the values, to select the current user.
These values are automatically refreshed if you change projects in the project selector. The list displays three properties of the users: the user name (or alias in the general.xml file), the real name, and the domain of the user’s email address. You can filter the list by these three properties using the filter box in the selector. Click Add Other User(s) to select users that are not present in the list. A dialog box opens, in which you can enter the user. Click OK to see the selected user in the user selector list.user selector list will display your selected user or users.
Item Based Review Filter
You can filter by item-based review. Select Reviewed by under the item-based review filters. You can search for review items that are pending and decided, or for items which are not a part of the item-based review. Optionally, you can filter by the reviewers.
If you select NOT, only the selected users are applicable for the negation.
Filtering by Shared Fields
You can filter by any type of shared fields.
If you select a project and some trackers, only the shared fields used in the selected trackers are displayed. In tracker views, only the shared fields used in the current tracker are displayed.
Other filters
You can use Add filter to select other filters. These filters do not represent any field, and are not present in the left pane.
• Downstream Reference to / Upstream Reference to—Similar to the reference field, but the field is not specified. Optionally filterable by suspected references.
If you have not expanded the Work Item(s) tag section or not set the work item, you can filter by tracker level. For example, in the following case, the work items that have at least one reference from the bugs tracker are matches:
If you expand the Work Item(s) tag section and set some work items, you can specify the references.
• Has Downstream Reference or Has Upstream Reference—Simple boolean options to find the tracker items that have downstream or upstream references. Optionally filterable by suspected references.
• Has Review / under Review—Simple boolean options to find the tracker items that have downstream or upstream references. Optionally filterable by suspected references.
• Suspected References (Has Suspected Link or Has Downstream Suspected Link or Has Upstream Suspected Link)—Simple boolean options to filter by suspected links without field or work item specified.
See also: hasSuspectedLink.
• Outline Number—You can filter items according to their outline number (Document View paragraph numbers).
• Tracker Tag—You can filter by tracker type. The obsolete tracker types are listed as gray, but you can still select them.
Include
You can include another report in an existing report. Click >
• Include Report—You can select another report by using the auto-complete feature or the pencil icon and the report finder.
• Include cbQL from Work Item Description—You can select a work item which contains cbQL in its description field to include the cbQL in the existing report.
Expert Filter
The expert filter is a special text-type filter which accepts cbQL strings. The execution environment copies the content of the filter to the filtering part of the final cbQL expression.
You can enter the expressions in the text editor. This editor supports syntax highlighting and displays syntax errors.
| | You can only enter filtering expressions. You cannot change projection, group, or order the expressions. |
Historical Filters
You can display specific versions of items, that is, versions that items had at a specific time (based on a baseline or a specific date). If you use a historical filter, the result items are always versioned items, and the result table is read-only.
• Historical View—Filter by baseline or date. Baseline filtering is available if you select only one project, and the project has at least one baseline.
• Items at Release/Sprint Start Date—Select a release or sprint. The result is the versioned items of the selected release or sprint on its start date.
• Items at Release/Sprint End Date— Select a release or sprint. The result is the versioned items of the selected release or sprint on its planned release date (End Date).
Historical filters have the following limitations:
• Historical filters are a built-in part of every project, and you cannot disable or customize them.
• The result items are versioned items, and you cannot edit them.
• You can use only one historical filter at a time.
• You cannot use historical filters in the following:
◦ Release or sprint planner
◦ Baseline mode
• The query performance might be unsatisfactory when any of the historical filters is active. The following warning is shown:
 | Using historical filters may lead to poor query performance. |
• You cannot use historical filters with the following filters:
◦ Custom and shared fields, apart from choice option and member type fields
◦ Description field
◦ Has downstream reference
◦ Has upstream reference
◦ Has unresolved dependent link
◦ Suspected link filters
◦ Review Hub filters
◦ Reviewed by
◦ Project tag
◦ Tracker tag
◦ Work item tag
◦ Has rank
• When you select an unsupported filter, the following warning is shown:
| | Filter is not supported if you use any Historical filters or if you are in Baseline / Baseline compare mode. |
Filtering by fields of Reference Items
You can filter by attributes of reference items. In the Filtering Reference Items group, you can select one of the following:
• Downstream References
• Upstream References
A Filter widget appears in the overlay, in which you can set any kind of filters. Optionally, you can define the reference field in which the filtering must happen. You can select only the default common reference fields and the shared fields (which have Tracker Item Reference Type).
In this example, the result displays the items which have in-progress bugs upstream reference items in the upstream reference field.