Page Comparison

This page explains how to access the value of User-created custom fields of different field types using Groovy. You can access them using the getters of the Issue interface. However, accessing custom fields using the native Jira API can be much more complex, depending on the type of the custom field being accessed. Instead, it is easier to access the fields using the methods provided by JMWE. To understand how to write values into the writable custom fields see Raw value/text input for fields and Groovy expression input for fields.

...

Panel

borderStyle	solid

Checkboxes / Multi-select list

Description: A Field of the type Checkboxes/Multi-select list, is an array of objects. Each selected option is an object in itself.
Accessing a field of Checkboxes/Multi-select list type: You can access a custom field of Checkboxes/Multi-select type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<Option>
  - Example: First selected option value of a checkbox field
    Code Block
    language groovy
    linenumbers true
    issue.get("<CheckboxesCheckboxes field name>name")?.first()?.getValue()
  - Example: is a specific option selected?
    Code Block
    language groovy
    issue.get("<CheckboxesCheckboxes field name>name")?.find() { it.getValue() == "An option" } != null
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx")that returns a String with comma separated Option values
  - Example: Options selected
    Code Block
    language groovy
    issue.getAsString("<CheckboxesCheckboxes field name>name")

Panel

borderStyle	solid

Radio buttons / Single-select list

Description: A field of Radio buttons/Single-select list type is an object that represents an option.
Accessing a field of Radio buttons/Single-select list type: You can access a custom field of Radio buttons/Single-select list type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a String
  - Example: is a specific option selected?
    Code Block
    language groovy
    issue.get("<RadioRadio button field name>name") == "An option"
  - Example: Option value of the Single-select list
    Code Block
    language groovy
    issue.get("<SingleSingle-select list field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the value of the Option
  - Example: Option selected
    Code Block
    language groovy
    issue.getAsString("<SingleSingle-select list field name>name")
- getRawValue("<Your Your custom field name>name") or getRawValue("customfield_xxxxx") that returns a Option
  - Example: Option selected
    Code Block
    language groovy
    issue.getRawValue("<SingleSingle-select list field name>name")

Panel

borderStyle	solid

Cascading

Description: A field of Cascading type is a Map with the Key as String and Value as the Option

Accessing a field of Cascading type: You can access a custom field of Cascading type using any of the following getters of the Issue interface:

get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Map<String, Option>

Example: Parent of the cascading field
Code Block
language groovy
issue.get("Cascade")?.get(null)?.getValue()

Example: Return parent and child of the cascading field as Strings separated by a comma:

Code Block

language	groovy

if (issue.get("<CascadingCascading type field name>name"))
{
  if(issue.get("<CascadingCascading type field name>name").get("1"))
  {
    return issue.get("<CascadingCascading type field name>name").get(null).getValue() + "," + issue.get("<CascadingCascading type field name>name").get("1") 
  }
  return issue.get("<CascadingCascading type field name>name").get(null).getValue()
}

getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String with the parent and child value separated by a comma
- Example: Return parent and child of the cascading field as Strings separated by a comma:
  Code Block
  language groovy
  issue.getAsString("<CascadingCascading type field name>name")

Groups

Panel

borderStyle	solid

Single-Group Picker

Description: A field of Single-group picker type is an object that represents a group.
Accessing a field of Single-Group picker type: You can access a custom field of Single-group picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<Group>
  - Example: Name of the first selected group
    Code Block
    language groovy
    issue.get("<SingleSingle-group picker name>name")?.first()?.getName()
  - Example: Is a specific group selected?
    Code Block
    language groovy
    issue.get("<SingleSingle-group picker name>name")?.find() { it.getName() == "Group name" } != null
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the group name:
  - Example: Name of the selected group
    Code Block
    language groovy
    issue.getAsString("<SingleSingle-group picker name>name")

Panel

borderStyle	solid

Multi-Group Picker

Description: A field of Multi-group picker is an array of objects. Each group is an object in itself.
Access a field of Multi-group picker type: You can access a custom field of Multi-group picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<Group>
  - Example: Name of the first selected group
    Code Block
    language groovy
    issue.get("<MultiMulti-group picker name>name")?.first()?.getName()
- - Example: Is a specific group selected?
    Code Block
    language groovy
    linenumbers true
    issue.get("<MultiMulti-group picker name>name")?.find() { it.getName() == "Group name" } != null
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String with comma separated Group names
  - Example: Groups selected
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<MultiMulti-group picker name>name")

Users

Panel

borderStyle	solid

Single-User picker

Description: A field of Single-user picker is an object that represents a user.
Accessing a field of Single-user type: You can access a custom field of Single-user picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns an ApplicationUser
  - Example: Email Address of the user selected in the field
    Code Block
    language groovy
    linenumbers true
    issue.get("<SingleSingle-user picker field name>name")?.getEmailAddress()
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the username
  - Example: User selected in the field
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<SingleSingle-user picker field name>name")

Panel

borderStyle	solid

Multi-user picker

Description: A field of multi-user picker type is an array of objects. Each user is an object in itself.
Accessing a field of Multi-user picker type: You can access a custom field of Multi-user picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<ApplicationUser>
  - Example: Is the reporter of the issue selected?
    Code Block
    language groovy
    linenumbers true
    issue.get("<MultiMulti-user picker field name>name")?.find() { it.getName() == issue.get("reporter").getName() } != null
  - Example: Email address of all the selected users:
    Code Block
    language groovy
    linenumbers true
    def EmailId = [] issue.get("MUP")?.findAll() { EmailId.push(it.getEmailAddress()) } return EmailId
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String with comma separated Usernames.
  - Example: All the selected users:
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<MultiMulti-user picker field name>name")

Panel

borderStyle	solid

Watchers field type

Description: A field of the Watchers type is an array of objects. Each user is an object in itself.
Accessing a field of Watchers field type: You can access a custom field of Watchers field type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<ApplicationUser>
  - Example: Number of Watchers in the custom field
    Code Block
    language groovy
    linenumbers true
    issue.get("<YourYour custom field name>name").size()
  - Example: All the Watchers in the custom field except the Reporter
    Code Block
    language groovy
    linenumbers true
    issue.get("<YourYour custom field name>name")?.findAll { it.getName() != issue.get("reporter").getName() }
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String with comma separated Usernames.
  - Example: All Watchers in the custom field
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<YourYour custom Watchers field name>name")

Versions

Panel

borderStyle	solid

Single-version picker

Description: A field of Single-version picker type is an object that represents a version.
Accessing a field of Single-Version picker type: You can access a custom field of Single-version picker type using any of the following getters of the Issue interface
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<Version>
  - Example: Release date of the selected version:
    Code Block
    language groovy
    linenumbers true
    issue.get("<SingleSingle-Version picker field name>name")?.last()?.getReleaseDate()
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the name of the version:
  - Example: Release date of the selected version:
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<SingleSingle-Version picker field name>name")

Panel

borderStyle	solid

Multi-version picker

Description: A field of Multi-version picker type is an array of objects. Each version is an object in itself.
Accessing a field of Multi-version picker type: You can access a custom field of Multi-version picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<Version>
  - Example: Are the selected versions same as the Affects Version/s?
    Code Block
    language groovy
    linenumbers true
    issue.get("<MultiMulti-Version picker field name>name") == issue.get("versions")
- - Example: Release date of the last versions
    Code Block
    language groovy
    linenumbers true
    issue.get("<MultiMulti-Version picker field name>name")?.last()?.getReleaseDate()
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String with comma separated Version names
  - Example: Selected versions:
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<MultiMulti-Version picker field name>name")

Text

Panel

borderStyle	solid

Single-line text field type

Description: A field of Single-line text type is a string that represents a single-line text.
Accessing a field of Single-line text field type: You can access a custom field of Single-line text type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a String
  - Example: Text of the field
    Code Block
    language groovy
    linenumbers true
    issue.get("<SingleSingle-line text field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the text:
  - Example: Text of the field
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<SingleSingle-line text field name>name")

Panel

borderStyle	solid

Multi-line text field type

Description: A field of Multi-line text type is a string that represents a multi-line text.
Accessing a field of Multi-line text field type: You can access a custom field of Multi-line text type using any of the following getters of the Issue interface:
get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a String
- Example: Text of the field
  Code Block
  language groovy
  linenumbers true
  issue.get("<MultiMulti-line text field name>name")
getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the text:
- Example: Text of the field
  Code Block
  language groovy
  linenumbers true
  issue.getAsString("<MultiMulti-line text field name>name")

Panel

borderStyle	solid

Read-only text field type

Description: A field of Read-only text type is a string that represents a read-only text.
Accessing a field of Multi-line text field type: You can access a custom field of Read-only text type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a String
  - Example: Text of the field
    Code Block
    language groovy
    linenumbers true
    issue.get("<ReadRead-only text field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the text:
  - Example: Text of the field
    Code Block
    language groovy
    linenumbers true
    issue.get("<ReadRead-only text field name>name")

Date/Time picker

Panel

borderStyle	solid

Date picker

Description: A field of Date picker type is a Timestamp (Date) object.
Access a field of Date picker type: You can access a custom field of Date type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Timestamp
  - Example: The value of the Date picker type field
    Code Block
    language groovy
    linenumbers true
    issue.get("<DateDate picker field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the date:
  - Example: The value of the Date picker type field
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<DateDate picker field name>name")
    To manipulate the date see here

...

Panel

borderStyle	solid

Date time picker

Description: A field of Date time picker type is a Timestamp (Date) object.
Accessing a field of Date time picker type: You can access a custom field of Date time picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Timestamp
  - Example: return the date without the time value (or rather at 00:00:00)
    Code Block
    language groovy
    linenumbers true
    issue.get("<DateDate picker field name>name").clearTime()
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the date-time:
  - Example: Date time picker value
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<DateDate picker field name>name")
    To manipulate the date see here

...

Panel

borderStyle	solid

Numeric field

Description: A field of Numeric type is a number.
Accessing a field of Numeric type: You can access a custom field of Numeric type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Double
  - Example: Value of the numeric field
    Code Block
    language groovy
    linenumbers true
    issue.get("<NumericNumeric field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the Number
  - Example: Value of the numeric field
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<NumericNumeric field name>name")

Panel

borderStyle	solid

Project picker type

Description: A field of Project picker type is an object describing a project.
Accessing a field of Project picker type: You can access a custom field of Project picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Project
  - Example: Is the project same as the project the current issue belongs to?
    Code Block
    language groovy
    linenumbers true
    issue.get("<ProjectProject picker type field name>name") == issue.get("project")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the key of the project:
  - Example: Name of the project picked:
    Code Block
    language groovy
    linenumbers true
    issue.getAsString("<ProjectProject picker type field name>name")

Panel

borderStyle	solid

URL field type

Description: A field of URL type is a string representation of an URL
Accessing a field of URL type: You can access a custom field of Project picker type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a String
  - Example: URL value
    Code Block
    language groovy
    linenumbers true
    issue.get("<URLURL type field name>name")
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx") that returns a String representing the URL
  - Example: URL value
    Code Block
    language groovy
    linenumbers true
    issue.get("<URLURL type field name>name")

Add-on provided custom fields

...

Panel

borderStyle	solid

Checklist

Description: A Field of the type Checklist, is an array of Check list items. Each selected ChecklistItem is an object in itself.
Accessing a field of Checklist type: You can access a custom field of Checklist type using any of the following getters of the Issue interface:
- get("<Your Your custom field name>name") or get("customfield_xxxxx") that returns a Collection<ChecklistItem>
  - Example: Name of the first ChecklistItem of a checklist field
    Code Block
    language groovy
    linenumbers true
    issue.get("<ChecklistChecklist field name>name").first().name
  - Example: is a specific ChecklistItem selected?
    Code Block
    language groovy
    issue.get("<ChecklistChecklist field name>name")?.find{ it.name == "test" }?.isChecked()
  - Example: All mandatory ChecklistItem
    Code Block
    language groovy
    issue.get("<ChecklistChecklist field name>name")?.findAll{ it.mandatory == true }
  - Example: Print all the names of the ChecklistItems
    Code Block
    language groovy
    <% def count = 0 issue.get("<ChecklistChecklist field name>name").each() { count++ print "Checklist Item " + count + ": " + it.name + "\n" } %>
- getAsString("<Your Your custom field name>name") or getAsString("customfield_xxxxx")that returns a String with comma separated ChecklistItem
  - Example: All Checklist item
    Code Block
    language groovy
    issue.getAsString("<ChecklistChecklist field name>name")

Versions Compared

Old Version 37

New Version 38

Key

Checkboxes / Multi-select list

Radio buttons / Single-select list

Cascading

Groups

Single-Group Picker

Multi-Group Picker

Users

Single-User picker

Multi-user picker

Watchers field type

Versions

Single-version picker

Multi-version picker

Text

Single-line text field type

Multi-line text field type

Read-only text field type

Date/Time picker

Date picker

Date time picker

Numeric field

Project picker type

URL field type

Add-on provided custom fields

Checklist