nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Groovy Script Unsuccessful Workflow Transition Block if Custom Field Aerial Value is "Yes"

Daniel McCollum

Hi All,

Newbie here, struggling to putting together working script after several hours of attempted learning and forum research.

Jira Software Server 9.0.0 (On-Premise) and Groovy Scripting.

Goal: prevent user from transitioning an issue forward in workflow if selected value from among aerial options ("Yes", "No" or the default "None") for custom field is set to "Yes".

Here's the code block so far... bolded/italicized code is where I've been unsuccessful.

import com.atlassian.jira.issue.Issue
import com.atlassian.jira.component.ComponentAccessor
import com.opensymphony.workflow.InvalidInputException
import com.atlassian.jira.issue.fields.CustomField

def CUSTOM_FIELD_ID = 10405L
def MESSAGE_ERROR = "Field ${getCustomFieldObject(CUSTOM_FIELD_ID)} is required"

if(getCustomFieldValue(issue, CUSTOM_FIELD_ID).name == "Yes"){ 
throw new InvalidInputException("Response cannot be "Yes", click Cancel") 
}

if(!getCustomFieldValue(issue, CUSTOM_FIELD_ID)){
throw new InvalidInputException(MESSAGE_ERROR)
}

def getCustomFieldValue(issue, Long fieldId) {
issue.getCustomFieldValue(getCustomFieldObject(fieldId))
}

def getCustomFieldObject(Long fieldId) {
ComponentAccessor.customFieldManager.getCustomFieldObject(fieldId)
}

Above script is successful in blocking transition when there is not a custom field value entered by user (i.e., "None"), but again, having huge time in attempting to solve for also blocking transition if user chooses/selects "Yes" and tries to move issue forward in workflow.

Any help or input is very appreciated!

Accepted answers

Florian Bonniec

Hi @Daniel McCollum

Have you check what is returned by logging it ?

getCustomFieldValue(issue, CUSTOM_FIELD_ID).name

Have you try

getCustomFieldValue(issue, CUSTOM_FIELD_ID).get value()

Regards

Daniel McCollum

Hi @Florian Bonniec ,

Your script listed on 10/20/2022 is more efficient, so will need to spend some time comparing against what was written initially on my end - really appreciate your efforts and input!

Script below (from @Florian Bonniec) in Groovy inline script for Jira is without warnings and works successfully, meeting intended purpose of what I was trying to accomplish - see screenshots below script...

import com.atlassian.jira.issue.Issue
import com.atlassian.jira.component.ComponentAccessor
import com.opensymphony.workflow.InvalidInputException
import com.atlassian.jira.issue.fields.CustomField
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.issue.customfields.option.LazyLoadedOption

//custom field id (update "00000")
def CUSTOM_FIELD_ID = 00000
def customFieldManager = ComponentAccessor.getCustomFieldManager()

//Custom field name called Require Design with options yes no none
CustomField myCustomField = ComponentAccessor.getCustomFieldManager().getCustomFieldObject(CUSTOM_FIELD_ID)

//Custom field value retrieved
def value = ((LazyLoadedOption) issue.getCustomFieldValue(myCustomField))?.getValue()

//Message error for "None"
def MESSAGE_ERROR = "Field ${myCustomField.getName()} is required"

//Block workflow transition if "Yes" option returned
if(value == "Yes"){
throw new InvalidInputException("Response cannot be Yes, click Cancel")
}

//Block transition if "None" option returned
if(!value){
throw new InvalidInputException(MESSAGE_ERROR)
}

All comments

Florian Bonniec

Hi @Daniel McCollum

Have you check what is returned by logging it ?

getCustomFieldValue(issue, CUSTOM_FIELD_ID).name

Have you try

getCustomFieldValue(issue, CUSTOM_FIELD_ID).get value()

Regards

Daniel McCollum

Thanks for the reply @Florian Bonniec .

Did you mean try replacing

if(getCustomFieldValue(issue, CUSTOM_FIELD_ID).name == "Yes")

with

if(getCustomFieldValue(issue, CUSTOM_FIELD_ID).get value()

Radek Dostál

I think he meant '.getValue()' which should return the string representation of the option.

Option customfields normally return a LazyLoadedOption: https://docs.atlassian.com/software/jira/docs/api/8.20.12/com/atlassian/jira/issue/customfields/option/LazyLoadedOption.html#getValue--

Florian Bonniec

@Daniel McCollum

Replace .name by .get value()

After getCustomFieldValue(issue, CUSTOM_FIELD_ID)

Daniel McCollum

Hi @Florian Bonniec ,

Your script listed on 10/20/2022 is more efficient, so will need to spend some time comparing against what was written initially on my end - really appreciate your efforts and input!

import com.atlassian.jira.issue.Issue
import com.atlassian.jira.component.ComponentAccessor
import com.opensymphony.workflow.InvalidInputException
import com.atlassian.jira.issue.fields.CustomField
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.issue.customfields.option.LazyLoadedOption

//custom field id (update "00000")
def CUSTOM_FIELD_ID = 00000
def customFieldManager = ComponentAccessor.getCustomFieldManager()

//Custom field name called Require Design with options yes no none
CustomField myCustomField = ComponentAccessor.getCustomFieldManager().getCustomFieldObject(CUSTOM_FIELD_ID)

//Custom field value retrieved
def value = ((LazyLoadedOption) issue.getCustomFieldValue(myCustomField))?.getValue()

//Message error for "None"
def MESSAGE_ERROR = "Field ${myCustomField.getName()} is required"

//Block workflow transition if "Yes" option returned
if(value == "Yes"){
throw new InvalidInputException("Response cannot be Yes, click Cancel")
}

//Block transition if "None" option returned
if(!value){
throw new InvalidInputException(MESSAGE_ERROR)
}

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

server

jira-software

jira-administration

jira-server

jira-software-server

groovy