Configure dynamic filters
Contents:
About dynamic filters
Dynamic filters allow users to further filter the work items displayed by the gadgets based on the current rich filter. Dynamic filters are based on Jira fields (built-in or custom) and allow filtering work items by field values. Once configured, the dynamic filters are displayed in Rich Filter Controller gadgets as buttons with drop-down menus (for option/user/label/etc fields), text search boxes (for text-based and number fields), or date search boxes with calendar drop-downs (for date fields). When a dynamic filter is activated in a Rich Filter Controller gadget, all the other gadgets in the same dashboard based on the same rich filter apply the selected criteria (the required JQL is automatically generated).
Dynamic filter types
There are four types of dynamic filters, depending on the kind of field they are based on:
Option-based dynamic filters
Option-based dynamic filters are used for fields that can take predefined values, such as checkboxes, select lists (single or multi-select), status, priority, labels, user pickers, etc. Controller gadgets display these as buttons with drop-down menus, which allow selecting among the options available for each field.
When activated, dynamic filters limit the results to only those work items that match the selected options. If multiple options are selected, the filters will pass work items with any of the selected values. (In JQL syntax, the selected options are ORed together, then the result is ANDed with the other JQL clauses).
The list of options in the drop-down menu is populated only with the values in the work items returned by the base Jira filter. This means that the list doesn’t show options defined by the field configurations, but they do not occur among your work items. Not showing irrelevant options improves the user experience. For example, this is very useful if you add a dynamic filter for the Assignee field – the drop-down menu displays only the users who have at least one issue assigned.
When you click an option dynamic filter, the button becomes a search box, which makes it easier to find the options you are looking for. The options can be checked / unchecked one by one with a click or as a range using Shift + click. These mechanisms are particularly useful for fields with a large number of options.
Text dynamic filters
Text dynamic filters are used for string and text fields, such as the issue summary and description. Text filters don’t use a menu; they just display a text box. The required JQL is automatically generated to filter only work items that contain the entered text.
Jira has two text searchers, one for exact string search and one for full-text search. Dynamic filters will use one or the other, depending on how your field is configured. Advanced search features such as prefix and wildcard queries are supported. See Jira’s documentation for the syntax.
Besides issue fields, there are two extra text dynamic filters that you can add to your rich filters: one is labeled Contains Text and allows searching the summary, environment, description, and comments of an issue, as well as all custom text fields. The other field is labeled Comments, which searches exactly what the name suggests.
Number dynamic filters
Number dynamic filters are used for number fields, such as Story Points or Business Value, and searches based on the number of votes or watchers. These filters also display a text box where the user can type multiple values or ranges for the search. Several search options are supported:
Search by value: the user can insert one or several space-separated values to search for – e.g., “
1 2 3” for work items having the values 1, 2, and 3;Search values greater or lower than a given value: the operators '
<', '>', '<=', and '>=' are accepted – e.g., “>=1” for work items having the values greater or equal to 1;Search for intervals: the form “
a:b” can be used to search values between a and b included – e.g., “1:10” for values between 1 and 10;Search for work items with the value empty or not empty: The user can type '
empty' to see work items with the field empty or '!empty' for work items with the field not empty.
Several options can be used simultaneously; they just need to be space-separated, and the options are OR-ed – e.g., “1 2 <0 4:8” returns the values 1 or 2 or the values inferior to 0 or in the range 4–8.
Date dynamic filters
Date dynamic filters are used for date/time fields, such as created, updated, resolution date, and custom date fields. Date filters allow users to filter only work items with date field values on, before, after, or between two dates.
Each dynamic filter has two date inputs: From and To:
If only From is filled, then only the work items having values on or after the From date are kept;
If only To is filled, then only the work items having values on or before the To date are kept;
If both From and To are filled, only the work items with values between the From and To dates (both inclusive) are kept. If From and To are filled with the same date, then only the work items having values on that date are kept.
You can pick the input dates for From/To from a calendar or enter them manually as an calendar date (“yyyy/MM/dd” or “yyyy-MM-dd”) or as a time relative to the present (for example, “5d” or “4w 2d”).
If you need to search for work items on a single date, enter that date in both From and To simultaneously. If you want to use now as an input in From or To, you can enter the value 0d.
Rich Filter extensions
Rich filter extensions are separate Jira apps installed on top of the Rich Filters for Jira Dashboards app to extend the rich filters and rich filter gadgets with new specific functionality.
New dynamic filter options are available if you add any of these extensions:
Rich Filters::Time Tracking Dashboards allows you to add dynamic filters based on work log attributes – Worklog Author, Worklog Date and Worklog Comment
Rich Filters::Service Desk Dashboards allows you to add dynamic filters based on Service Desk specific fields – Customer Request Types and Organizations
Add edit dynamic filters
You can add new and see existing dynamic filters and their configuration in the Dynamic filters section of your rich filter.
The Dynamic Filters section of your rich filter allows you to do the following operations:
To do the following: | Do this: |
|---|---|
Add a dynamic filter | Click Pick a field.. at the bottom of the page. A drop-down menu shows all supported fields. Either scroll down or use the search to find the field you want
|
Delete a dynamic filter | Click the Delete ( |
Reorder the dynamic filter | Hold the pointer over the vertical Grid ( When the dynamic filters of this rich filter are displayed by Controller gadgets, by default, they are shown in the order configured in this section. |
Edit a dynamic filter | This configuration is available only for option-based dynamic filters. To open the edit dialog, click the Edit ( The edit dialog lets you:
|
Supported fields & compatibility with third-party apps
We support dynamic filters for most of the built-in Jira issue fields and custom fields: Key, Project, Project Category, Summary, Issue Type, Status, Priority, Resolution, Affects and Fix Version(s), Component(s), Labels, Environment, Description, Assignee, Reporter, Due Date, Created, Updated, Resolved, Sprint and Epic Link (for Jira Software), Select List (single/multiple choices and cascading), Checkboxes, Radio Buttons, Labels Custom Field, User Picker (single/multiple users), Group Picker (single/various groups), Project Picker, Text Field (single/multi-line), URL Field, Date Picker and Date Time Picker.
We also support dynamic filters for all custom fields added by third-party apps that use one of Jira's built-in custom field searchers: Single/Multi/Cascading Select Searcher, Labels Searcher, Group Picker Searcher, Project Dropdown Searcher, Exact Text Searcher, Free Text Searcher, Date Range Picker, or Date Time Range Picker.
Moreover, we do our best to support dynamic filters for some custom field searchers added by popular third-party apps. Click here to see the list of third-party apps we support.
Troubleshooting dynamic filters based on 3rd party searchers
It is important to ensure the field and searcher are correctly configured before using them in a dynamic filter. A quick test is to use the 'Issue Statistics' Jira gadget to ensure the options are displayed correctly.
The performance of the dynamic filter (display/search speed) depends entirely on the configuration and implementation of the 3rd party custom field. When used as a dynamic filter, the field will perform exactly as in Jira's built-in Issue Navigator and 'Issue Statistics' gadget.
Need support? Create a request with our support team.
