Workflow Validator to require a field on a transition screen

There is an allegedly more complete field validator in the JIRA Suite Utilities. Apparently it handles both custom and system fields

The attached workflow validator plug-in can be associated with a transition screen to make specific fields mandatory. This version has been updated to work with Jira 3.5 and can be used on any transition to make any custom fields required. (Of course, the fields must be on the workflow transition screen.) I have not tested this with all possible custom field types, but it does work with the most common types.

The plugin also works with bulk edits, but has a peculiar behaviour - if one or more of the required fields is not set, the workflow transition fails, but there is no error message or other indication that the workflow failed. (The validator is not called until after you confirm the bulk transition.)

To use, drop the attached jar into WEB-INF/lib and restart Jira. When you edit a workflow, select Add a new validator, and you should see o Field Validator as an option. When you add the validator, you will see a list of all custom fields. You can select any number of fields to associate with the validator.

Here is a snippet of the updated validator. I've removed logging and some error checking for simplicity.

package com.atlassian.jira.plugin.workflow.field.validator;

import ...

public class FieldValidator  implements Validator
{

    MutableIssue issue=null;
    Map mods;
    CustomFieldManager cfm = ManagerFactory.getCustomFieldManager();
    InvalidInputException invIn = null;

public static ValidatorDescriptor makeDescriptor() {
        return makeDescriptor(null);
    }   public static ValidatorDescriptor makeDescriptor(String param)
    {
        ValidatorDescriptor fieldValidator = new ValidatorDescriptor();
        fieldValidator.setType("class");
        fieldValidator.getArgs().put("class.name", FieldValidator.class.getName());
        return fieldValidator;
    }

public void validate(Map transientVars, Map args, PropertySet ps) throws InvalidInputException
    {
        BasicWorkflowContext context = null;
        if (transientVars!=null) {
            context = (BasicWorkflowContext) transientVars.get("context");
        }
        String username = null;
        if (context!=null) username = context.getCaller();;

        User user = null;

        try
        {
            if (username != null)
            {
                user = UserManager.getInstance().getUser(username);
            }
        }
        catch (EntityNotFoundException e)
        {
            throw new InvalidInputException("Invalid user (" + username + ")");
        }
         issue = (MutableIssue) transientVars.get("issue");           checkFields(args, transientVars, user);
    }
    protected void checkFields(Map args, Map transientVars, User user) throws InvalidInputException
       {
        mods = issue.getModifiedFields();

        String selectedFieldsString = (String)args.get("selectedFields");
        if (selectedFieldsString!=null)  {
             StringTokenizer st = new StringTokenizer(selectedFieldsString, ";");

            while(st.hasMoreTokens())
            {
                String singleSelectedField = st.nextToken();
                checkForVal(singleSelectedField);
            }
        }
        if (invIn!=null) throw invIn;
    }
    protected void checkForVal(String cfName) {
        CustomField cf = cfm.getCustomFieldObjectByName(cfName);
        if (cf==null) {
            setError(null,"Trying to use the field validator with a non-existant custom field: ["+cfName+ "] ");
           return;
        }

        ModifiedValue mv = (ModifiedValue) mods.get(cf.getId());
        String newValue ;

        if (mv==null)   {
            setError(null,cfName+" is not on the transition screen associated with this use of this validator.");
        }
        else  {
            newValue = (String) mv.getNewValue();
            if (!TextUtils.stringSet(newValue) ) {
                // -- value not set for cfName --
                setError(cf, null);
            }
        }
    }
    protected void setError(CustomField cf, String errmsg) {
       if (cf==null) {
           if (invIn==null) invIn = new InvalidInputException(errmsg);
           else invIn.addError(errmsg);
       }
       else {
           if (invIn==null) invIn = new InvalidInputException(cf.getId(),cf.getName()+ " is required.");
           else invIn.addError(cf.getId(),cf.getName()+ " is required.");
       }
   }
}

Workflow Validator to require a field on a transition screen

Labels

Comments (36)

E Joseph Guay says:

Philip Herbst says:

Anonymous says:

Nick Menere says:

Rémy Mouton says:

Rémy Mouton says:

Anton Mazkovoi says:

Frank Polscheit says:

Jeff Turner says:

Jeff Huff says:

Neil Arrowsmith says:

E Joseph Guay says:

Neil Arrowsmith says:

E Joseph Guay says:

E Joseph Guay says:

Neil Arrowsmith says:

Neil Arrowsmith says:

Bettina Zucker says:

Neil Arrowsmith says:

Bettina Zucker says:

E Joseph Guay says:

Christi Austin says:

Chris Mountford says:

Christi Austin says:

san pil says:

E Joseph Guay says:

Remon van Gijn says:

jpp says:

Neal Applebaum says:

E Joseph Guay says:

Neal Applebaum says:

Alex Holtz says:

Alex Holtz says:

Yudong Song says:

Adam Attinello says:

Add Labels
Enter labels to add to this page: Looking for a label? Just start typing.