Persistent Variables in Issue Context

Owned by Jonathan Muse
Last updated: Oct 16, 2024 by Shane Smith
3 min read

Persistent variables are introduced via the persistent keyword. In order to save space, we do not allow persistent and constant modifiers to be used on the same variable, so you can't have both. A persistent variable is always modifiable.

Using Persistent Variables

Let's install the following post function on an easy executable action, and execute the transition a number of times (a normal Start-Stop progress cycle, in this example, on the same issue).

A post function with persistent variables
persistent number counter = 1; persistent boolean flag = false; description += "\n" + counter + "(" + flag + ")"; flag = !flag; counter ++;

The above example adds some text to the description of an issue, but unlike the version without the persistent keyword, the appended text will be something like:

1(false) 2(true) 3(false) 4(true)

So what's happening here? The truth is that the initialization of the variable happens only once. Subsequent executions will find the persistent variable initialized, will load that particular value, and start from there. The flag will be flipped, and the counter will be incremented with each executed transition on that issue.

The persistent variable is linked to the issue so that If you move to another issue and execute the same post function multiple times, you will get a similar output. The first line of the output will still be 1(false) followed by 2(true) and so on.

Examples

Let's suppose that we have a SIL™ listener and we'd like to use that counter variable. You can simply access it in your listener like in the following example:

A listener code
persistent number counter; persistent boolean flag = true; //initialization is ignored if the previous script was already executed! //............. /// use it in the listener like a normal variable: counter--;

Note that we didn't put any initializer. If the variable is already initialized, the initializer is simply not executed at all, no matter the construct. While such behavior belongs to the logic of the persistent variable, we recommend that you use the same initializer every time so that you won't start with different values.

Recommended

Script 1

Script 2

Script 3

 

NOT Recommended

Script 1

Script 2

Script 3

 

 

In Conclusion:

  1. The persistent variable is linked to the current issue from the context.

  2. Persistent variables are only initialized once. Initialization of a persistent variable will be ignored if that variable was already initialized from a previous execution within a particular context.

  3. A persistent variable is a variable whose value survives the script, making it available in many other scripts under the same name.

Use Case Examples

Approvals

Let's say you want to create an approval process where a manager must approve a ticket before it can be worked on. This can be accomplished by creating a workflow transition, called "Approve",  that leads back to the original step. Only a manager can see this transition button and when they transition the ticket it will be marked as approved. To do this we would need a couple scripts on this Approval transition:

Condition Script:

Post Function Script:

This validator script would go on the "Start Progress" transition, for example.

Validator Script:

 

 

Peacock