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.
Smart Filters are more versatile than the two other types (static and dynamic). Smart filters allow the users to:
- Filter the collection of issues displayed by gadgets based on the current Rich Filter. The smart filters can be displayed as buttons with drop-down menus in Controller gadgets (similar to dynamic filters).
- Add computed columns and/or color-coding in Rich Filter Results gadgets.
- Build statistics on configurable criteria.
Key Attributes of Smart Filters
- Each smart filter has a name which identifies the filter. It is mandatory and must be unique among the other smart filters within the Rich Filter.
- Each smart filter has at least one tag type. There are two possible tag types: labels and colors. A smart filter can have any or both of these.
- The labels tag type is necessary in order to use the smart filter in Control gadgets for filtering (each Label is a option in the filtering drop-down menu), or in Filter Results gadgets as a computed column (each Label is a possible value of the column) or in Statistics gadgets (as statistics criteria).
- The colors tag type is necessary in order to use the smart filter for color-coding in Filter Results and Statistics gadgets.
- A smart filter contains a list of clauses (options), each clause is identified by a color and/or a label tag and has a JQL which is applied when the clause is used.
Once configured, the smart filter can be used:
- in Rich Filter Controller gadgets as a filter.
- in Rich Filter Views as a computed column.
- in Rich Filter Statistics gadgets and Two-Dimensional Rich Filter Statistics gadgets as statistics criteria.
Editing Smart Filters
- Navigate to the desired rich filter.
- Open the Smart Filters section.
- Edit the smart filters as described in the following table and screenshot:
|To do the following:||Do this:|
|Add a new Smart Filter||
Click on the Add Smart Filter button at the top-right of the page.
Insert a name, select at least one tag type and click on Create button.
|Add clauses to the Smart Filter||
Select a color and/or insert a label (depending on which Tag Types you have selected for your smart filter), insert a JQL for the clause and click the Add button.
|Edit the clauses of the Smart Filter||
Click on the color, label or JQL of the clause to edit it and click on the update icon to save the changes.
|Delete clauses from the Smart Filter||
Click the trash can icon at the right of the clause.
|Reorder the clauses of a Smart Filter||
Hover over the vertical “grid” icon of the clause, then drag and drop up or down to the new position.
When the smart filter is displayed by Rich Filter gadgets, the smart filter options are displayed in the order as configured in this section.
|Edit a Smart Filter’s Attributes||
Click the edit icon at the right of the smart filter’s name.
A pop-up appears. Make your changes and click on the Update button.
|Delete a Smart Filter||
Click the delete icon at the right of the smart filter’s name.
|Move a Smart Filter||
Click on the menu at the right of the smart filter’s name.
When the smart filters of this rich filter are displayed by Controller Gadgets, by default the smart filters are displayed in the order configured in this section.
|Copy (duplicate) a Smart Filter||
Click on the Copy option in the smart filter’s menu.
Insert the name of the new smart filter and click the Create button. A new smart filter identical with the first one but with the name you have inserted is created.
When deciding under which clause an issue falls, we use a match-all criteria: the same issue can be part of multiple clauses if it matches the JQL of each clause. This means that when the smart filter is used as a computed column or statistics criteria, it behaves as a multi-select option field.
If you want your clauses to be mutually exclusive, you need to write your JQL in such a way so that an issue can match only one clause at any particular time. For instance, these are mutually exclusive clauses; an issue cannot possibly match more than one clause at a time: