This page relates to the Cloud version of Rich Filters for Jira Dashboards. Please see the documentation index for Server & Data Center versions.

The Rich Filter Results Gadget

In this section:

  1. About the Rich Filter Results gadget
  2. Configuring the Rich Filter Results gadget

1. About the Rich Filter Results gadget

The Rich Filter Results gadget displays a list of issues in a table. It is analogous to Jira’s built-in Filter Results gadget, but it is based on a rich filter instead of a Jira saved search and thus adds several new features:

  • the content displayed can be further filtered using Rich Filter Controller gadgets;
  • the gadget itself can further refine the results by applying a gadget-specific JQL query that we call working query;
  • the gadget can display multiple views defined in the rich filter (which can include computed columns and color coding).

2. Configuring the Rich Filter Results gadget

Add a new or edit an existing Rich Filter Results gadget in your Jira dashboard. The configuration form of the gadget will be displayed:

Edit the gadget configuration as described in the following table:

SettingDescription
Rich Filter

Select the rich filter the gadget will use.

Click on the Rich Filter button to display the list of rich filters; you can either scroll through or use the search box to find the filter you need.

The gadgets’ configuration forms only show the rich filters you are allowed to view. See the Rights and Permissions documentation page for details.

Working Query

The working query is an additional JQL query which is permanently applied on top of the base Jira filter and any active quick filters in the controller to further filter the issues the gadget will work with. The working query is optional: if left empty, only the base Jira filter and the quick filters affect the issues displayed by the gadget.

The working query is allowed to contain an ORDER BY clause. If such a clause is present, it takes precedence over the order defined by the base Jira filter. You can even have a working query that contains only the ORDER BY clause, if you want to change only the default order of the displayed issues.

Views

Here you can select the views (among the views defined in the selected rich filter) that will be displayed by the gadget. By default, all views are displayed (the option Show all views is selected).

The list of views to be displayed can be customized (by selecting the option Customize views). You can add, remove or reorder (drag and drop the vertical “grid” icon) the views to be displayed.

Max RowsThe maximum number of issues the gadget will display per page. The default is 10; it can be changed but it cannot exceed 50.