A Calculated Single-user custom field type represents an ApplicationUser and is displayed as a String representing the display name of the user. It is a read-only field. |
To add a Calculated Single-user custom field type to your instance:
Issues - > Custom fields.
Add custom field
.Advanced
in the left panel.Calculated Single-user Field type
and select it.Next
.Create
Configure
and create a formula (explained below) for the field.When creating a Calculated Single-user custom field type, you can configure the Search template as User Picker & Group Searcher
to be able to search issues 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.
To write a formula for the Calculated Single-user 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:
ApplicationUser
objectnull
Examples of Groovy formula for a Calculated Single-user custom field type:
A Groovy expression returning a String representing the username
"carter" |
A Groovy expression returning an ApplicationUser
object
issue.get("reporter") |
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 Single-user 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 ApplicationUser
object.$formattedValue
: String representing the display name of the userFor example:
<div style="border: solid"> $formattedValue,$value.name </div> |
displays the user display name and username.
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 write a velocity template for a Calculated Single-user 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 ApplicationUser
object.$formattedValue
: String representing the display name of the userFor example:
<div style="border: solid"> $formattedValue,$value.name </div> |
displays the user display name and username.
The Never show on Transition and Edit screens
option controls whether the calculated Single-user 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
ApplicationUser
getAsString("Your custom field name")
or
getAsString("customfield_xxxxx")
that returns a String
representing a username.