Calculated (Scripted) Single-select custom field type

NEW IN JMCF 2.0.0

A Calculated Single-select custom field type represents an Option and is displayed as a String representing an Option value. It is a read-only field. You will need to configure options to this field just like any Jira Standard custom field of Single select list/Radio buttons type.

Adding a Calculated Single-select custom field type

To add a Calculated Single-select 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 Single-select 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.
Add options 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.

On this page

Related links

Search template

When creating a Calculated Single-select custom field type, you can configure the Search template as Multi select searcher for guided search, and it can be used in statistics dashboard gadgets. 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 Single-select custom field type

To write a formula for the Calculated Single-select 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 String representing an Option value/id or an Option object. Also, you can test your script against any issue using the Groovy script tester.
Click on Save.

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

A String representing an Option value or id
An Option object
null

Examples of Groovy formula for a Calculated Single-select custom field type:

A Groovy expression returning a String representing the Option value
```
"Option 1"
```
A Groovy expression returning a String representing the option id
```
10010
```
A Groovy expression returning an Option object
```
issue.get("Multi-select list").last().value
```

Customizing the display of the Calculated Single-select 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 select a format for a Calculated Single-select 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, an Option object.
$formattedValue: String representing an Option value.
and other variables described on this page

For example:

<font color="red">
    $formattedValue
</font>

Customizing the display of the Calculated Single-select custom field value on the search list view

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

To select a format for a Calculated Single-select 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 List View Velocity Template.
Input the template.
Click on Save.

You can use the following Velocity variables in the template:

$value: the raw field value, an Option object.
$formattedValue: String representing an Option value.
and other variables described on this page

For example:

<font color="red">
    $formattedValue
</font>

Displaying the Calculated Single-select custom field type on Transition and Edit screen

The Never show on Transition and Edit screens option controls whether the calculated Single-select 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 Single-select custom field 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 a Option
getAsString("Your custom field name") or getAsString("customfield_xxxxx") that returns a String representing an option value or id.