How to validate a custom field with Script Runner


I am aware that it is possible to validate a custom field during a transition by means of a custom validator.

However, I could not find any way to validate the value of a custom field every time that its value is changed.

Is writing my own plugin the only solution?


3 answers

0 votes

You can use Behaviours to do client side validation on edit if you need.  (I mention client side because it can be completely bypassed by REST or server stuff)

As far as I am aware, behaviours can only be used in a Transition Screens. Am I correct?

No, it can be used on edit and create too.

0 votes
Steven Behnke Community Champion Oct 02, 2016

As Nic implies this is happening because you are allowing users to directly edit field values. There's no out-of-the-box way to validate input other than simply 'requiring' the field via a Field Configuration.

Traditionally, JIRA is configured with workflow transitions and screens – This allows you to map input through a series of steps and actions, controlling data with a series of conditions, validators, and post-functions. Lately, the common configuration is simple workflow with full Edit permissions. With this configuration, you have little option to control data input.

Script Runner Behaviors, as Nic also suggests, allows you to perform client-side validation on transition screens. This is one possible solution.

Apart from the info in the two other good answers, my answer would be Yes.

Implement com.atlassian.jira.issue.customfields.CustomFieldType#validateFromParams, but it's not as useful as it could be, as you just get the raw string values.

I think what you are referring to is often known as "edit validators" - it exists in a few plugins. Implementations tend to rely on monkey-patching IssueService, which we are avoiding.

Steven Behnke Community Champion Oct 03, 2016

Sorry to bug you, do you happen to know how the Resolution field is validated? I was under the impression the 'field requirement' is built into the field template – Implying there's no server-side validation.

Have a good day!

com.atlassian.jira.issue.fields.ResolutionSystemField#validateParams - system fields a bit different. 

Steven Behnke Community Champion Oct 03, 2016


Suggest an answer

Log in or Sign up to answer
Community showcase
Published Feb 07, 2019 in Marketplace Apps

A Timeless Love Story

It started as any story starts, on a normal, rainy day.   Admin meets App, and her name was Klok2, and like any first relationship we were both trying to make it work but neither one knew what...

476 views 8 27
Read article

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