Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 64 Next »

A workflow post-function that sets the value(s) of a selected field of the current issue. The value can be provided either as text (with optional Nunjucks annotations) or as a JSON value.


To add 'Set field 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 field value from the list of post-functions.
  6. Click on Add to add the post-function on the transition.
  7. Select the field from the Field drop-down.
  8. 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.
  9. Click on Add to add the post-function to the transition.
  10. 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 selected field of the current issue 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. Multiple values can be separated by commas. 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.

Options

  • Treat value as JSON

Sets the field value from 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 field. To learn about the JSON value expected by the post-function, see Expected value for each field type.

  • Set only if field is empty

Sets the value of the selected field only if the field is empty.

  • Create missing value(s)

Allows creating any missing Component/s or Version/s while setting or copying a field that expects Versions or Components. Note this is applicable for version and component fields.

  • Ignore empty value

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

  • Add value(s) to the field

Appends the specified value(s) to the selected field of the current issue. This is applicable only to multi-valued fields.

  • Send notifications

Jira sends notifications for the change in the selected field value on the current issue. You can control the default value of the "Send notifications" option in the Configuration page under JMWE administration. Click here for more information.

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 field change.

  • Run as add-on user

The add-on user will be the author of the field change. 

  • Run as this user

Any user selected in this field will be the author of the field change.

Running this post-function as any user other than the "Add-on user" is discouraged

If you select any option other than "Run as add-on user", so that the change appears to be done by the current user or a specific user, the following must be true:

  • The destination field must be present on the Edit screen applicable to the issue being modified
  • The selected user must have the Edit issues permission on the issue being modified

Delayed execution

To delay the execution of this post-function see Delayed execution.

  • No labels