5.1.4.7. Named Filters

The Issue Table includes a feature called Named Filters that can be used to store filter configurations to assist with establishing predefined workflows.

For example, a Named Filter might limit the displayed issues to a specific set of Error Numbers a developer should focus on, filter out irrelevant filesystem paths, and sort the results by filesystem path.

The user interface indicates when changes have been made that can be saved as a new Named Filter, as shown in the following screenshot where a column filter for the Error Number column has been applied:

An unsaved Named Filter and the Named Filter menu

An unsaved Named Filter and the Named Filter menu

Named Filters can also be updated, renamed, deleted, or set as default for the current issue kind.

You can select a Named Filter using the corresponding selector:

The opened Issue Table Named Filter selector

The opened Named Filter selector

Named Filter Elements

The following UI elements can be part of a Named Filter:

Column Filters

All filterable columns. Some columns do not have a filter icon and cannot be part of a Named Filter.

Column Sorters

All sortable columns, including the sort order when using multisort. Columns that cannot be sorted are indicated by a missing sorting icon.

The Path Filter

A path filter example.

A path filter example.

Predefined Named Filters

There are two predefined Named Filters that cannot be modified:

Show All

This is always available and represents an empty Named Filter. Select this to clear all filters.

Hide Suppressed

This is only available if your project has the import of suppressed issues enabled. In that case, this is also the default Named Filter.

Named Filter Compatibility

Named Filters have an associated Issue Kind compatibility.

A Named Filter created for Style Violations, for example, is usually not available for use with other Issue Kinds such as Clones or Architecture Violations.

Some Named Filters are considered universal, meaning they can be used with every Issue Kind. An example is the predefined Named Filters; in general, any Named Filter that only uses columns available on all Issue Kinds is considered universal and will appear as a filtering option for all Issue Kinds.

It is currently not possible to change the Issue Kind compatibility of an existing Named Filter.

Named Filter Categories

There are two categories of Named Filters, distinguished by who can manage and use them and which features are available.

Global dashboard2-uiicon-namedfilter-global

Global Named Filters are usable by everyone by default, but they can only be created and managed by users with the Manage Named Filters permission. The availability of these Global Named Filters can still be restricted to a specific set of Dashboard user groups. Because a Named Filter is a view of issues based on specific filter configurations, changes to a Global Named Filter will affect everyone using it.

Custom dashboard2-uiicon-namedfilter-custom

Custom Named Filters can be created by anyone for their own private use; they cannot be shared with or used by other users.

The following screenshot shows how the two categories are distinguished in the Named Filter selector:

The Named Filter selector showing the predefined, a global and a custom Named Filter

The Named Filter selector showing the predefined, a global and a custom entry

Global dashboard2-uiicon-namedfilter-global Named Filters can be managed via an administrative page accessible only to owners of the Manage Named Filters permission. This page lists all Global dashboard2-uiicon-namedfilter-global Named Filters regardless of their Issue Kind compatibility and allows for the configuration of visibility restrictions:

The global Named Filter Management.

The Named Filter Management view

Saving a Named Filter

When saving a new Named Filter using the Save filter as... option, a dialog appears. Users with the Manage Named Filters permission can determine whether the new filter is Custom or Global. If Global is selected, visibility can be restricted and usage rights can be granted to certain user groups.

Note

Overwriting a Global Named Filter may cause other users of that filter to receive unexpected results. Please refer to Global Named Filters for details.

The "Save as..." dialog with `Manage Named Filters` :ref:`permissions<sec:dashboard2:Administration:Permissions>`

The “Save as…” dialog with Manage Named Filters permissions

Default Named Filters

The Named Filter Menu allows you to set a default Named Filter for each Issue Kind.

The Named Filter Menu with the "Set as default" option

The Named Filter Menu with the “Set as default” option

This ensures that the specified Named Filter is applied by default when opening an issue list for the respective issue kind.