The Rich Filter Controller gadget
Contents:
About 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 defined in the rich filter.
The Rich Filter Controller gadget also displays three buttons in the bottom-right corner:
Auto-refresh (
) —The user can enable the auto-refresh functionality at the dashboard level. If the auto-refresh is enabled, the controller automatically triggers a refresh every 15 minutes. This will refresh all the gadgets in the dashboard that are based on the same rich filter as the controller.
Optimized refresh (
)—When you click this button, all the rich filter gadgets on the dashboard are refreshed based on the same rich filter as the controller. The user can manually trigger a dashboard-level refresh.
Clear all quick filters (
)—When you click this button, all the active quick filters in the controller are cleared. This also triggers a complete refresh of all the gadgets based on the same rich filter as the controller.
The Rich Filter Controller gadget also allows the user to store the state of the quick filters in a URL. To learn more, see the Dashboard State Permalinks section.
Configure 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 prefix their titles with the name of their rich filter so you can see which gadgets are connected at a glance. |
Rich Filter | Select the rich filter the gadget will use. Click the Rich Filter button to display the list of rich filters; you can either scroll through or use the search box to find your filter. The gadgets’ configuration forms only show the rich filters you can view. For details, see Rights and Permissions. You can click the Open rich filter config link below the Rich Filter drop-down to open a new page with the configuration of the selected rich filter. When the gadget is in display mode, select the Open rich filter config option under the Menu (
|
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, dynamic, or 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 the quick filters to be displayed. You can also organize your quick filters in named sections that group your filters. Besides the individual quick filters, the custom list menu 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 that is easily visible and accessible at the top of the dashboard. You can add multiple controller gadgets to the same dashboard and with the same rich filter. This lets you arrange your quick filters on multiple sections/layouts. You can even add the same quick filter to multiple controllers: they are kept synchronized automatically. For example, you can put a second controller below tall gadgets to reach the quick filters without needing to scroll up. |
Enable additional JQL filtering | This option is more relevant to advanced users. If the additional JQL filtering is enabled, the controller will also allow users to type additional JQL directly in the controller. The JQL will be applied to all the other rich filter gadgets (on the same dashboard and based on the same rich filter as the controller). If the additional JQL filtering is enabled, the controller shows a +JQL button. When you click the button, the controller displays the additional JQL box that allows users to apply new custom filtering.
If you want to display only the JQL filtering box in your controller, select the Show JQL filters only option under Quick filters. In this configuration, the controller displays only the JQL filtering box. |
Filtering mode
You can select a filtering mode alongside the values for the dynamic filters that display dropdowns (e.g., Assignee, Components, Status, Labels). The filtering modes correspond to the logical operators used to combine the selected values when generating the JQL filtering condition:
OR: this is the default filtering mode – when multiple values are selected in a dynamic filter, they are combined with OR, which means that the filter returns the issues that match any (at least one) of the selected values:
AND: this filtering mode is available for fields that can have several values simultaneously (for example, Labels, multiple selection fields) – when multiple values are selected in a dynamic filter, they are combined with AND, which means that the filter returns the issues that match all the selected values simultaneously:
The AND filtering mode is available only for dynamic filters that have multiple values. For instance, users can search for issues that have component A and component B at the same time. However, searching for issues with high and low priority simultaneously does not make sense because the priority field can have only one value at a time. For dynamic filters that cannot have multiple values, only the OR and NOT filtering modes are available.
NOT: available for all fields – the selected values are negated and combined with AND, which means that the filter returns the issues that don't match any of the selected values:
Dashboard state permalinks
Dashboard state permalinks are URLs that encode the state of the rich filter gadgets on the dashboard. Later, you can use the URL to open the dashboard and restore the rich filter gadgets to the same state.
To generate a dashboard state permalink, open the Menu () of a Rich Filter Controller gadget and select the Generate Permalink:
This will open a dialog containing a generated URL, which encodes the state of all the rich filter gadgets on the dashboard.
You can bookmark this URL or send it to someone else. When the URL is opened, the rich filter gadgets will be restored to the same state as when the link was generated: the same quick filters selected, the same selected views, and the same sorting criteria in the Rich Filter Results gadgets.
If you have more than one controller or rich filter in the dashboard, the dashboard state permalink will encode the state of all controllers for all rich filters, no matter from which controller you generate the URL. All the Rich Filter Controllers on the dashboard generate the same permalink.
Need support? Create a request with our support team.
