Our new Appfire Documentation Space is now live!

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

Set entity property value

Owned by David Fischer
Last updated: Sept 04, 2020 by Radhika Vijji. (Unlicensed)
3 min read

 

A workflow post-function that sets the value of an entity property of the current issue, current issue's project or current user. The value can be provided either as text (with optional Nunjucks annotations) or as a JSON value.

To add 'Set entity property value' post-function to a transition : 

  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 in the properties panel.

  4. Click on Add post function.

  5. Select Set 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 to set in the Property name field

  9. Input a value in the Value field.
    To input issue or transition or current user information in the Value field see, How to insert information using Nunjucks annotations.

  10. Click on Add to add the post-function to the transition.

  11. After adding, move the post-function to the appropriate position according to Placing post-functions in a transition document.

Known limitations common to all post-functions:

Related links

For information on where the post-function needs to be placed on a transition, see Placing post-functions in a transition.

Refer to the Use cases for the post-functions page for use cases for this post-function.

Refer the Troubleshooting and Support page if the post-functions does not seem to be working as you would expect.



When you add this post-function to a transition and trigger the transition, the add-on sets the specified entity property of the current issue, current issue's project or current user to the specified value. The value can be provided either as text (with optional Nunjucks annotations) or as a JSON value.

  • In the case of text, it can be a simple string (for text typed fields), the string representation of a number, date or boolean value, or the string representation of a complex value, such as a Version name, a username, a Project key, etc. You can also use Nunjucks annotations to insert issue, transition and current user information into the value, using the 'issue', 'transition' and 'currentUser' variables, respectively. 

  • In the case of a JSON value, which requires the option Treat value as JSON (explained below), it can be a String, a Number, a Boolean or an Object. It can also be an array of such values.

To find out more about the type of value expected by this post-function for different field types, see Expected value for each field type.

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. 

Options

  • Treat value as JSON: Sets the property value to a JSON object or an 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 property. To learn about the JSON value expected by the post-function, see Expected value for each field type.

  • Set only if property is empty: Sets the value of the selected property only if the property is empty.

  • Ignore empty value: 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 Nunjucks template see Conditional execution.

Run As

  • Run as current user: The current user will be the author of the property change, and if the target entity is "Current user or Run as user", the property will be set on the current user.

  • Run as add-on user: The add-on user will be the author of the property change, and if the target entity is "Current user or Run as user", the property will be set on the add-on user. 

  • Run as this user: Any user selected in this field will be the author of the property change, and if the target entity is "Current user or Run as user", the property will be set on that user.

Delayed execution