Set Variable Action

Declaration

<AMSET VARIABLENAME="text">text</AMSET>

 

See Also

Set Variable Action-Setting Properties Create Variable

Description

Changes the contents of an already existing variable.

Practical Usage

Variables are used as storage mechanism to store data while a task is running. For more information see Variables. Once a variable is created, its contents can be displayed at runtime by placing the variable name in percent signs (e.g. %myvarname% will automatically be converted it it's contents at runtime).

Parameters

General Tab

Variable Name

Text, Required
MARKUP: VARIABLENAME="thecurrentdate"

Specifies the name of the variable to change.

Value

Text, Required
MARKUP: VALUE="The current date is %Now()%"

Specifies the value that the variable should be changed to. As with all parameters, this value may be literal or an expression (if surrounded by percent % signs).

Notes

Using Variables

All variables must be created before they can be used. This is done using the Create Variable <AMVARIABLE> action. Once created, variables can be set using the Set Variable <AMSET> action, or by certain actions that support populating variables. To get data out of the variables, in any action parameter, simply surround the variable name with percentage % signs (e.g. %varname%). Remember not to use percentage signs when specifying the name of a variable to populate, percentage signs are only needed to get data out.

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMSET NAME="myvar">Set the variable to this value</AMSET>