Get Environment Variable

Declaration

<AMGETENVIRONMENT NAME="Text" TYPE="Text" RESULTVARIABLE="Text" />

See Also

Get Environment Variable Action-Setting Properties

Description

Retrieves the value of a system or user-level environment variable and places it into an AutoMate variable.

Practical Usage

Used to populate an AutoMate variable with the current value of a specified environment variable so that the data can then be used in subsequent task steps.

Parameters

General Tab

Environment Variable Name

Text, Required
MARKUP: NAME="TEMP"

Specifies the name of the environment variable to retrieve.

Environment Variable Scope

Text, Optional - Default "User"
MARKUP: TYPE="USER"

Specifies the scope of the environment variable.

Options are:
 

Populate Variable With Value

Text, Required
MARKUP: RESULTVARIABLE="VariableName"

Specifies the AutoMate variable to populate with the value from the environment variable.

Notes

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.

<AMGETENVIRONMENT NAME="Path" TYPE="PROCESS" RESULTVARIABLE="VariableName1" />