Versions Compared

Old Version 3

changes.mady.by.user Radhika Vijji.

Saved on

compared with

New Version 4

changes.mady.by.user Radhika Vijji.

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Status
colourYellow
titleNew in JMCF 2.0.0

Excerpt


A Status entered by user custom field type that represents a user who last (or first) moved the issue to the specified status and is displayed as a String representing a usernamethe user display name. It is a read-only field.

Adding a Status entered by User custom field type

To add a Status entered by User 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 Status entered by user custom 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  Configure and specify the status(es) and the order of status entered (explained below) for the field.
  14. You can create multiple contexts if you need to associate different formulas contexts with particular projects or issue types.
  15. Perform a re-index as prompted by JIRA.


Panel
titleOn this page

Table of Contents


Panel
titleRelated links
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 Status Entered by User custom field type, you can configure the Search template as Date range picker to  as User Picker & Group searcher to be able to search issues within a date/time range of values for for a user in 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 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;

Specifying the status(es) to look for

To specify the status(es) to look for:

  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
  • In the editor write a Groovy script that returns a java.util.Date. You can test you written script against any issue using the Groovy script tester.
  • Click on Save.

    • Some examples of a Groovy formula:

    A Groovy expression returning a java.util.Date. For example returning the current date/time

    Code Block
    languagegroovy
    linenumberstrue
    new Date()

    A Groovy expression that references any field of the issue that returns a java.util.Date. For example, storing 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 calls. For example, adding a specific number of days to the issue creation date.

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

    Make sure that the formula returns either a java.util.Date or a String representing a Date or null. You can test your written scripts against any issue using the Groovy script tester.

    Customizing the display of the Calculated Date/Time custom field type 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
    1.  Edit Status(es).
    2. Select the status(es).
    3. Click on Save.
    Note

    You can also configure the custom field to look for the current status.


    Customizing the display of the Status entered by User 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 select a format for the Status entered by user 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
    1. Velocity Template.
    Select a format from the Date format drop-down
    1. Input the template.
    2. Click on Save.

    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 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

    You can use the following Velocity variables in the template:

    • $value: the raw field value, the ApplicationUser object.
    • $formattedValue: a String representing the display name of the user
    • 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.

    Display of the Status entered by user custom field type on Transition and Edit

    screen

    screens

    Now you can control the display of the calculated Date/Time Status entered by user 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.


    Accessing the Status entered by user custom field type from other Groovy scripts

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