Comment Required Validator

Owned by Daniel Barrow
Last updated: Apr 24, 2024
2 min read

A workflow validator that forces users to enter a comment during a transition. If the user does not enter a comment, a custom error message will be displayed.

The comment should be entered on the transition screen (in the Comment section) of the transition.

To add 'Comment Required Validator' to a transition:

  1. Click Edit for the workflow that has the transition you wish to configure the validator on.

  2. In the Workflow Designer, select the transition.

  3. Click on Validators in the properties panel.

  4. Click on Add validator.

  5. Select Comment Required Validator from the list of validators.

  6. Click on Add to add the validator on the transition.

  7. Input a message in the Error Message.

  8. Click on Add to add the validator to the transition.

On the Service Management portal view of a request, the customer will not see the Error message when the validator fails. This is due to a known limitation (JSDCLOUD-5853) with Atlassian.

You are viewing the documentation for Jira Cloud.

Comment Required Validator configuration screen
Figure 1 - Comment Required Validator

 

When you add this validator to a transition and trigger the transition, the add-on checks for a value in the Comment field of the Transition screen. If it is blank, the configured validation error message will be displayed.

Configure the validator

  1. Follow the steps above to add a validator to a transition.

  2. From the list of validators, select Comment Required Validator (JMWE app).

  3. The Build-your-own (scripted) Validator page will open. Configure the validator as needed. See below for details on each of the configurations.

  4. Click Add.

Note that you will need to publish the workflow for the new validator to take effect.

The following configurations are available:

  • Error message - The error message that will display if the validator fails.

  • Validator scope

    • Conditional validation - Check this option if you want validation to occur only in certain cases, such as if the issue is of a certain issue type, has certain field values, or more generally satisfies an arbitrary Jira expression.

    • Condition - Only visible when Conditional validation, above, is checked. Enter a Jira expression; if the expression evaluates to true, the validator will run.

    • Skip validation when cloning an issue - Check this option to skip the validator when an issue is being cloned.