Uncheck/Unselect an option

Abstract

This code snippet unchecks a specific value of a standard or custom multi-valued type field (typically a multi-select field). The multi-valued fields can either be a collection of objects or a set of values. While unchecking all is easy (set the field with a blank value), unchecking only a particular option/value requires code. 

Logic

Iterate over the array of selected options and add them into a new array ignoring the option that needs to be unchecked.

Snippet

For multi-select fields:

//Retain all options ignoring the option that needs to be unchecked
def newValues = issue.get("<Name of the field>").findAll{
  it.getValue() != "<Value of the option to uncheck>"
}
return newValues

Placeholders

For multi-versions/users/components/groups fields (e.g. Fix Version/s):

//Retain all options ignoring the option that needs to be unchecked
def newValues = issue.get("<Name of the field>").findAll{
  it.getName() != "<Value to uncheck>"
}
return newValues

Placeholders

For Labels field:

//Retain all options ignoring the option that needs to be unchecked
def newValues = issue.get("<Labels field>").findAll{
  it.getLabel() != "<Label to remove>"
}
return newValues

Placeholders

Examples

The output of the code is an array of objects which you could use in a Groovy expression to remove a particular option from the selected options of a field in one of the Set Field Value post-functions and the Create issue post-function under Set fields of new issue section.

• Remove the reporter from the JIRA service desk customers

  def newValues = issue.get("JIRA Service Desk customers").findAll{
    it.getName() != issue.get("reporter").getName()
  }
  return newValues

• Clear the option "To Print" after the print has been generated

  def newValues = issue.get("Documents processing").findAll{
    it.getValue() != "To Print"
  }
  return newValues

• Remove the label "Merged" when QA re-opens a ticket that has been merged into master and handed over to QA.

  def newValues = issue.get("Labels").findAll{
    it.getLabel() != "Merged"
  }
  return newValues

References

• Variables used in a Groovy expression
• Issue interface
• Accessing the fields of an issue
• Groovy Documentation

Related articles

• Page:
  Set the assignee of an issue based on time in a specific time zone
• Page:
  Validate cascading field - The parent option is mandatory and the child option, if exists, is required.
• Page:
  Set assignee of the issue based on day of the month.
• Page:
  Link parent of the current sub-task to new issue in “Create / Clone issue(s) (JMWE app)” post-function
• Page:
  Code snippet to add a link to a workflow transition in the email