Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article focuses on another powerful feature of Rich Filters for Jira Dashboards: dynamic filters. These filters allow for fine-grained filtering of issues by individual values available in different fields. For example, you could filter for issues with a particular assignee, status, or label.

Contents:

Table of Contents
stylenone

Prerequisites

...

  • This is a Rich Filter Controller gadget with several dynamic filters. These filters that allow you to filter the issues displayed in other rich filter gadgets by individual values.

  • This is a Rich Filter Results gadget that displays the list of issues and allows you to see the effect of the filtering.

...

  1. If you've already worked through other tutorials in this series, you can base any gadgets you create while following this article on a previously created rich filter. Check that you have one available (find existing rich filters under Apps > Rich Filters). If not, follow the instructions in Get started with Rich Filters for Jira Dashboards to create a new rich filter before continuing.

  2. Create a new dashboard (Dashboards > Create dashboard).

  3. Make sure it uses the Two-column layout. This is usually the default setting, but you can select it if required using the Change layout menu at the top of the dashboard.

    Newly created dashboard with Change layout option selected and two columns option highlightedImage Removed


    Newly created dashboard with Change layout option selected and two columns option highlightedImage Added
Info

If you want a more detailed explanation of creating a new dashboard, see Create a simple dashboard.

...

  1. Add a Rich Filter Controller gadget to your dashboard and configure it based on your rich filter (Create a simple dashboard explaining how to do this).

  2. Make sure Ensure your new gadget is in the left-hand column of your dashboard; you can drag and drop it if necessary.

  3. Open your rich filter config (described in Easier configuration with the Rich filter menu).

  4. Select the Dynamic Filters tab.

    Rich filter config showing dynamic filters tab selected with default view, no filters createdImage RemovedRich filter config showing dynamic filters tab selected with default view, no filters createdImage Added
  5. Add a dynamic filter based on the Assignee field.

    1. Start typing "Assignee" into the Pick a field... text input.

    2. Select Assignee from the list of options presented to you.

    3. An Assignee dynamic filter will appear above the text input.

      Dynamic filters config with a single dynamic filter created for assigneeImage RemovedDynamic filters config with a single dynamic filter created for assigneeImage Added
  6. In the same way as before, add dynamic filters based on the Priority, Status, Labels, and Resolution fields.

    Dynamic filters config with dynamic filters created for assignee, priority, status, labels, and resolutionImage RemovedDynamic filters config with dynamic filters created for assignee, priority, status, labels, and resolutionImage Added
  7. Go back to your dashboard and refresh it; you should now see the dynamic filters on your controller.
    Controller gadget showing dynamic filters with no filters currently selectedImage Removed

    image-20240506-162141.pngImage Added

Filter the issues in a Rich Filter Results gadget.

...

  1. Add a Rich Filter Results gadget to your dashboard.

  2. Make sure Ensure your new gadget is in the right-hand column of your dashboard; you can drag and drop it if necessary.

  3. In the gadget config form, make sure ensure the Rich filter is set to the same rich filter as your controller, then click Submit.

  4. Try clicking some of the dynamic filters in the controller, selecting a few values, clicking Apply filters, and seeing how the list of issues displayed in your Rich Filter Results gadget changes based on your selections. Note also how the dynamic filters display a number to tell you how many values you have selected inside each one.
    Controller gadget showing dynamic filters with priority values of highest and high already selected, and status values of accepted and in progress being selectedImage Removed

    image-20240506-162420.pngImage Added
Info

Unlike static filters, which apply automatically when toggled on or off, dynamic filter changes aren't applied used to your dashboard until you click the Apply filters button that appears in the controller when changes have been made.

This is because dynamic filter settings usually involve selecting several options; the controller allows you to wait until you are happy with your filter selections before applying them.

...

First, when you click on a dynamic or smart filter, in addition to displaying the available options, the filter box becomes a text field into which you can type search terms to filter those options. This is really useful if you have a filter that contains a large number of containing many options and want to focus on a smaller group that interests you.

...

Tip

Search and range selection are powerful in combination. You can filter the displayed options down to a subset that interests you and then select all of them with one click.

Search and range selection is powerful in combination — you can filter the displayed options down to a subset that interests you and then select all of them with one click.

...

  1. Open your rich filter config and select the Dynamic Filters tab.

  2. Add a dynamic filter based on the Created field (or another appropriate date/datetime field).

  3. Return to your dashboard, refresh it, and play with your new dynamic filter to see how it updates the listed issues.

    Controller gadget with dynamic filters, with date filter highlighted, showing value of December 1 2022 entered into the from field
  4. Clear all the filters by clicking the X button in the bottom-right corner of the controller.

Tip

The selected date values are inclusive, meaning that they are included in the filter range.

...

  1. Open your rich filter config and select the Dynamic Filters tab.

  2. Add a dynamic filter based on the Summary field (or another appropriate text field).

  3. Return to your dashboard, refresh it, and play with your new dynamic filter to see how it updates the listed issues.

    Controller gadget with dynamic filters, with text filter highlighted, showing value of LDAP enteredImage RemovedController gadget with dynamic filters, with text filter highlighted, showing value of LDAP enteredImage Added
  4. Clear all the filters by clicking the X button in the bottom-right corner of the controller.

Advanced syntax details about text dynamic filters:

...

  1. Open your rich filter config and select the Dynamic Filters tab.

  2. Add a dynamic filter based on an appropriate numeric field like Story Points.

  3. Return to your dashboard, refresh it, and play with your new dynamic filter to see how it updates the listed issues.

    Controller gadget with dynamic filters, with number filter highlighted, showing value of 1 enteredImage RemovedController gadget with dynamic filters, with number filter highlighted, showing value of 1 enteredImage Added
  4. Clear all the filters by clicking the X button in the bottom-right corner of the controller.

...

  • You can enter numeric filter terms in several different ways:

    • Enter one or several space-separated values, e.g., enter "1 2 3" to filter for the values 1, 2, or 3.

    • The comparison operators "<, "">," "<=," and ">=" are accepted, e.g., enter ">=1" to filter for values greater than or equal to 1.

    • Use the form "a:b" to filter for a range of values; e.g., enter "1:10" to filter for values between 1 and 10.

    • Enter "empty" to filter for issues where this field is empty or "!empty" to filter for issues where this field is not empty.

Info

For Refer to our Dynamic Filter Types reference documentation for more information on each dynamic filter type, see our Dynamic Filter Types reference documentation.

Final result

Your final result should look like this:

...

Next steps

You are advised to can work through the Fundamentals articles in order, but each one works as a standalone topic, so you can jump to specific topics of interest if that suits you better.

...