Setting up the Validator Templates

Because the validation script needs to live in an existing workflow transition the first two steps to creating a validation script template will be selecting the workflow and transition for where the validation should be place.

Image Added

If you are unsure which workflow to use an easy way to check is through the “view workflow” link that will present on any issue in Jira. Make sure you use an issue for the project and issue type you wish to add the validation to.

Image Added

This “view workflow” link may not always be present due to permission settings. You may need to look in the project settings in order to determine which workflow you should select.

Image Added

Testing the Script

Testing the script is as simple as attempting to complete the transition without a comment present. In the example below, notice that the message text that was in script gets displayed to the user when the transition.

Image Added

Templates

Comment

A comment needs to be entered in the current transition screen in order for the user to complete the transition.

Inputs

Requires transition screen: YES

Script

string errorMsg = "You must enter a comment!";
if(!hasInput("comment")) {
   return false, "comment", errorMsg;
}

Field has value

Required field must have a value in the current transition screen in order for the user to complete the transition.

Inputs

Requires transition screen: YES

Script

string errorMsg = "The field must have a value!";
if(!hasInput("customfield_10626")) {
   return false, "customfield_10626", errorMsg;
}

Issue has subtasks

Current issue must have subtasks in order for the user to complete the transition.

Inputs

Requires transition screen: NO

Script

string errorMsg = "Issue must have subtasks!";
if(size(subtasks(key)) == 0) {
    return false, errorMsg;
}

Linked issues in certain status

All linked issues with the given link type should be in a certain status in order for the user to complete the transition.

Inputs

Requires transition screen: NO

Script

string errorMsg = "Required linked issues are not in the correct status!";
string[] blockingIssues = linkedIssues(key, "Cloners");
for(string issue in blockingIssues) {
    if(%issue%.status != "In Progress") {
       return false, errorMsg;
    }
}

Parent issue in certain status

The parent of the issue should be in a certain status in order for the user to complete the transition.

Inputs

Requires transition screen: NO

Script

string errorMsg = "Parent issue should have status Done!";
if(!isNull(parent) && parent.status != "Done") {
   return false, errorMsg;
}

Subtasks issues in certain status

All the subtasks of the current issue should be in a certain status in order for the user to complete the transition.

Inputs

Requires transition screen: NO

Script

string errorMsg = "Subtasks are not in the In Progress!";
string[] subtasks = subtasks(key);
for(string subtask in subtasks) {
    if(%subtask%.status != "Done") {
       return false, errorMsg;
    }
}