Versions Compared

Old Version 72

changes.mady.by.user David Fischer

Saved on

compared with

New Version 73

changes.mady.by.user Radhika Vijji.

Saved on

Key

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


Note

Documentation for

Status
colourYellow
titleJMWE 5.0.0 - 6.1.3
is available here.


Excerpt

A workflow post-function that sets the value(s) of a selected field of all

issues linked

issue's related to the current issue

through a selected link type

. The value can be either a constant, optionally including a Groovy template markup, or the result of the evaluation of a Groovy expression.


Note
  • This post-function does not work with remote links (links to Jira issues residing on another Jira instance/server).

  • JMWE now considers "symmetrical" link types (such as "relates to") as one link direction instead of two on the configuration screens and in the post-function execution.

To add the 'Set field value of

linked

related issues' post-function to a transition:

  1. Click Edit
 for
  1.  for the workflow that has the transition you wish to configure 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 Set field value of
linked
  1. related issues from the list of post-functions.
  2. Click on Add to add the post-function on the transition.

Image Removed
  2. Select the field from the Field drop-down.
  3. Select the
link type from the Issue Link drop
  1. issues to operate on from the Which issues(s) drop-down.
  2. Select the value type in the Value type drop-down.
  3. Input a value in the Value field based on the value type selected in step 9.
  4. Click on Add to add the post-function to the transition.


Panel

Related links :

For information on where the
needs to be placed on a transition, see 
.Refer to the Use cases for post-functions page for use cases for this post-function

Image Added


Which issue(s)

Select the issues to operate on. They can be:

  • Linked issues: Select issue(s) linked to the current issue through any link type or a specific link type such as blocks, is cloned by, etc.

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

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

  • Issues that belong to the current Epic: Select this option to operate on the issues that belong to the current Epic

  • Epic of the current issue: Select this option to operate on the Epic of the current issue

  • Child issues of the current issue in the Portfolio hierarchy: Select this option to operate on 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 operate on the parent issue of the current issue in the Portfolio hierarchy

  • Issues returned by a Groovy script:  Input a Groovy script that returns either a single Issue object, or a Collection of Issue objects, or a String representing the key of an issue, or a Collection of Strings each representing an issue key. For example:

    • "TEST-1"

    • ["TEST-1","TEST-2"]

    • ComponentAccessor.issueManager.getIssueObject("TEST-1")

    • [ComponentAccessor.issueManager.getIssueObject("TEST-1"),ComponentAccessor.issueManager.getIssueObject("TEST-2")]

    • issue.parentObject

    • issue.getLinkedIssues()

  • Issues returned by a JQL search:  Input a JQL search expression, including an optional Groovy Template markup. For example:

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

    • project = ${issue.get("project").key} and assignee = ${currentUser.name} returns issues of the project the current issue belongs to and assigned to the current user.

    • To operate on issues of a project with key TEST and issue type name same as the value in a text field

      Code Block
      <% if (issue.get("Single line text")) { %>
    project = TEST and issuetype = ${issue.get("Single line text")}
<% } else { %>
    issuekey=INVALID-1
<% } %>


Note

  • Note that the <% if %> block is necessary to avoid an invalid JQL query when the Single-line text field is empty. In that case, the template will return a valid JQL query that returns no issue (issuekey=INVALID-1). This is in general applicable to JQL operating on select type fields with pre-determined values like Affects Version/s, Checkboxes etc.

  • The maximum number of issues returned by a valid JQL is limited to 1000.

When you add this post-function to a transition and trigger it, the add-on sets the specified value(s) on the selected field of all issues linked related to the current issue through a selected link type. The value can be either a:

  • Constant or Groovy Template: You can set the field to a constant value optionally using Groovy Template markup to insert dynamic content. For example: To set the Description of the issue, you can specify This bug has been raised by <%=issue.get("reporter").getName()%> with <%=issue.get("priority").getName()%> priority. Act accordingly. in the value box.
  • Groovy expression: You can set the field to the result of a Groovy expression. For example, to set the Assignee to the Reporter of the issue, you can specify issue.get("reporter") in the value box.
Beware of the default "relates to" link type, which can cause confusion. The problem stems from the fact that "relates to" is both the inward direction and the outward direction of the "Relates" link type. We recommend that you rename one of the directions to "is related to" to avoid confusion. This can be done on the Issue Linking Jira admin page

See the Expected Value tab of the Groovy help editor or refer to the documentation to know more about the expected value in the above cases.

Info
title"Relates to" link type

.

Options

  • Set only if empty

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

  • Ignore empty values

Will not set (clear) the selected field of linked related issue(s), if Value is empty or null.

  • Add source value(s) to destination field

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

  • Create missing value(s)

Allows automatically creating any missing value(s) while setting a field value of linked related issue(s). This is applicable only to Affects Version/s, Fix Version/s, Single version and Multi-version picker type custom fields, Components, Radio buttons, Checkboxes, Single select and Multi-select list type custom fields.

Run as

  • Run as user

Any user specified in this field will be the author of the copy performed by the post-function. Leave it blank for the current user to be the author.

Conditional execution

To execute this post-function based on the result of a groovy expression Input a Groovy expression that returns true if the post-function should run. For more information see Conditional execution /validation using a Groovy expression. Note that the condition will be evaluated once per applicable related issue, with each related issue being available, in turn, in the relatedIssue and deprecated linkedIssue variables.

Error Handling

By default, all errors (Java Exceptions) raised by this post-function, including those raised by custom Groovy scripts, will be logged in the JIRA log file but will not be reported to the user and will not prevent the transition from completing. 

However, when designing new workflows or troubleshooting them, it is more convenient to be notified immediately of any such error during the execution of the transition. On development and staging Jira instances, you can activate error reporting for all JMWE post-functions on the JMWE configuration page, and it is recommended to do so. But on production Jira instances, you might want to show errors only for the post-function(s) being worked on, in order to avoid disrupting other workflows. To make errors raised by the current post-function prevent the transition from completing and show the error in the browser, select Make transition fail when an error occurs in this post-function.