| Excerpt |
|---|
A workflow post-function that creates a comment on all issues linked to the current issue through a selected link type. The The text of the comment comment can be either a fixed text or text, optionally including a Groovy template markup, or the result of the evaluation of a Groovy expression or the result of a Groovy templateexpression. |
| Note |
|---|
This post-function does not work with remote links (links to Jira issues residing on another Jira instance/server). |
To add the 'Comment linked issues' post-function to a transition :
- Click Edit for the workflow that has the transition you wish to configure the post-function on.
- In the Workflow Designer, select the transition.
- Click on
Post Functionsin the properties panel. - Click on
Addpost function. - Select
Comment linked issuesfrom the list of post-functions. - Click on
Addto add the post-function on the transition..png?version=1&modificationDate=1533924382483&cacheVersion=1&api=v2&width=600)
- Select the link from the
Issue Linkdrop-down. - Select comment type from the
Comment typedrop-down. - Input a value in the Comment text field based on the comment type selected in step 8.
- Select the options provided to add the required parameters.
- Click on
Addto add the post-function to the transition.
| Panel |
|---|
Related links : For information on where the post-function needs to be placed on a transition, see Placing post-functions on a transition. Refer to the Use cases for post-functions page for use cases for this post-function. |
When you add this post-function to a transition and trigger it, the add-on picks the value from the Comment text field and adds it as a comment on all the issues linked to the current issue through a selected link type. The value can be either a:
- Raw Value, when you select
Raw Valueas the Comment type. - Result of a Groovy expression, when you select Groovy expression as the Comment type. See
- Groovy editor in JMWE to write your Groovy script
- Expected Groovy expression input for each field
- issue, linkedIssue, currentUser and log variables you can use in your Groovy script
- Accessing the fields of an issue to use them in your Groovy script
- Groovy tester to test your written your Groovy script
- Result of a Groovy template, when you select
Groovy templateas the Comment type. See - Groovy editor in JMWE to write your Groovy templates
- Expected Groovy expression input for each field to write your Groovy templates
- issue, currentUser, textutils and log variables you can use in your Groovy templates
- Accessing the fields of an issue to use them in your Groovy templates Groovy tester to test your written your Groovy templates
Groovy Expression: A Groovy expression whose return value (of type String) will be used as the comment body. For example,
issue.get("description")will add the description of the issue to the issue as a comment.
Text or Groovy template: A fixed text that can include a Groovy template markup that can be used as the comment body. For example, The issue will be resolved on or before <%= issue.duedate%> by <%issue.assignee%>.
Options
Send "Issue Commented" notification
You can notify the users when a comment is added on the issue by selecting the option Send "Issue Commented" notification.
Run as
Run as user
Any user specified in this field will be the author of the comments that are created by the post-function. Leave it blank for the current user to be the author.
Comment visibility
Restrict to Group
Restricts the visibility of the comment to a specified group. When you input a valid group name in the Restrict to Group field, the comment will be visible only to the members of the specified group. For no restriction, leave the field blank.
Restrict to Project Role
Restricts the visibility of the comment to a selected project role. When you select a project role from the Restrict to Project Role drop-down, the comment will be visible only to the members of the selected project role. For no restriction, leave the field blank.
Restrict to Internal (Jira Service Desk only) - REQUIRES option "Send 'Issue Commented' notification"
Restricts the visibility of the comment to the Service Desk Agents and Collaborators only. This requires the option Send "Issue Commented" notification to be selected.
Conditional execution
To execute this post-function based on the result of a groovy expression see Conditional execution using Groovy expression.
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.