java.util.Date
(which represents a date+time). It is If you have upgraded from JMCF 1.x
to 2.x
please refer to the upgrade Excerpt |
---|
A Calculated Duration custom field type returning a duration string or a number in Long format representing the number of seconds. It is a read-only field that returns the result of the evaluation of a formula. |
Adding a Calculated
Date/TimeDuration custom field type
To add a Calculated Date/Time custom field type to your instance:
- Log in to JIRA as an administrator.
- Go to the Administration icon and click on it.
- Click on
Issues - > Custom fields.
- Click on
Add custom field
. - Click on
Advanced
in the left panel. - Locate
Calculated Date/Time Duration Field type
and select it. - Click on
Next
. - Provide a name for the custom field.
- You can optionally provide a description for the custom field.
- Click on
Create.
- Associate the custom field to the appropriate screens.
- Locate the custom field in the Custom fields administration page and click on the cog wheel.
- Click on
Configure
and create a formula (explained below) for the field. - You can create multiple contexts if you need to associate different formulas with particular projects or issue types.
- Perform a re-index as prompted by JIRA.
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
| ||
Search template
When creating a Calculated Date/Time Duration custom field type, you can configure the Search template as Date range picker
to to be able to search for issues within a date/time 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
Date/Time custom field typeDuration custom field type
To write a formula for the Calculated Date/Time 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
java.util.Date
. You a String containing a duration or 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 for examples on the values expected by this field. Some more examples of a writing a Groovy formula:
A Groovy expression that references any field of the issue that returns a
java.util.Date.
For example, storing the issue updated date/time.A Groovy expression returning ajava.util.Date.
For example returning the current date/timeCode Block language groovy linenumbers true new Date()
the Original estimate of the issue:
Code Block language groovy linenumbers true issue.get("updated")
A Groovy expression that includes arithmetic operators as well as any other Groovy operator, and Groovy method calls. For example, adding a specific number of days to the issue creation date.
Code Block language groovy linenumbers true issue.get("created") + 5
Note |
---|
Make sure that the formula returns either a |
originalestimate")
Customizing the display of the Calculated
Date/TimeDuration custom field type value
By default, the Calculated Date/Time Duration custom field type value is displayed using Jira's default date format (if you leave the Date Format
to Default
)in Duration format. However, you can customize it. To
To select a format for a Calculated Date/Time 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 Date Format.
- Select a format from the
Date Duration format
drop-down. - Click on
Save.
The available formats are:
Duration: The calculated field duration is displayed as a 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.
Customizing the display of the Calculated Date/Time custom field type value in the List views
By default, the Calculated Date/Time custom field type value is displayed using Jira's default date format (if you leave theDate Column Format
to Default
) in the tabular views. However, you can customize it. To select a format for a Calculated Date/Time custom field type value in the List viewsFor example, 144000
seconds is displayed as 1w
Number of seconds: The calculated field duration is displayed as a number in Long format representing the number of seconds.
Return the Html representation 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 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
- Click on
Edit
Date Column FormatVelocity Template
. - Select a format from the
Date format
drop-downInput the template. - Click on
Save.
COMPLETE
option in the Edit Date Format/Edit Date Column Format
, and the value returned by the Groovy formula is Thu Jan 25 15:20:34 IST 2018
, then the value will be formatted to 25/Jan/18 3:20 PM
You can use the following Velocity variables in the template:
$value
: the raw field value (such as a Date object for a date/time calculated 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.