Select subset of available options of a checklist/multi-select based on a regular expression in Groovy

Abstract

This code snippet sets a Checklist/Multi-select type field with a subset of the available options based on a regular expression

Logic

Access the available options of the Checklist/Multi-select type field and find all the options with the specific text.

Snippet

def regExp = ~/^(?i).*<Text to match in the option>.*/
issue.getAvailableOptions("<Name of the field>").findAll{
  it.getValue().matches(regExp)
}

Placeholders

Examples

def regExp = ~/^(?i).*installation.*/
issue.getAvailableOptions("Installations list").findAll{
  it.getValue().matches(regExp)
}

Context

The output of the code is a Collection<Option> which you could use:

• To set a Checkboxes/Multi-select field in :
  • one of the Set Field Value post-functions
  • one of the Transition issue post-functions on the transition screens, if any
  • the Create issue post-function under Set fields of new issue section
• To include the Checkboxes/Multi-select field values in the Comment in one of the Comment issue post-functions using the toString() method to the result
• In a conditional execution using the asBoolean() method to the result of the script to
  • Run a post-function 
  • Run a condition
  • Run a validator
  • Unlink issues

Use cases

A typical use case would be to - Select the Installation tasks in the Checkboxes/Multi-select type field when all the Installations are done

Reference

• Variables used in a Groovy expression
• Issue interface
• Accessing a field of Checkboxes/Multi-select type
• Groovy Documentation

Related articles