When creating a Calculated Duration custom field type, you can configure the Search template as Duration searcher (using Time Tracking settings)
or Number range searcher
to be able to search for issues within a range of values for that custom field. If you select “None” for the searcher, then you won’t see any reference to this field in the Issue Navigator search fields. Note that changing a custom field searcher requires a re-index.
Configuring the Groovy formula for a Calculated Duration custom field type
To write a formula for the Calculated Duration custom field type;
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure
- Click on
Edit Groovy Formula
- In the editor write a Groovy script that returns a duration String or a number in a Long format representing the number of seconds. Also, you can test you written script against any issue using the Groovy script tester.
- Click on
Save.
See the Expected Value tab of the Groovy help editor for examples on the values expected by this field.
A Groovy expression returning a number in a Long format representing the number of seconds:
Code Block language groovy linenumbers true 144000
A Groovy expression returning a duration String
Code Block language groovy linenumbers true "3w 2d"
A Groovy expression returning the Original estimate of the issue:
Code Block language groovy linenumbers true issue.get("originalestimate")
A Groovy expression adding a week time to the Time Spent on the issue
Code Block language groovy linenumbers true if(issue.timespent){ return issue.timespent + 144000 } else{ return null }
A Groovy expression that returns the duration from issue creation to now. The difference between two date objects returns the number of days and hence you need to convert it into seconds since the calculated field expects either a duration String or a number in a Long format.
Code Block language groovy linenumbers true return (new Date() - issue.created)*24*60*60
Customizing the formatting of the Calculated Duration custom field type value
By default, the Calculated Duration custom field type value is displayed in Duration format. However, you can customize it.
To select a format for a Calculated Duration custom field type value;
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure.
- Select a format from the
Duration format
drop-down. - Click on
Save.
The available formats are:
Duration: The calculated field duration is displayed in the general duration format, where a day has 24 hours. For example, 144000
seconds is displayed as 1day, 16hours
Duration (Time Tracking Format): The calculated field duration is displayed as configured in Jira settings, where a day has 8 hours by default and a week has 5 days. For example, 144000
seconds is displayed as 1w
Number of seconds: The calculated field duration is displayed as a number in a Long format representing the number of seconds.
Customizing the display of the Calculated Duration custom field type value
You can now define a velocity template that will return the Html representation of the calculated custom field. Leave it empty to use the default template.
To write a velocity template for a Calculated Duration custom field type value;
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure
- Click on
Edit Velocity Template
. - Input the template.
- Click on
Save.
You can use the following Velocity variables in the template:
$value
: the raw field value, such as the number of seconds for this field$formattedValue
: the field value formatted according to the field configuration- and other variables described on this page
For example:
Code Block |
---|
<div style="border: dashed"> $formattedValue </div> |
displays the formatted value of the field with a dashed border.
Code Block |
---|
#if( $formattedValue > 2 ) <font color= "red"> <b> Delayed by $formattedValue </b> </font> #else <font color= "blue"> Delayed by $formattedValue </font> #end |
Display of the Calculated Date/Time custom field type on Transition and Edit screen
Now you can control the display of the calculated Date/Time custom field on the transition and edit screens. If you select this option, the field will not be visible on the Edit and Transition screens, even if added to them.