Limitations of searchers provided by Jira
After you create a custom field (Standard or Advanced) in Jira, you can also configure a Search template to be applied to the custom field. Jira provides useful searchers like Free Text Searcher, Multi Select Searcher, Number Searcher
and others relevant to the custom field type created. However, many of the built-in searchers are not statistics-compatible. Statistics compatible searchers are searchers that allow you to create statistics (Pie-charts or Two-dimensional gadgets) on the dashboard by the custom field value. All JMCF searchers support statistics.
With JMCF add-on installed in your instance, JMCF statistics compatible searchers will be available for Jira Standard custom fields too! For example, you want to show the total number of Story Points as one of the dimensions in the Two-dimensional gadget on the dashboard. You cannot do this using the native search templates provided by Jira because they are not statistics-compatible. However, with JMCF in your instance, you can select the custom searcher, Number Range Searcher (statistics-compatible) , in the Search Template of the Story Points field and use it in statistics. |
Searchers provided by JMCF
Along with being able to use a searcher to define how to search for issues in the Issue Navigator with a given value in the field, you can also enable and format their display in the gadgets like Two-dimensional gadget or the Pie-chart gadget to group results.
Number Range Searcher (Statistics-compatible)
When you select the Number Range Searcher (Statistics-compatible) as the Search template for a custom field of Number type provided by Jira or JMCF, you can search for issues with the custom field value of a given range and value, and use it in statistics gadgets.
Applicable to
This search template is applicable to:
Use cases
Search Epics with Story points (of all Stories) greater than 50
Group tickets by Business value (Jira custom number field)
Group Epics by number of Story Points of all stories in the Epic
Group tickets by code fix rejection count
- Create a Calculated (Scripted) Number custom field type custom field,
Fix rejected - Click on
Configure for the custom field in the Custom Fields administration page. - Input the transition name Reject in the Transition field.
- Click on
Save . - Perform a re-index as suggested.
- On the dashboard configure a two-dimensional gadget with
Fix rejected and Developer of the issue as the dimensions, grouping by Fix rejected .
|
|
Date Time Range Picker (Statistics by day/week/month/quarter/year)
When you select the Date Time Range Picker (Statistics by day/week/month/quarter/year) as the Search template for a custom field of Date/Time type provided by Jira or JMCF, you can search for issues with the custom field value in a given range and use in statistics gadgets by day, week, month, quarter or year, respectively.
Applicable to
This search template is applicable to:
Use cases
Search tickets with a date of resolution less than 2 days ago
Create a Calculated (Scripted) Date/Time custom field type type custom field, Resolved On. Click on Configure for the custom field in the Custom fields administration page. Click on Edit Groovy Formula and write the following formula: issue.get("resolutiondate") |
- Click on
Save - Change the
Search Template to Date range searcher (Statistics by month). - Perform a re-index as suggested.
|
|
Group requests by the Change completion date
- Click on Edit for the
Change completion date field in the Custom Fields administration page. - Perform a re-index as suggested.
- On the dashboard configure a Pie chart with
Change completion date as the Statistic type .
|
|
Group tickets by Due week
Create a Calculated (Scripted) Date/Time custom field type, Due. Click on Configure for the custom field in the Custom fields administration page. Click on Edit Groovy Formula and write the following formula:
- Click on
Save. - Change the
Search Template to Date range searcher (Statistics by week). - Perform a re-index as suggested.
- On the dashboard configure a Pie chart with
Due as the Statistic type .
|
|
Group tickets by Sprint end date
Create a Calculated (Scripted) Date/Time custom field type, "Sprint End Date". Click on Configure for the custom field in the Custom Fields administration page. Click on Edit Groovy Formula and write the following formula for (Object sprint : issue.get("Sprint")) {
if (sprint.isActive())
return sprint.getEndDate().toDate();
} |
- Click on
Save - Perform a re-index as suggested.
- On the dashboard configure a two-dimensional gadget with
Sprint End Date and Sprint as the dimensions, grouping by Sprint End Date.
|
|
When you select the Exact Text Searcher (Statistics-compatible)
as the Search template for a custom field of text type provided by Jira or JMCF, you can search for issues with the exact text in the custom field value and use it in the statistics gadgets.
Applicable to
This search template is applicable to:
Use cases
Search for issues of a specific Project Category
Create a Calculated (scripted) Text/Html custom field type, Project category . - Click on
Configure for the field in the Custom Fields administration page. Click on Edit Groovy Formula and write the following formula. issue.get("project")?.projectCategory?.name |
- Perform a re-index as suggested.
|
|
Group activities (tickets) by Sponsor (Jira custom single line text field)
Group requests by the time zone of the Reporter
Create a Calculated (scripted) Text/Html custom field type, TimeZone . - Click on
Configure for the field in the Custom Fields administration page. Click on Edit Groovy Formula and write the following formula. import com.atlassian.jira.timezone.TimeZoneManager
// access timeZone of the reporter
def userTimeZone = getComponent(TimeZoneManager).getTimeZoneforUser(issue.reporter).getID() |
- Perform a re-index as suggested.
- On the dashboard configure a Pie chart with
TimeZone as the Statistic type .
|
|
Duration Searchers (Statistics-compatible)
JMCF provides Duration searcher (24x7 durations) and Time Tracking Duration searcher (work time durations). When you select one of these as the Search template for a custom field of duration type provided by JMCF, you can search for issues by duration string and the field can be used in the statistics gadgets.
With the Duration searcher (24x7 durations), durations are treated as calendar durations, where one day is 24 hours and one week is 7 days.
With the Time Tracking Duration searcher (work time durations), durations are treated as work time durations, where the number of hours in a day and the number of days in a week are based on Jira's Time Tracking setting.
In both cases, durations are stored internally as a number of seconds, and will be converted to duration strings according to the selected searcher.
Applicable to
This search template is applicable to:
Use cases
Search for issues with time in current status greater than 3 days
Group tickets by the duration they have been Flagged for
Create a Calculated (Scripted) Duration custom field type, Flagged since - Click on
Configure for the field in the Custom Fields administration page. Click on Edit Groovy formula and write the following formula. if(issue.get("Flagged")){
return (new Date().getTime() - issue.getFieldHistory("Flagged").last().created.getTime())/1000L
}
else{
return null
} |
- Click on
Save . - Select the Duration searcher (24x7 durations)
- Perform a re-index as suggested.
- On the dashboard configure a Pie chart with
Flagged since as the Statistic type .
|
|
Configuring a search template for a custom field
Generally, you can configure a search template for a custom field by editing the custom field. Starting from JMCF you can configure the Search template for any JMCF custom field from the Configure screen as well. This page offers better:
- Search template selection
- explanation of what the search template does
- description of each Search template
- identification (through theicon) of Statistics-compatible searchers
To modify the search template for a JMCF custom field from the Configure screen:
- Log in to JIRA as an administrator.
- Go to the Administration icon and click on it.
- Click on
Issues - > Custom fields.
- Locate the custom field in the Custom fields administration page and click on the cog wheel.
- Click on
Configure
- Click on
Edit Search Template.
- Click on
Save
- Perform a re-index as suggested.
- Note that the selected Search template is a global option for the field. Any change will be applied to all contexts and configuration schemes of this field.
- For a Calculated Duration field, the Search Template also determines how durations are displayed, and how duration strings returned by the formula are parsed.
|