Triggering with Variables

Owned by Stonebranch
Feb 06, 2023
3 min read

Overview

Universal Controller provides two methods for manually launching all of the tasks associated with a trigger while supplying values for variables used by the task(s):

  • Use the Trigger Now... pop-up method if you do not want the values that you enter for variables to persist. The values will apply only for the time the task(s) is running.
  • Use the Variables tab method if you want to preserve the information (name and value) about the variables you are setting.

Both methods are available for all trigger types. You can use either method to manually launch task(s) when you cannot use the Launch Task button (in the task Details) because you want to override one or more variables.

The values that you enter when using either method override the all other values, set elsewhere, for those variables.

Variables set with the Trigger Now... pop-up method override any variables specified with the Variables tab method, but only for that run of the task(s).

The audit message created when you use either method is the same.

Using the Trigger Now... Pop-up Method

Step 1

From the Automation Center navigation pane, select Triggers > <trigger type>. The Triggers list for that trigger type displays.

Step 2

Right-click the trigger whose tasks you want to launch to display an Action menu.

Step 3

Click Trigger Now.... The Trigger Now... pop-up dialog displays.
 

Step 4

The Trigger Time Zone field displays, by default, the time zone of the trigger, but you can change it to any time zone in the drop-down list for this particular execution of the trigger to run in.

Step 5

If you want to put the task instances in held status when the tasks specified in the trigger are started, select Hold on Start. A Hold Reason field then displays which allows you to enter information about why the task instances will be put on hold when the tasks start.

Step 6

Select Override Trigger Variables to display a Variable window in the Trigger Now... pop-up dialog. Any variables already attached to the trigger (via the Variables tab method) display in alphabetic order (a-z).
 

 

Note

Additionally, you also can select Override Trigger Date/Time if you want to launch the tasks specified in the trigger by a specific date and time (see Triggering by Date and Time).

Step 7

To add a variable to the list, click the + icon and enter a Name and Value for the variable.
 
To remove a variable from the list, click it and then click the - icon.

Step 8

Click Submit to launch the tasks named in the trigger. The variable information in the list is used where referenced in the tasks. After launching the tasks, the Controller deletes the contents of the list.

Using the Variables Tab Method

Step 1

From the Automation Center navigation pane, select Triggers > <trigger type>. The Triggers list for that trigger type displays.

Step 2

Open the trigger whose tasks you want to launch. The Trigger Details for that trigger displays.

Step 3

Click the Variables tab. The Trigger Variables list displays.
 

Step 4

To add a variable:

  1. Click the  button. A Variables Details pop-up displays.
     

     
  2. Enter a Name, Value, and Description for the variable, and then click Save.

Step 5

To update a variable:

  1. Click the icon next to a variable Name on the Trigger Variables list to displays the Variables Details pop-up .
  2. Change the Name, Values, and/or Description of the variable, and then click Update.

Step 6

Click the <trigger type> Trigger tab.

Step 7

Click the Trigger Now button to launch the tasks named in the trigger.