This documentation relates to an older version 1.6 of the Rich Filters Add-on for JIRA. See the documentation index for other versions.

Concepts

Here are the key concepts:

What is a Rich Filter

Unlike the native Jira gadgets which are based on Jira native filters, all Rich Filter Gadgets are based on a data source called Rich Filter. The Rich Filters are wrappers of JIRA native filters, extending the JIRA native filters to include definitions for additional filtering capabilities on top of the native filter, issue highlighting, multiple views for the results, computed fields and other settings that can be used by Rich Filter Gadgets.

What is a Rich Filter Gadget

The gadgets provided by the Rich Filter Gadgets Plug-in are called Rich Filter Gadgets. There are five types of Rich Filter Gadgets: 

  1. Rich Filter Controller Gadget
    As its name indicates, this gadget controls the other Rich Filter Gadgets in the dashboard. The Rich Filter Controller Gadget displays buttons and selectors which allow the user to change in real-time the data displayed by the other Rich Filter Gadgets withing the same dashboard. 
  2. Rich Filter Results Gadget
    Like the JIRA built-in Filter Results Gadget, this gadget displays a list of issues. Comparing to the native gadget, the data-source of the Rich Filter Results Gadget can be dynamically controlled by one or more Rich Filter Controller Gadgets within the dashboard. The Rich Filter Results Gadget also brings new functionality including: display of multiple views of the issue list, highlight and color-code of issues that match certain criteria, display of computed columns and more. 
  3. Rich Filter Statistics Gadget
    Like the JIRA built-in Issues Statistics Gadget, the Rich Filter Statistics Gadget displays a collection of issues broken down by a specified criteria. Comparing to the native gadget, the data-source of the Rich Filter Statistics Gadget can be dynamically controlled by one or more Rich Filter Controller Gadgets within the dashboard. In addition to statistics based on issue fields, the Rich Filter Statistics Gadget can also display statistics based on user defined criteria (computed fields) and can aggregate multiple result types (Issue Count, Story Points, Time Tracking, etc). 
  4. Rich Filter Two Dimensional Statistics Gadget
    Like the JIRA built-in Two Dimensional Issue Statistics Gadget, the Rich Filter Two Dimensional Statistics Gadget displays a collection of issues broken down by specified criteria on two dimensions. Comparing to the native gadget, the data source of the Rich Filter Two Dimensional Statistics Gadget can be dynamically controlled by one or more Rich Filter Controller Gadgets within the dashboard. In addition to statistics based on issue fields, the Rich Filter Two Dimensional Statistics Gadget can also display statistics based on user defined criteria (computed fields) and can aggregate different result types (Issue Count, Story Points, Time Tracking, etc). 
  5. Rich Filter Pie Chart Gadget
    Like the JIRA built-in Pie Chart Gadget, the Rich Filter Pie Chart Gadget displays issues returned from a specified filter, grouped by a specified criteria. Comparing to the native gadget, the data-source of the Rich Filter Pie Chart Gadget can be dynamically controlled by one or more Rich Filter Controller Gadgets within the dashboard. In addition to statistics based on issue fields, the Rich Filter Pie Chart Gadget can also display statistics based on user defined criteria (computed fields) and can aggregate different result types (Issue Count, Story Points, Time Tracking, etc). 

Any Rich Filter Gadget is based on a Rich Filter. Two or more Rich Filter Gadgets are linked together in a dashboard if they share the same Rich Filter. For example, a Rich Filter Controller Gadget can change the data displayed by a Rich Filter Results Gadget if both the Controller and the Filter Results are based on the same Rich Filter.

Learn More

Visit these pages for more about the Rich Filters Plugin:

Getting Started?—?a series of step-by-step tutorials showing each of the features in turn.

Configuring Rich Filters?—?detailed documentation for creating and managing rich filters.

Working with Rich Filter Gadgets?—?in-depth explanations of each gadget.