autotransition

Owned by Jonathan Muse
Last updated: Nov 20, 2024
2 min read

Description

Executes a transition and moves to the specified step. It will execute the transition only if the transition is valid for the current status of the issue. If the skipStateCheck parameter is set to true, the function will force the target transition even if the issue is currently inside another transition and has been modified.

Parameters

Return Type

Boolean (true/false)

If the return value is "true", the transition was executed successfully. A "false" return value means that the transition failed. In this case check the log for additional details.

Starting with version 2.5.3, autotransitions are executed after the script has finished. Since we do not know the result of the operation at the time the function is called inside the script, it will return "true" by default.

Examples

Example 1

autotransition(121, "PRJ-123");

Returns "true" if the transition with the ID=121 for the issue PRJ-123 was executed and "false" if the transition wasn't executed.

Example 2

autotransition("Require information", "PRJ-232");

Returns "true" if the transition requiring information for the issue PRJ-232 was executed and "false" if the transition wasn't executed.

  1. To use the function on the Create Issue transition, it is very important that you place the SIL post function after the "Creates the issue originally" post function but before "Fire a Issue Created event that can be processed by the listeners.". Positioning the SIL™ post function otherwise will de-synchronize the issue from the workflow. That will set an invalid status for the workflow step it is in.

  2. If the transition requires a screen it will not be displayed for additional input.

  3. You should do all issue modifications in or before the post function that contains the calling of the auto transition.

  4. All post functions executed by the called transitions should not modify the issue. These post functions could be used for sending notifications.

  5. If there are validations and /or conditions in the transition called after the one that contains the auto transition, and these validations fail, the transition will not be executed.

Frequent Problems

Problem: When executing an autotransition, it fails with the message: It seems that you have tried to perform a workflow operation (<Transition _Name >) that is not valid for the current state of this issue (<Issue _Key >). The likely cause is that somebody has changed the issue recently, please look at the issue history for details.

Solution: Set the skipStateCheck parameter to "true ".

See also