Status | ||||
---|---|---|---|---|
|
Excerpt |
---|
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. |
Adding a Calculated Single-user custom field type
To add a Calculated Single-user 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-user 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.
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
| ||
Search template
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.
Configuring the Groovy formula for a Calculated Single-user custom field type
To write a formula for the Calculated Single-user 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 a username or an ApplicationUser 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 a username
- An
ApplicationUser
object null
Examples of Groovy formula for a Calculated Single-user custom field type:
A Groovy expression returning a String representing the username
Code Block language groovy linenumbers true "carter"
A Groovy expression returning an
ApplicationUser
objectCode Block language groovy linenumbers true issue.get("reporter")
Customizing the display of the Calculated Single-user custom field type 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 write a velocity template for a Calculated Single-user 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, anApplicationUser
object.$formattedValue
: String representing a username- and other variables described on this page
For example:
Code Block |
---|
<div style="border: solid"> $formattedValue,$value.name </div> |
the raw value of the calculated field in a solid borderdisplays the user display name and username.
Displaying the Calculated Single-user custom field type on Transition and Edit screen
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.
Accessing the Calculated Single-user 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 aApplicationUser
getAsString("Your custom field name")
or
getAsString("customfield_xxxxx")
that returns aString
representing a username.