Versions Compared

Key

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

A post function that runs an Action (a sequence of one or more JMWE post-functions), created in the Shared Actions page, on the current issue or issues related to the current issue.

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. 

To add the 'Shared Action' 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 Shared Action post-function from the list of post-functions.

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

  7. Select the target issue. See Issue(s) to operate on, below.

  8. Select one of the listed Shared Actions. See Shared Actions for more information

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

You are viewing the documentation for Jira Cloud.

On this page

Table of Contents
minLevel1
maxLevel2
outlinefalse
styledefault
typelist
printabletrue
Image Removed

Issue(s) to operate on

Select the issues on which the Shared action should run. They can be:

  • Target issues

    • Current issue - Run the Shared action on the current issue. This is the default option.

    • Sub-tasks of the current issue - Run the Shared action on each sub-task of the current issue.

    • Parent issue of the current sub-task - Run the Shared action on the parent of the current issue.

    • Issues that belong to the current issue (Epic) - Run the shared action on each issue that belongs to the current Epic.

    • Epic of the current issue - Run the Shared action on the Epic of the current issue.

    • Child issues of the current issue in the Portfolio hierarchy - Run the Shared action on each child issue of the current issue in the Portfolio hierarchy.

    • Parent issue of the current issue in the Portfolio hierarchy - Run the Shared action on the parent issue of the current issue in the Portfolio hierarchy.

    • Issues linked to the current issue through any link type - Run the Shared action on all issues linked to the current issue.

    • Issues linked to the current issue through the following link type - Run the Shared action on the linked issues of a specific link type. Select the specific link type under “Issue link”.

    • Issues returned by the following Nunjucks template - Run the Shared action on 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 - Run the Shared action on 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 %}
Info

Note

that the Include Page[Includes] Delayed Execution[Includes] Delayed Execution

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

  • Description - Give this instance of the Shared action a description.

Shared Action

Select the Shared Action to execute. See Shared Actions for more information on creating these types of actions.

Advanced Options

Error handling

  • Stop the action if a post-function encounters an error - By default, even if one of the post functions fails with an error, the remaining post functions in the action will still run. Select this option to stop the execution of subsequent post functions after an error occurs.

Conditional execution

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

Delayed execution

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

Passing variables within a sequence

Using the {% setContextVar %} Nunjucks tag, you can pass data from one post-function to all subsequent post-functions.

context: Holds all the context variables added in the current post-function. For example, if you create a context variable myVar in the first post-function of the sequence:

Code Block
languagegroovy
{% setContextVar myVar = "a value" %}

This variable will then be available in subsequent post-functions as:

Code Block
languagegroovy
{{ context.myVar }}
Note

Note that the context variable will not function correctly when used in the Nunjucks Template tester

Variables specific to the Create Issue(s) post-function

newIssueKey: Stores the issue key of the last issue created by a Create Issue(s) post-function in the sequence. You can access it as:

Code Block
languagegroovy
{{ context.newIssueKey }} 

newIssueKeys: Stores an array of the keys of all the issues created by any Create Issue(s) post-function in the sequence. You can access the created issues from

Code Block
languagegroovy
{{ context.newIssueKeys }}

For example: to add a comment on the current issue with the keys of the issue created

Code Block
languagegroovy
Issues created are:
{{ context.newIssueKeys | join(",") }}

You can access the information of a specific issue using the issue filter. For example: To get the assignee of the issue created by the Create issue post-function:

Code Block
languagejs
{{ context.newIssueKey | issue("assignee") | field("fields.assignee.displayName") }}

For example, consider a use case where you want to clone an issue and its subtasks to another project, then:

  1. Navigate to the Jira Settings → Apps → Shared actions

  2. Click on "Shared actions"

  3. Click on "New shared action"

  4. Add a name "Clone ticket and its subtasks" and an optional description

  5. Click on "Add post-function"

  6. Select the "Create issue" post-function.

    1. Select the destination project in "Project"

    2. Select the "Link to new issue" as "clones"

    3. Configure the fields

    4. Click on Save

  7. Click on "Add post-function"

  8. Select "Create issue" post-function to clone the sub-tasks

    1. Select the destination project in "Project"

    2. Select the "Issue type" as "Subtask"

    3. Under the "Parent issue" input the following template:

      Code Block
      languagejs
      {{ context.newIssueKey }}
    4. Select "Multiple issue creation" option and input the following template:

      Code Block
      languagejs
      {{ issue | subtasks | length }}
    5. Save the post-function.

  9. Click on "Save"

  10. Go to the workflow editor, pick the transition and add the "Shared action" post-function

  11. Select "Clone ticket and its subtasks"

  12. Click on "Add"

  13. Publish the workflow

Error handling

If one of the post-functions fails with an error, the remaining post-functions in the sequence are run anyway. To stop the execution of subsequent post-functions after an error occurs, select the option “Skip subsequent post-functions if a post-function encounters an error”.

Conditional execution

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

Delayed execution

You are viewing the documentation for Jira Cloud.

On this page

Table of Contents
minLevel1
maxLevel2
outlinefalse
styledefault
typelist
printabletrue

Shared Action post function configuration screenImage Added