Limit Fix Version to one value

Alex Christensen Community Champion Oct 11, 2016

I am trying to limit the user's input into Fix Version/s to only one value. I can do this easily in a validator as part of the workflow using ScriptRunner, but I'm having a lot of trouble even coming up with an idea of how to do this using a script listener in case a user makes inline changes or edits to an issue. Is there a way I can make the Fix Version/s field have a validator as a script listener?

2 answers

1 accepted

1 vote
Accepted answer

We did this some time ago with a listener. 

When the user provided a second fixVersion then the older one was deleted and a comment was created to inform the user about it.

It does not work exactly as a validator but more like a post update rutine. The good part is that you always have the change history of the issue so it is easy to go back.

That sounds like a pretty good workaround.

Alex Christensen Community Champion Oct 11, 2016

Appreciate the feedback from both of you - this seems like the best option for us, probably. Thanks for your help!

Hmm, I am surprised about the answers, or do I miss something? Using a Listener to do input validation seems strange to me...With the behavior module of scriptrunner this is very easy to do (we did), and it works very well. When the user tries to add 2 values in the version field, an error message is shown below the field and the user can't save.

The only "disadvantage" is that in-line editing for the version field is blocked as behaviors do not work in in-line editing mode (blocking the in-line editing for fields with behaviors is an acceptable limitation for us)

Alex Christensen Community Champion Oct 12, 2016

Thanks, Marc. I've been messing with the Behaviors plugin this morning and was able to get this script so far.

import com.atlassian.jira.project.version.Version


def fixVersions = getFieldById(getFieldChanged())
Collection<Version> fixVersionsValue = (Collection<Version>) fixVersions.getValue()


if (fixVersionsValue.size() > 1) {
    fixVersions.setError("Fix Version/s can only be one value.")
}
else {
    fixVersions.clearError()
}

However, even though there is an error set on this field, I'm still able to save and submit the Edit form. Am I missing something from the script here?

Interesting smile

What version of scriptrunner do you use ? We had the same issue (bug?) when migrating to JIRA 7.1.7 and Scriptrunner 4.3.5.

I got a patch version Scriptrunner 4.3.7-m3 from Adaptavist (Jamie) that solved this problem. I did not validate (yet, nor install) if the "official" versions 4.3.8 or 4.3.9 include this fix...

...I think you also have to add the setValid method on the form field:

if (fixVersionsValue.size() > 1) {
	fixVersions.setValid(false)
    fixVersions.setError("Fix Version/s can only be one value.")
}
else {
	fixVersions.setValid(true)
    fixVersions.clearError()
}
Alex Christensen Community Champion Oct 12, 2016

Just tried adding the setValid method - no luck, unfortunately. I'm still able to save the Edit form. Is there documentation that covers all of the methods I can use on a FormField object? I noticed the setValid method isn't in the Quick Reference section when creating an inline script, so I'm curious to know if there are other methods I don't know about that I can use. Can't seem to find it in the Adaptavist documentation for the plugin.

As for the versions we're on - for JIRA, we haven't been able to upgrade to JIRA 7 yet, so we're still on 6.4.6 and ScriptRunner is version 4.1.3.16.

Alex Christensen Community Champion Oct 12, 2016

After some more trial and error, I figured out that if I set the field to be optional in the Behavior configurations, this validation script works correctly now. I can add some else block to the script to set the field as required if there are no values in the field at all.

Thanks for your help!

ScriptRunner does not offer "edit validators"... you might try this: http://www.j-tricks.com/tutorials/one-fixversion-please (I have not personally tried it so can't vouch for whether it works with the latest version).

Suggest an answer

Log in or Sign up to answer
Community showcase
Asked Dec 06, 2018 in Jira Ops

I'm John Allspaw, Ask Me Anything about incident analysis and postmortems

I'm John Allspaw, co-founder of   Adaptive Capacity Labs, where we help teams use their incidents to learn and improve. We bring research-driven methods and approaches to drive effective inciden...

5,537 views 21 17
View question

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you