Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 28


Excerpt

A Calculated Date/Time custom field type represents a java.util.Date and is displayed as date+time. It is a read-only field.

Adding a Calculated Date/Time custom field type

To add a Calculated Date/Time custom field type to your instance:

  1. Log in to JIRA as an administrator.
  2. Go to the Administration icon  and click on it.
  3. Click on Issues - > Custom fields.
  4. Click on Add custom field.
  5. Click on Advanced in the left panel.
  6. Locate Calculated Date/Time Field type and select it.
  7. Click on Next.
  8. Provide a name for the custom field
  9. You can optionally provide a description for the custom field.
  10. Click on Create
  11. Associate the custom field to the appropriate screens.
  12. Locate the custom field in the Custom fields administration page and click on the cog wheel.
  13. Click on Configure and create a formula (explained below) for the field.
  14. You can create multiple contexts if you need to associate different formulas with particular projects or issue types.
  15. Perform a re-index as prompted by JIRA.


Note

If you have upgraded from JMCF 1.x to 2.x please refer to the upgrade guide.

Search template

When creating a Calculated Date/Time custom field type, you can configure the Search template as 

  • Date range picker Allows searching for a date and time that is between two other dates and times
  • Date/Time range searcher (Statistics by day/week/month/quarter/year) Allows searching for a date and time that is between two other dates and times. Supports Statistics Gadgets, grouping values by day/week/month/quarter/year respectively

Using these searchers you will be able to search issues within a date/time range of values for that custom fieldThe default search template is Date/Time range searcher (Statistics by day)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

Date/Time range searcher (Statistics by day/week/month/quarter/year) are custom statistics compatible searchers provided by JMCF that allow Date/Time type custom fields of Jira and JMCF to be used in the statistics gadgetsSee here for more information. 

Configuring the Groovy formula for a Calculated Date/Time custom field type

Note

Starting from 2.0.0 BeanShell has been replaced by Groovy in the JMCF add-on. Scripts written in BeanShell will work unchanged in Groovy except for some specific cases.

To write a formula for the Calculated Date/Time custom field type;

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Groovy Formula
  4. In the editor write a Groovy script that returns a String containing a date+time in the format specified in your Jira settings or a date object or a JodaTime object. Also, you can test your script against any issue using the Groovy script tester.
  5. Click on Save.

As documented on the Expected Value tab of the Groovy editor help, the Groovy formula must return either:

  • A String representing a date+time or 
  • A Date object or
  • A JodaTime object or
  • null

Examples of Groovy formula for a Calculated Date/Time custom field:

  • A Groovy expression returning a String containing a date+time. For example,

    Code Block
    languagegroovy
    linenumberstrue
    "11/Apr/18 2:00 PM"


  • A Groovy expression returning a date object. For example, the current date

    Code Block
    languagegroovy
    linenumberstrue
    new Date()


  • A Groovy expression returning a JodaTime object. For example, the current date

    Code Block
    languagegroovy
    linenumberstrue
    import org.joda.time.DateTime
    DateTime date = new DateTime();


  • A Groovy expression that references any field of the issue that returns a java.util.Date. For example, referring the issue updated date/time.

    Code Block
    languagegroovy
    linenumberstrue
    issue.get("updated")


  • A Groovy expression that includes arithmetic operators as well as any other Groovy operator, and Groovy method callsFor example, adding a specific number of days to the issue creation date.

    Code Block
    languagegroovy
    linenumberstrue
    issue.get("created") + 5


Customizing the formatting of the Calculated Date/Time custom field value

By default, the Calculated Date/Time custom field type 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 Calculated Date/Time custom field type value;

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Date Format.

  4. Select a format from the Date format drop-down.
  5. Click on Save.

Customizing the formatting of the Calculated Date/Time custom field 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 the Date 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 views;

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Date Column Format.

  4. Select a format from the Date format drop-down.
  5. Click on Save.

For example, if you select the 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.

Customizing the display of the Calculated Date/Time custom field value

on the issue detail view

You can define a velocity template that will return the Html representation of the calculated custom field on the issue detail view. Leave it empty to use the default template. 

To write a velocity template for a Calculated Date/time custom field type value;

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit Velocity Template.
  4. Input the template.
  5. 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:

Code Block
languagexml
<div style="border: dashed"> $formattedValue </div>

displays the date in a dashed box.

Customizing the display of the Calculated Date/Time custom field value on the list views

You can define a velocity template that will return the Html representation of the calculated custom field in search result list views. Leave it empty to use the default template. 

To write a velocity template for a Calculated Date/time custom field type value;

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure
  3. Click on Edit List view Velocity Template.
  4. Input the template.
  5. 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:

Code Block
languagexml
<div style="border: dashed">
  $formattedValue
</div>

displays the date in a dashed box.

Displaying the Calculated Date/Time custom field type on Transition and Edit screen

The Never show on Transition and Edit screens option controls whether the calculated 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 Calculated Date/Time custom field value from other Groovy scripts

You can access this field using any of the following getters of the Issue interface