Checking the value of a multi-valued field

Abstract

This code snippet checks the 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.

Logic

Iterate over the array of objects or set of values and check a specific field for the required value.

Snippet

For multi-select fields:

//Run a loop on all the selected options of the field and find the desired option
issue.get("<Name of the field>").any{
  it.getValue() == "<Value of the field>"}

Placeholders

Placeholder	Description	Example

Placeholder	Description	Example
`<Name of the field>`	Name of the multi-select field	`Checkboxes`
`<Value of the field>`	Value of the option	Verification done

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

//Run a loop on all the selected options of the field and find for the desired object
issue.get("<Name of the field>").any {
  it.getName() == "<Name of the desired version>"}

Placeholders

Placeholder	Description	Example

Placeholder	Description	Example
`<Name of the field`>	Name of the multi-valued version field	`fixVersions`
`<Name of the desired version>`	Name of the version to find	`2.0`

For Labels field:

//Run a loop on all the selected labels of the field and find for the desired label
issue.get("<Name of the field>").any {
  it.getLabel() == "<Desired label>"}

Placeholders

Placeholder	Description	Example

Placeholder	Description	Example
`<Name of the field`>	Name of the labels field	`labels`
`<Desired label>`	Label to find	`Use-case`

Examples

The output of the code is a boolean value (true or false) which you could use to

Calculate and display a flag on the issue view screen if the issue has been flagged. For this, you will need to write a Groovy script to check that the issue has been Flagged and based on the result display a Flag using a Velocity template. See here for the use case.
return issue.get("Flagged").any { it.getName() == "Impediment"}

Checking the value of a multi-valued field

Abstract

Logic

Snippet

For multi-select fields:

Placeholders

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

Placeholders

For Labels field:

Placeholders

Examples

References

Related articles