This documentation relates to version 1.8 of the Rich Filters Add-on for JIRA. Documentation for previous versions is available via the documentation index.
By the end of this tutorial you'll know how to build a simple JIRA Dashboard with two Rich Filter Gadgets: a Controller and a Filter Results. By clicking the buttons of the Controller, the results of the Filter Results will be further filtered based on the criteria you have configured.
How to build your dashboard
Create a new Rich Filter as described in Create a Rich Filter tutorial. If you have already created your rich filter, simply open the configuration page of your rich filter as described in Navigate through Rich Filters tutorial.
In order to complete this tutorial, make sure the JIRA filter your rich filter is based on returns some results.
- Once you are on the Rich Filter configuration page, click on Static Filters link on the left of your screen.
- Define a new static filter with the label Closed and JQL
status = Closed; Define another static filter with the label Assigned to me and JQL
assignee = currentUser().
- Create a new JIRA Dashboard (i.e. Go to Dashboards -> Manage Dashboards menu; or click on the Create new dashboard button).
In the newly created JIRA dashboard add one Rich Filter Results Gadget.
In the Add a gadget dialog, simply type “Rich” in the Search box. This will display the rich filter gadgets provided by the plug-in.
In the configuration view of the Rich Filter Results Gadget select the rich filter you have defined. No need change anything for the other parameters for now. Click Save.
Use the search box provided by the Rich Filter drop-down in order to easily find your rich filter by name
- In the same JIRA dashboard add one Rich Filter Controller Gadget.
- In the configuration view of the Rich Filter Controller Gadget select the same rich filter you have selected for the Rich Filter Results Gadget. No need to change anything else for now. Click Save.
Congratulations, you have just created your first interactive JIRA dashboard. The Rich Filter Controller Gadget displays the two static filters you have defined in your rich filter. If you click on any of the two static filters, the Rich Filter Results Gadget will display the issue collection obtained by applying the JIRA base filter of the rich filter
ANDed with the JQL you have inserted for the static filter. E.g. if you click on Closed it will display only the closed issues among the issues in the JIRA base filter of the rich filter.
Add other static filters more relevant for your context.
You can add as many static filters as you wish. You can also change the order of the static filters. In order to know everything about configuring Static Filters, have a look at Configuring Static Filters.
Did you know?
From the Rich Filter Results gadgets, you can update your issues directly, without opening any new tabs or windows. Right click on any issue row (anywhere except on a link) to try. To learn more, check out the Dashboard Issue Actions section.
In order to customize the display of your JIRA dashboard, see the next tutorial, Define and customize views for your interactive JIRA Dashboard.