Setting up a Checklist Workflow Validator

You need administrator rights in Jira to perform the tasks on this page.

You can use the Checklist Workflow Validator to enforce a specific level of checklist completion before a workflow transition occurs. If your custom rules are not met, the attempted transition will fail.

Although conditions can achieve this same effect, the key difference is that a validator will allow you to initiate the transition, but will display an error message like the following:

To learn more about configuring workflows and workflow validators, see the Atlassian Jira documentation.

Checklist validators may cause a bulk transition to fail (in Issues > Search for issues > Tools > Bulk Change), without any warning to the user, if a checklist does not satisfy the specified conditions.

To create a custom validator:

  1. Go to Administration > Issues.

     

  2. In the sidebar, go to Workflows > Workflows.

     

  3. In the Actions column for an existing workflow, click Edit.

     

  4. Select the transition that you want to modify:

    • In Diagram mode, click on the arrow that points to the transition, and then click Validators in the panel that appears on the right.

       

    • In Text mode, click on the transition name in the Transitions (id) column.

       

  5. In the Validators tab, click Add validator.

     

  6. Select Checklist Workflow Validator and click Add.

     

  7. Configure the parameters, which are described in the table below, and click Add.

     

  8. On the Workflows > Workflows page that you are returned to, publish your edited workflow so that
    your changes take effect.

Setting

Description

Setting

Description

Checklist

The checklist(s) to which the validator will be applied; use Shift + Enter or Ctrl + Enter to select multiple. If none are selected, the condition will be applied to all checklists associated with the issue.

Validation type

The type of validation that will be performed on the checklists:

  • All items checked: Validates that all items are checked.

  • All mandatory items checked: Validates that all mandatory items are checked.

  • Number or percentage of items checked: Validates that a specific number or a percentage of the items are checked. Enter either a round number (e.g. 2) or a number with a percent symbol (e.g. 25%).

  • Number of existing items: Validates that the checklist contains a specific number of items.

  • All items must have a status: Validates that all items have a status.

  • All mandatory items must have a status: Validates that all mandatory items have a status.

  • All items must be assigned: Validates that all items have an assignee.

  • All mandatory items must be assigned: Validates that all mandatory items have an assignee.

Validated items

The checklist items that will be validated:

  • All items: Validates all items in the checklist (both local and global).

  • Only global items (options): Validates only the global items in the checklist.

Conditional rules

The issue rules that must all be satisfied before the validator will be applied. If no issue rules are created, the validator will always be applied.

  • JQL Query: The issue must be returned by the specified JQL query. If you enter a specific JQL query instead of using a filter, click Validate to ensure that your syntax is valid and that no errors are returned.

You can use an %issuekey% variable in your JQL query to inject the key of the current issue, which is useful for special JQL functions like the ones used by ScriptRunner. If you do so, you can enter an issue key in the Issue Key placeholder field to inject into the variable for the purpose of validating your query.

To make a filter appear as an option, mark it as a favorite.

  • Issue Label: The issue must have at least one of the specified labels.

  • Issue Type: The issue must be of the specified type(s).

Resolution

The issue resolution(s) for which the validator should be applied. If no resolutions are selected, the validator is applied to all issues, regardless of their resolution type.

  • Done

  • Won’t Do

  • Duplicate

  • Cannot Reproduce

Only use this feature if you have a screen that allows you to set a resolution during the transition. If you do not, the validator will compare the “Unresolved” resolution with the selected resolution. Since they do not match, the validator lets the transition occur, making it appear that the validator is not working.

 


SERVER documentation (On Cloud? Go here.)
Have questions? Contact our Service Desk for help anytime.