Our new Appfire Documentation Space is now live!

Take a look here! If you have any questions please email support@appfire.com

Set issue, user or project Entity Property value

Owned by David Fischer
Last updated: Aug 08, 2018

A workflow post-function that sets the value of a user, issue or project Entity property. The value can be either a constant, optionally including a Groovy template markup, or the result of the evaluation of a Groovy expression.

To add the 'Set issue, user or project Entity Property value' 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 Post Functions in the properties panel.
  4. Click on Add post function.
  5. Select Set issue, user or project Entity Property value from the list of post-functions.
  6. Click on Add to add the post-function on the transition.
  7. Select the entity from the Entity drop-down.
  8. Input the name of the property in the Property name field.
  9. Select the value type from the Value type drop-down.
  10. Input a value in the Value field based on the Value type selected in step 9. Look at the Expected Value tab of the Groovy help editor to know the expected value for the selected Entity and Value type.
  11. Click on Add to add the post-function to the transition.

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 sets the Entity property of the selected entity to the specified value. The value can be either a:

  • Raw Value, when you select Constant or Groovy Template as the Value type. The value should be a valid JSON string, and you can use Groovy Template markup to insert dynamic content.
  • Result of a Groovy expression, when you select Groovy expression as the Value type. The value should be a Groovy expression that returns a valid JSON string. 

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.

Options

  • Set only if property is empty

Sets the property value only if the property is currently empty.

  • Ignore empty values

Will not set (clear) the selected property, if the value is empty or null.

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

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.