This documentation relates to version 1.7 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.

The Rich Filter Controller Gadget

The Rich Filter Controller Gadget controls what the other Rich Filter Gadgets display (on the same dashboard and based on the same rich filter as the Controller). The controller does not display any issue data; it only displays the quick filters that have been defined in the rich filter.

The Rich Filter Controller Gadget also allows the user to store the state of the quick filters in an URL. To learn more, see the Dashboard State Permalinks section.

Configuring the Rich Filter Controller Gadget

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

Edit the gadget configuration as described in the following table:

Setting Description

Title

Optionally, you can customize the title of the gadget. If left blank, the default title will be Rich Filter Controller.

Whether you set a custom title or leave the default, all rich filter gadgets will prefix their titles with the name of their rich filter, so you can see at a glance which gadgets are connected with each other.

Rich Filter

Select the rich filter the gadget will use. This setting is mandatory.

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 section on permissions for details.

The link in the description line below the Rich Filter drop-down opens a new page with the configuration of the selected rich filter.

Also, when the gadget is in display mode, you can navigate directly to the rich filter of the gadget using the Rich Filter option in the menu at the top right of the gadget.

Quick Filters

Once you have selected a rich filter for your gadget, you can customize which quick filters you want to display in your controller. By default, controllers show all available quick filters. You can use the radio buttons to change this and display only static, only dynamic or only smart filters, or you can choose to customize in detail which quick filters to show and in what order using the last option.

If you choose the Customize shown filters option, the configuration form will change to display the list of quick filters. You can add, remove or reorder (drag and drop the vertical “grid”) the quick filters to be displayed.

Besides the individual quick filters, the custom list menu also contains three “group” options: All Static Filters, All Dynamic Filters and All Smart Filters. If used, the gadget will display in their place all quick filters of the specified type except those that are explicitly included. For example, you can use this to show the Priority dynamic filter first, then all static filters, and then all dynamic filters other than Priority.

It is usually best to have a controller at the top of the dashboard, where it is easily visible and accessible.

You can add multiple controller gadgets on the same dashboard and with the same rich filter. You can use this to arrange your quick filters on multiple sections/layouts.

You can even add the same quick filter in multiple controllers: they are kept synchronized automatically. You can use this to put a second controller below tall gadgets, so you can reach the quick filters without needing to scroll up.