Versions Compared

Key

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

A post-function that will link the current issue to all issues that satisfy a parameterized JQL query.

To add 'Link issues to the current issue' post-function to a transition: 

Click Edit for
  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 
  1. Functions in the properties panel.

  2. Click on Add post function.

  3. Select Link issues to the current issue from the list of post-functions.

  4. Click on Add

 to
  1.  to add the post-function on the transition.

Image Removed
  1. Add a JQL query in the JQL expression.

  2. Select the maximum number of issues in Max. Issues.

  3. Select the link type from the Issue Link Type drop-down.

  • Select the Options provided to add required parameters.
  • borderColorSilvertitle
    1. Click on Add to add the post-function to the transition.

    Warning
    Image Added

    Known limitations

    Common

    common to all post-functions:

    Filter by label (Content by label)
    showLabelsfalse
    max5
    spacesKB
    sorttitle
    showSpacefalse
    sorttitle
    typepage
    cqllabel = "common-issue" and type = "page" and space = "
    KB
    JMWEC"
    labelskb-troubleshooting-article
    Page Properties
    hiddentrue
    Related issues
    Info

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

    When you add this post-function to a transition and trigger

    the transition

    it, the add-on links the current issue to

    all

    the specified number of issues that satisfy the specified parameterized JQL query.

    JQL Expression:

     JQL query (text) that can include Nunjucks annotations (to inject field values from the current issue) to select

    Input a JQL expression that returns the issues to link

    the current issue to. 

    . You can insert issue, transition, currentUser and now variables in your JQL expression and test it using the JQL expression tester provided in this post-function.

    Examples:

    • project =

    TEST, returns the 

    Customise this post-function using the additional options provided as part of the post-function. The options are:

    Options

    • Treat value as JSON

    Sets the field value from a JSON object or array of objects. It will take the Value in the value template and parse it like a JSON string into a JavaScript object. This will be passed back to JIRA as the value of the field. To learn about the JSON value expected by the post-function, see Expected value for each field type.

    • Copy only if not set

    Sets the value of the selected field on all linked issues only if the field is empty on the linked issues.

    • Create missing value(s)

    Allows creating any missing Component/s or Version/s while setting or copying a field that expects Versions or Components. Note this is applicable for version and component fields.

    • Add value(s) to the linked issue

    Appends the specified value(s) to the selected field of all the linked issues. This is applicable only to multi-valued fields.

    • Send notifications

    JIRA sends notifications for the change in the selected field value on the linked issue(s). You can control the default value of the "Send notifications" option in the Configuration page under JMWE administration. Click here for more information.

    Conditional execution

    To execute this post-function based on the result of a Nunjucks template see Conditional execution
    • TEST returns the issues of the project whose key is TEST

    • assignee is EMPTY returns all the unassigned issues.

    • project=TEST order by created desc returns the issues of the project whose key is TEST in descending order by Created time

    Note: If the current issue satisfies the specified JQL query, an error is logged because you cannot link an issue with itself.

    Note that to specify a condition on a user, you need to specify an accountId without the accountId: prefix. For example: assignee = 557058:472c64c9-2567-4213-839b-86bf21558300. You can access the prefix-less accountId of a user through the _accountId property.

    Examples:

    Code Block
    languagejava
    project = {{ issue.fields.project.key }} and assignee = {{currentUser._accountId}}
    Code Block
    languagejava
    {% if issue.fields.assignee %}
        assignee = {{issue.fields.assignee._accountId}}
    {% else %}
        issuekey=INVALID-1
    {% endif %}

    You can find more information about searching for Jira issues using JQL here: Advanced searching and Search Jira like a boss with JQL.

    Max. Issues: Input the maximum number of issues that the JQL expression should return. The value cannot be more than 50.

    Filter: Select this option to filter the issues returned by the JQL search. Input a Nunjucks template in the “Filter Expression” that returns true if the issue returned by the JQL search should be linked to the current issue. The filter script is evaluated for each issue returned by the JQL search, in turn, and that issue is available through the targetIssue variable. This is especially useful when you want to filter linked issues that cannot be filtered using the JQL. For example, filtering issues refining a text search with an exact match that cannot be done with JQL. For example to check for issues with summary ~ "MacBook Pro" the JQL returns all issues with “MacBook” and “Pro” in the summary (say, “MacBook for Pro users”). In such a case, you should be using the “Filter Expression” to filter issues that have “MacBook Pro” in the summary with a Nunjucks template as follows:

    Code Block
    {{ issue.fields.summary.includes("MacBook Pro") }}

    Link type

    Issue Link Type: Select the link type to be created between the current issue and the issues returned from the JQL expression.

    Run As

    • Run as current user

    • : The current user will be the

    author
    • creator of

    the field change
    • the issue links.

    • Run as add-on user

    • : The add-on

    user will
    • user will be the

    author
    • creator of

    the field change
    • the issue links.

     
    • Run as this user

    • : Any user selected in this

    field will
    • field will be

    the author of the field change
    • the creator of the issue links.

    note

    Conditional execution

    Running

    To execute this post-function

    as any user other than the "Add-on user" is discouraged

    If you select any option other than "Run as add-on user", so that the change appears to be done by the current user or a specific user, the following must be true:

    • The destination field must be present on the Edit screen applicable to the issue being modified
    • The selected user must have the Edit issues permission on the issue being modified

    Delayed execution

    To delay the execution of this post-function see Delayed execution.

    Info

    Note that you can use this function to set the value of a field:

  • The parent issue of a sub-task by using the built-in is Subtask of link type and vice versa using the is Parent of link type
  • The Epic of an issue by using the built-in belongs to Epic link type and vice-versa using the is Epic of link type

    based on the result of a Nunjucks template see Conditional executionThe condition is evaluated only after the JQL query runs and not before. It will be evaluated against each issue returned by the JQL query allowing you to further filter the issues to link to the current issue. The issues returned by the JQL query will be available in your Nunjucks template  through the linkedIssue variable. 

    Delayed execution

    Include Page
    Delayed execution
    Delayed execution

    Use case

    A typical use case for this post-function is to link issues to the current issue during a transition. Consider a use case where you want to link the stories created under an Epic as siblings. To configure this:

    1. Add the “Link issues to current issue” post-function to the Create issue post-function

    2. Input the following JQL expression:

      Code Block
      {% if issue.fields["Epic Link"] %}
          "Epic Link" = "{{issue.fields["Epic Link"]}}"
      {% else %}
          issuekey=INVALID-1
      {% endif %}

    3. Input “Max issues” as 10

    4. Select the link type as “is sibling of”

    5. Save the post-function

    6. Publish the workflow

    See here for more use cases