Versions Compared

Old Version 1

changes.mady.by.user Daniel Barrow

Saved on

compared with

New Version Current

changes.mady.by.user Daniel Barrow

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
excerpt
Excerpt
hiddentrue
nameDescription

A workflow post

-

function that clears the value of one or more fields of the current issue or issues related to the current issue.

When you add this post function to a transition and trigger it, the add-on clears the selected field(s) of the target issues.

To add the 'Clear fields' post-function to a transition:

  1. Click Edit for the workflow that has the transition to which you wish to

configure

  1. add the post

-

  1. function

on

  1. .

  2. In the Workflow Designer, select the transition.

  3. Click

on 

  1. Post

Functions in

  1. Functions in the properties panel.

  2. Click

on Add post

  1. Add post function.

  2. Select Clear fields

 from

  1. from the list of post

-functions

  1. function.

  2. Click

on 

  1. Add to

add

  1. navigate to the Clear fields post-function

on the transition.
Image Removed

  • Select the “Target issue” (see below)

  • Choose the field(s) that should be cleared from Field(s).

  • 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

    1. screen where you can add configuration details. See below for more information.

    2. Click on Add to add the post function to the transition. 

    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 it, the add-on clears the selected field(s) of the target issues.

    Issue(s) to operate on

    Select the issues on which the selected fields should be cleared. They can be:

    • Target issues

      • Current issue: Select this option to

    clear the selected fields on

      • set the assignee of the current issue. This is the default option.

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

    clear the selected fields on the

      • set the assignee of sub-tasks of the current issue

      • Parent issue of the current sub-task: Select this option to

    clear the selected fields on

      • set the assignee of the parent of the current issue

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

    clear the selected fields on the

      • set the assignee of issues that

    belong

      • belongs to the current Epic

      • Epic of the current issue: Select this option to

    clear the selected fields on

      • set the assignee of the Epic of the current issue

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

    clear the selected fields on the

      • set the assignee of child issues of the current issue in the Portfolio hierarchy

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

    clear the selected fields on

      • set the assignee of 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

    clear the selected fields on

      • set the assignee of the current issues' linked issues

      • Issues linked to the current issue through the following link type: Select this option to

    clear the selected fields on

      • set the assignee of issues linked to the current issue through a specific link type. Select the specific link type under “Issue link”

      • Issues returned by the following Nunjucks template: Select this option to

    clear the selected fields on

      • set the assignee of 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

    clear the selected fields on

      • set the assignee of the issues returned by a JQL search.

    Input See here for more use cases of this post-function

      •  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).

    Conditional execution

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

    Run As

    • Run as current user: The current user will be the author of the field change

    • Run as add-on user: The add-on user will be the author of the field change

    • Run as this user: Any user selected in this field will be the author of the field change

    Delayed execution

    Include PageDelayed executionDelayed execution

    Use case

    A typical use of this workflow post-function is to clear specific fields during a transition. Consider a use where on reopening a ticket you want to clear the Fix Version/s of the issue. To configure it:

    1. Add the “Clear fields” post-function

    2. Select the “Fix Version/s” field

    3. Save the post-function

    4. Publish the workflow

    • Issue Link - Only available when Target issues, above, is set to Issues linked to the current issue through the following link type. Select the required link type between the current issue and the issue to be updated.

    • Nunjucks template - Only available when Target issues, above, is set to Issues returned by the following Nunjucks template. Enter a Groovy script that returns the ID values for the issue or issues to be updated. See Using Nunjucks Templates for more information on Nunjucks.

    • JQL expression - Only available when Target issues, above, is set to Issues returned by the following JQL search. Enter a JQL expression that returns the ID values for the issue or issues to be updated. See Using Jira Expressions for more information on JQL.

    Fields to clear

    Select the field or fields to be cleared using the Fields pulldown menu; multiple fields can be selected, and all selected fields will be listed in the configuration field. Use the X beside a field name to remove it from the list.

    Advanced options

    Expand this section to see advanced configurations including which user will run the post function, conditional execution, and delayed execution.

    Run As

    Include Page
    [Includes] Post-function - Run As
    [Includes] Post-function - Run As

    Conditional execution

    Include Page
    [Includes] Post-function - Conditional Execution
    [Includes] Post-function - Conditional Execution

    Delayed execution

    Include Page
    [Includes] Delayed Execution
    [Includes] Delayed Execution

    You are viewing the documentation for Jira Cloud.

    On This Page

    Table of Contents
    minLevel1
    maxLevel2
    outlinefalse
    typelist
    printablefalse

    Clear fields post function configuration screenImage Added