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; } } }

How to make a field required during a workflow transition?

Fred Gruhn

Greetings everyone. I'm still fairly new to my JIRA admin role, so please bear with me. Does anyone have any experience using Behaviours (or anything else) to make a field required based upon a workflow transition? For example, we want the field "Removed Reason" to be required when the state of an issue is changed to "Removed". Ideally, the expected result would be a screen that pops up and prompts the user to populate the newly required field before the transition completes. I've been experimenting w/Behaviours (which is a part of ScriptRunner). I've been able to get a field to change to required, but that happens after the transition occurs. Any thoughts or ideas would be welcome.

Accepted answers

Rachel Wright

Hi Fred, no need to worry about new admin questions. We were all new once and we all had this same question, believe me!

You can do this with a workflow validator. I believe these days this function comes with JIRA and doesn't require installing a specific plugin. (I just checked a Cloud instance with no plugins and it's there.)

Implementation

Open your workflow for editing
Click on one of your transitions
Click on the "Validators" tab
Click the "Add Validator" link on the right (see screenshot)
Add for the validator called "Field Required Validator" and choose the specific field make required

Tips:

Validators are checked and must return true before the transition completes.

Unlike requiring a field on a create screen, no asterisk (*) symbol will display for a field required by a workflow. The end user will receive an error message however, if the field is not completed.

As you mentioned, it's a good idea to add a transition screen (not pictured) to allow the user the oportunity to set or update the required field. Otherwise, if the filed has no value, the user will get a workflow error.

Now, if you want to do something fancy that's where Scriptrunner for JIRA comes in! Here's a link to their documentation on workflow functions: https://scriptrunner.adaptavist.com/latest/jira/custom-workflow-functions.html

Hope this helps!

Rachel Wright

All comments

Rachel Wright

Hi Fred, no need to worry about new admin questions. We were all new once and we all had this same question, believe me!

Implementation

Open your workflow for editing
Click on one of your transitions
Click on the "Validators" tab
Click the "Add Validator" link on the right (see screenshot)
Add for the validator called "Field Required Validator" and choose the specific field make required

Tips:

Validators are checked and must return true before the transition completes.

Unlike requiring a field on a create screen, no asterisk (*) symbol will display for a field required by a workflow. The end user will receive an error message however, if the field is not completed.

Hope this helps!

Rachel Wright

Fred Gruhn

Rachel,

Thanks again for such a quick reply. I tried to apply this on my hosted JIRA instace (7.3.0) and on my Add Validator screen, I don't see a "Field Required Validator" in the list. I only see the following (see screenshot below). Does it make a difference that I'm adding the validator on an "All" transition for a state?

Screen Shot 2017-05-22 at 9.40.58 PM.png

JamieA

I suspect the reason why Rachel found it in the cloud instance is because "Suite Utilities for JIRA" is pre-installed...

You can do this with ScriptRunner easily using a Simple Scripted Validator, but if you don't need any conditional or programmatic logic, you may as well use SUJ which is a free plugin AFAIK.

You mention you have this on the All transition, but it would be simpler to put it on the specific transition you care about, then use Fields Required Validator.

Micha_qsp8sj

Does anyone still have an answer to Fred's last question? I am facing the same problem.

Thorsten Letschert _Decadis AG_

Hi @Micha,

whether you're dealing with an 'All' transition or not does not make a difference here. While a 'Field required' validator is available on Jira Cloud by default, Jira Server relies on 3rd party apps in order to provide such a functionality.

Cheers,
Thorsten

Tommy Lu_znlq1l

It's no longer free as of Jul 13, 2017.
https://community.atlassian.com/t5/Marketplace-Apps-Integrations/Suite-Utilities-for-JIRA-JSU-app-is-now-commercial/td-p/609117

Jonatan Rueda

Is there any way to apply this validation only for a specific Issue Types?

Piotr Janik

Not sure about Adaptivist stuff, but in Jira itself different issue types can use different workflows. You can e.g. couple IssueTypeX with WorkflowX, then make a copy of WorkflowX (hereinafter WorkflowXa), add the validator to WorkflowXa (but not to WorkflowX), then couple IssueTypeY with WorkflowXa. The downside is that you'll need to update both workflows separately even if the validator is the only intended difference...

Code to live blog

I can explain how to make a custom field required during workflow transition. You can refer the detailed steps on my below blog post,

https://codetolive.in/jira/How-to-make-custom-fields-required-in-a-workflow-transition-in-jira-script-runner

Somesh Sahoo

https://youtu.be/W3vhZJkJ52A?si=T43oxxSTgXiqL26p

this is the easiest way to make the field mandatory for a transition without.

Somesh Sahoo

Jira Field MANDATORY While Closing the Issue
https://youtu.be/W3vhZJkJ52A

Welcome!

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

Quick Links

Find more posts tagged with

scriptrunner

behaviours

workflow