Versions Compared

Old Version 96

changes.mady.by.user Radhika Vijji.

Saved on

compared with

New Version Current

changes.mady.by.user Richard Stone[Appfire]

Saved on

Key

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

Are you using JMWE for Cloud and want to learn how to use this post-function? Head to our documentation here.

Excerpt

A workflow post-function that creates a comment on the current issue. The text of the comment can comment can be either a text, optionally including a a Groovy template markup, or the result of the evaluation of a Groovy expression.

To add the 'Comment issue' post-function to a transition:

  1. Click Edit 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 

    Click Post

    Functions 

    Functions in the properties panel.

  4. Click on 

    Click Add post function.

  5. Select Comment

    issue from

    issue (JMWE app) from the list of post-functions.

  6. Click on Add to add the post-function on the transition.
    Image Removed
  7. Select the comment type from the Comment Type drop-down.
  8. Input a value in the Comment text field based on the comment type selected in step 7.
  9. Select the options provided to add the required parameters.
  10. Click on 

    You are navigated to the Comment Issue Post-function screen.

  11. Add the configuration details as specified in the Configuration details section.

  12. Click Add to add the post-function to the transition.

Note

Note that you need to publish the workflow

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.


Configuration details

Image Added

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

add-on

app picks the value from the Comment

text field

text field and adds it as a comment on the issue.

 The value can be either a

 

  • Comment type: Select one of the following:

    • Text

or Groovy

    • or Groovy template:

 A

    •  A fixed text that can include

a 

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

    • Groovy Expression: A Groovy expression

 whose

    •  whose return value (of type String) will be used as the comment body. For example, issue.get("description")

 will

    •  will add the description of the issue to the issue as a comment.
      See

the 

    • the Expected Value

 tab

    •  tab of

the 

    • the Groovy help editor

 or

    •  or refer to

the 

    • the documentation to know more about the expected value in the above cases.

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 text: Enter text including optional Groovy expression that is used as the body of the comment.

Comment visibility

  • Restrict to Group

Restricts

  • : Select a group to restrict 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

  • : Select a project role to restrict the visibility of the comment to a selected project role.

When you select a project role from the drop-down Restrict to Project Role field, 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

  • : Select this option to restrict 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/validation using a Groovy expression.

Error Handling

Options

Send "Issue Commented" notification: Select this option to notify the users when a comment is added to the issue.

Run as

Run as user: Select one of the following options to set the author of the comments added using this post-function as:

  • Current user: The user transitioning the issue.

  • Specific user: The user specified in the select-list provided. Start typing into the field to select a user from the list of auto-suggestions.

  • User in field: The user specified in a user picker field of the issue being transitioned. Select one of the user fields from the list of available options in the field provided.

  • User from script: The user returned by the Groovy script specified in Script. This script should return either the Username of the user or an ApplicationUser object.

    Examples:

    • "jdoe" - Username

    • issue.get("assignee") - the current issue's Assignee

Conditional execution

Only if the condition is true: Select this option to enter a Groovy expression. If this returns true, the post-function is run. For more information see Conditional execution using Groovy expression.

Error Handling

Make transition fail when an error occurs in this post-function: Select this option to make errors raised by the current post-function prevent the transition from completing and show the error in the browser.

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

 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.

For example

For example on the

production Jira instances you

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.

If you want to show all the errors, either only to the admins or to all users, configure the option

globally on

globally on the JMWE configuration page. For example,

 on development and staging Jira

 on development and staging Jira instances, you can activate error reporting for all

 JMWE

 JMWE post-functions, to display all the errors and it is recommended to do so, and on production Jira instances you might want to activate error reporting only to administrators so that they can be made aware of configuration errors.

Note

When the option is selected on a post-function, it overrides the

configuration on

configuration on the JMWE configuration page.