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.

Concepts

Here are the key concepts:

What is a Rich Filter

Unlike the native JIRA gadgets which are based on native JIRA filters, all the gadgets added by the Rich Filters Add-on are based on a data source called Rich Filter. A Rich Filter is a JIRA native filter wrapper, extending the JIRA native filter to include additional definitions for extra 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 the Rich Filter Gadgets.

What is a Rich Filter Gadget

The gadgets provided by the Rich Filters Add-on are called Rich Filter Gadgets. All Rich Filter Gadgets are based on Rich Filters and have one particular property – 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. 

There are ten types of Rich Filter Gadgets grouped into two categories:

  • Controller gadgets – this category contains only one gadget type. 
    • 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. 
  • Results gadgets – this category contains the nine other gadget types. All these gadgets display some type of result that can be dynamically controlled by one or more Rich Filter Controller Gadgets within the dashboard.
    • Rich Filter Results Gadget
      Like the JIRA built-in Filter Results Gadget, this gadget displays a list of issues. 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. 
    • 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. In addition to statistics based on issue fields, the Rich Filter Statistics Gadget can also display statistics based on user defined criteria (computed fields) or on date fields and can aggregate multiple result types (Issue Count, Story Points, Time Tracking, etc). 
    • 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. 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) or on date fields and can aggregate different result types (Issue Count, Story Points, Time Tracking, etc). 
    • 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. 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). 
    • Rich Filter Created vs. Resolved Chart Gadget
      Like the JIRA built-in Created vs. Resolved Chart Gadget, the Rich Filter Created vs. Resolved Chart Gadget displays the number of issues created versus the number of issues resolved over a given period of time.
    • Rich Filter Date Bar Chart Gadget
      This gadget is a more powerful version of the JIRA built-in Recently Created Chart Gadget. The Rich Filter Date Bar Chart Gadget is highly customizable and can display a bar chart based on any date field, it can split the results based on predefined or user defined criteria (computed rules), it supports stacked and clustered layouts and can aggregate different result types (Issue Count, Story Points, etc).
    • Rich Filter Simple Counter
      The Rich Filter Simple Counter gadget simply aggregates and displays different result types (Issue Count, Story Points, Time Tracking, etc).
    • Rich Filter Simple Gauge
      The Rich Filter Simple Gauge gadget displays issue count and field sum gauges. Gauge levels are based on predefined criteria or on user defined filters.
    • The Rich Filter Smart Counters & Gauges 
      The Rich Filter Smart Counters & Gauges displays multiple counters and gauges. Counters and gauge levels are based on multiple user defined filters. The gadget can aggregate and output different result types (Issue Count, Story Points, Time Tracking, etc).

Learn More

Visit these pages for more about the Rich Filters Add-on:

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.