A Transition Date/Time custom field type represents a java.util.Date
and is displayed as date+time. It is a read-only field.
Adding a Transition Date/Time custom field type
To add a Transition 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
Transition Date/Time Field
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 specify the transitions(s) and the execution of the transition to look for (explained below). - You can create multiple contexts if you need to associate different transitions to look for with particular projects or issue types.
- Perform a re-index as prompted by JIRA.
If you have upgraded from JMCF 1.x
to 2.x
please refer to the upgrade guide.
Search template
When creating a Transition Date/Time custom field type, you can configure the Search template as Date range picker
to be able to search issues within a date/time range of values for that custom field and it can be used in statistics dashboard gadgets (see below). 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.
Statistics compatible searchers
Date range picker with statistics compatibility are searchers that allow transition date/time fields to be used in statistics gadgets. Date range picker (Statistics by day),
andDate range picker (Statistics by month),
Date range picker (Statistics by quarter),
searchers display the field in statistics gadgets by day, month, quarter and year respectively.
Date range picker (Statistics by year)
Specifying the transition(s) to look for
To specify the transition(s) to look for:
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure
- Click on
Edit Transition(s) to look for.
- You can either manually provide the
name
orid
of the transition or use the Transition picker. You can also optionally provide the workflow name using the Transition picker.
By specifying the workflow name you can use the same calculated field to capture the date/time of different transitions with the same meaning across different workflows. For example: Imagine you want to capture the date/time of transitions that lead to Approved status in a calculated field. Normally you will have to create one calculated field for each transition of a workflow. Using this functionality you can simply add the transition
name
orid
along with the workflow as a row in the table for each transition and use this calculated field for all the issues of your system.- Click on
Add
. - Click on
Save.
To remove a transition to look for:
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure
- Click on
Edit Transition(s) to look for.
- Click on
Remove
for the transition you wish to remove. - Click on
Save
.
Transition picker
To pick a transition using the Transition picker:
- Click on
Transition picker
in the
screen.Configure Transitions
- Choose a workflow from Workflow name
- Select a transition from the list of transitions displayed
- Finally, click on either
Use Transition Name
- recommended if you want the post-function to search for the transition to trigger by name, which is useful when targeting multiple workflows.Use Transition ID
- if you want to differentiate between transitions that bear the same name.
Specifying the execution of the selected transition(s) to look for
To specify the execution of the selected transition(s) that the field should look for;
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure.
- Select either
Latest
orEarliest
from the Transition Execution field to capture the last or first transition execution respectively.
Customizing the formatting of the Transition Date/Time custom field type value
By default, the Transition Date/Time field value is displayed using Jira's default date format (if you leave the Date Format
to Default
). However, you can customize it. To select a format for a Transition Date/Time 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 format
drop-down. - Click on
Save.
Customizing the formatting of the Transition Date/Time custom field type value in the List views
By default, the Transition Date/Time field value is displayed using Jira's default date format (if you leave the Date Column Format
to Default
) in the tabular views. However, you can customize it. To select a format for a Transition Date/Time custom field type value in the List views;
- Locate the custom field on the Custom Fields administration page.
- Click on the cog wheel and click on
Configure
Click on
Edit Date Column Format.
- Select a format from the
Date format
drop-down. - Click on
Save.
For example, if you select the COMPLETE
option in the Date Format/Date Column Format
, and the value captured is Thu Jan 25 15:20:34 IST 2018
, then the value will be formatted to 25/Jan/18 3:20 PM
.
Customizing the display of the Transition Date/Time custom field value
You can 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 Transition Date/time 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, a Date object$formattedValue
: the field value formatted according to the field configuration above- and other variables described on this page
For example:
<div style="border: dashed"> $formattedValue </div>
Displaying the Transition Date/Time custom field type on Transition and Edit screen
The Never show on Transition and Edit screens
option controls whether the Transition Date/Time custom field can appear on transition and edit screens. If you select this option, the field will not be visible on any Edit or Transition screen, even if it is added to the screen.
Accessing the Transition Date/Time custom field value from other Groovy scripts
You can access this field using any of the following getters of the Issue interface
get("Your custom field name") or get("customfield_xxxxx")
that returns aTimestamp
getAsString("Your custom field name")
or
getAsString("customfield_xxxxx")
that returns aString
representing a date+time