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. |
To add a Calculated Single-select custom field type to your instance:
Issues - > Custom fields.
Add custom field
.Advanced
in the left panel.Calculated Single-select Field type
and select it.Next
.Create
Configure
and create a formula (explained below) for the field.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.
To write a formula for the Calculated Single-select custom field type;
Configure
Edit Groovy Formula
Save.
As documented on the Expected Value tab of the Groovy editor help , the Groovy formula must return either:
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 |
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;
Configure
Edit Velocity Template
.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.For example:
<font color="red"> $formattedValue </font> |
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;
Configure
Edit List View Velocity Template
.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.For example:
<font color="red"> $formattedValue </font> |
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.
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.