Versions Compared

Key

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

A workflow post-function that deletes one or more issues

To add 'Delete issue' post-function to a transition : 

  1. Click Edit for the workflow that has the transition you wish to add the post-function on.

  2. In the Workflow Designer, select the transition.

  3. Click on Post Functions in the properties panel.

  4. Click on Add post function.

  5. Select Delete issue from the list of post-functions.

  6. Click on Add to add the post-function to the transition.

  7. Select the “Target issue” (see below)

  8. Click on Add to add the post-function to the transition.

Known issues common to all post-functions:

Filter by label (Content by label)
showLabelsfalse
max5
spacesKB
sorttitle
showSpacefalse
typepage
cqllabel = "common-issue" and type = "page" and space = "JMWEC"
labelskb-troubleshooting-article

Troubleshooting this post-function configuration: In case the post-function does not work as expected these are the things to look out for

Filter by label (Content by label)
showLabelsfalse
max5
spacesKB
sorttitle
showSpacefalse
typepage
cqllabel in ( "placing-postfunctions" , "troubleshooting" ) and type = "page" and space = "JMWEC"
labelskb-troubleshooting-article

Info

JMWE shows an error message on the issue view if any error occurs during the execution of the post-function. This message is only displayed if the current user is a Jira administrator. 

When you add this post-function to a transition and trigger the transition, the add-on deletes the target issues.

Issue(s) to operate on

Select the issues to be deleted. They can be:

  • Current issue: Select this option to delete the current issue. This is the default option.

  • Sub-tasks of the current issue: Select this option to delete the sub-tasks of the current issue

  • Parent issue of the current sub-task: Select this option to delete the parent of the current issue. Note the subtasks of the parent are also deleted.

  • Issues that belong to the current issue (Epic): Select this option to delete the issues that belong to the current Epic

  • Epic of the current issue: Select this option to delete the Epic of the current issue

  • Child issues of the current issue in the Portfolio hierarchy: Select this option to delete the child issues of the current issue in the Portfolio hierarchy

  • Parent issue of the current issue in the Portfolio hierarchy: Select this option to delete the parent issue of the current issue in the Portfolio hierarchy

  • Issues linked to the current issue through any link type: Select this option to delete all issues linked to the current issue

  • Issues linked to the current issue through the following link type: Select this option to delete the linked issues of a specific link type. Select the specific link type under “Issue link”

  • Issues returned by the following Nunjucks template:  Select this option to delete the issues returned by the result of a Nunjucks template. Input a Nunjucks template which is a comma-separated list of valid issue keys. For example:

    • "TEST-1"

    • "TEST-1","TEST-2"

    • {{ issue.fields.parent.key }}

    • {{ issue.fields.subtasks | join(",", "key") }}

  • Issues returned by a JQL search: Select this option to delete the issues returned by a JQL search. Input a JQL search expression. For example:

    • project = TEST returns issues of the project with the key TEST

    • project = {{ issue.fields.project.key }} and assignee = {{currentUser._accountId}} returns issues of a project that belong to the project with key TEST and the assignee is the current user

    • Code Block
      {% if issue.fields.assignee %}
          assignee = {{issue.fields.assignee._accountId}}
      {% else %}
          issuekey=INVALID-1
      {% endif %}

      Note that the {% if %} block is necessary to avoid an invalid JQL query when the issue is unassigned. In that case, the template will return a valid JQL query that returns no issue (issuekey=INVALID-1).

Run As

  • Run as current user: The current user will be the user that deletes the new issue.

  • Run as add-on user: The add-on user will be the user that deletes the new issue.

  • Run as this user: Any user selected in this field will be the user that deletes the new issue.

Conditional execution

To execute this post-function based on the result of a Nunjucks template see Conditional execution.

Delayed execution

Include Page
Delayed execution
Delayed execution

Use case

A typical use of this workflow post-function is to delete an issue. Consider a use where you want to delete an issue and its subtasks once rejected. To configure it:

  1. Add the “Delete issue” post-function to the “Reject” transition of the workflow

  2. Save the post-function

  3. Publish the workflow

Refer here for more use cases.