Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section has use cases which help you in understand the usage of Validators provided by JMWE.

...

This validator can be used to block the user from progressing to a destination status unless a field has been modified.

Sample use cases:

  • (lightbulb) Validate the change in Resolution provided when closing an issue

    Expand
    titleSteps


    Panel
    • Add the Field has been modified validator to the Close transition.
    • Select Resolution from Field.



...

This validator can be used to ensure that a field has a value during a transition.

Sample use cases:

  • (lightbulb) Validate the Affects Version/s and Assignee fields for a non-empty value on creating a Bug.

    Expand
    titleSteps


    Panel
    • Add the Field is required validator to the Create transition.
    • Select Affects Version/s and Assignee from Fields.



...

This validator can be used to force the users to enter a comment while transitioning to a destination status.

Sample use cases:

  • (lightbulb) Validate that a comment is entered when rejecting a Bug fix.

    Expand
    titleSteps


    Panel

    Add the Comment required validator to the Resolve transition of the Bug workflow.



...

This validator can be used to check that a multi-valued field does not have more than one value during a transition.

Sample use cases:

  • Lightbulb on (on) Validate the Fix Version/s  for a single value on an issue when the issue is fixed.

    Expand
    titleSteps


    Panel
    • Add the Field has single value validator to the Close transition.
    • Select Fix Version/s from Field.



...

This validator can be used to stop the user from transitioning to a status unless the issue has previously been in a specified status in the workflow.

Sample use cases:

  • (lightbulb) Block the transition of an issue to Close status if it has not been Approved.

    Expand
    titleSteps


    Panel
    • Add the Previous status validator to the Close transition.
    • Select Approved from Previous Status



...

This validator can be used to stop the user from transitioning to a status unless the issue's parent has been in a selected status in the workflow.

Sample use cases:

  • (lightbulb) Block the trigger of "Start Progress" on subtasks until its parent is approved.

    Expand
    titleSteps


    Panel
    • Add the Parent status validator to the Start Progress transition.
    • Select Approved from Parent Status



...

This validator can be used to perform a validation with a groovy expression. Based on the result of the expression, the user is either allowed or blocked to transition to the destination status.

Sample use cases:

  • (lightbulb) Block the creation of a Bug if no Attachment is provided.

    Expand
    titleSteps


    Panel
    • Add the Scripted (Groovy) validator to the Create transition.
    • Write the following in the Groovy script

      Code Block
      languagegroovy
      linenumberstrue
      try {
        return issue.get("issuetype").name != "Bug" && issue.getModifiedFields()?.get("attachment")?.getNewValue()?.size() > 0
      } catch (Exception e) {
        return false
      }




  • (lightbulb) Validate the Cascade select for values in parent and child select dropdowns

    Expand
    titleSteps


    Panel
    • Add the Scripted (Groovy) validator to the transition.
    • Write the following in the Groovy script

      Code Block
      languagegroovy
      linenumberstrue
       issue.get("Cascade")?.get(null) != null && issue.get("Cascade")?.get("1") != null




  • (lightbulb) Block the approving of the Change request if it has no confluence page linked

    Expand
    titleSteps
    • Add the Scripted (Groovy) validator to the Approve transition.
    • Write this content in the Groovy script.

      Code Block
      issue.getRemoteLinks("confluence").size() > 0


    • Type the error message in Error message, to display if the validation script returns false


  • (lightbulb) Block the approval of an issue if there is no PDF attached either from before or added during the transition

    Expand
    titleSteps
    • Add the Scripted (Groovy) validator to the Approve transition.
    • Write this content in the Groovy script.

      Code Block
      import com.atlassian.jira.issue.IssueFieldConstants
      import com.atlassian.jira.issue.attachment.Attachment
      import com.atlassian.jira.issue.attachment.TemporaryWebAttachment
      import com.atlassian.jira.issue.attachment.TemporaryWebAttachmentManager
      
      if (issue.get("attachment").any{it.filename.endsWith(".pdf")}) 
        return true;
      
      TemporaryWebAttachmentManager attachmentManager = getComponent(TemporaryWebAttachmentManager)
      try {
          List<Long> ids = issue.getModifiedFields().get(IssueFieldConstants.ATTACHMENT).getNewValue();
          if (ids)
              return ids.any { id ->
                  def attachment = attachmentManager.getTemporaryWebAttachment(id).getOrNull()
                  return attachment?.filename?.endsWith(".pdf")
              }
      } catch (Exception e) {
      }
      return false


    • Type the error message in Error message, to display if the validation script returns false


...

This validator can be used to ensure that the current issue's linked issues are in one of the selected statuses. 

Sample use cases:

  • (lightbulb) Block the transition of the Epic to Closed status, if its stories aren't closed.

    Expand
    titleSteps


    Panel
    • Add the Linked issues status validator to the Close transition.
    • Select the issue link type is Epic of from the Issue Link Type field.
    • Select the statuses the linked issues must be in, from Statuses

    • Add the error message, "The Stories of the Epic are not yet resolved"



...

This validator can be used to ensure that a link to one (or more) issue(s) from the current issue is being created during the transition. 

Sample use cases:

  • (lightbulb) Block the creation of a Bug, if it is not linked to the corresponding functionality requirement.

    Expand
    titleSteps


    Panel
    • Add the Linked issue validator to the Create transition.
    • Select the issue link type relates to from the Issue Link Type field.

    • Add the error message, "Associate/Link the Bug to the respective requirement ticket"



...