Var

Content of the remote desktop clipboard. It is typically populated after the server clipboard changes, for example as a result of a copy action (Ctrl+C) performed on the remote desktop. This mechanism is referred to as the "server to client transfer".

Version 3.4 and higher supports bi-directional clipboard update. The script may set the variable using the Var or Eval command to change the server clipboard content. This mechanism is referred to as the "client to server transfer".

The ability to transfer text to/from the clipboard is subject to the connection type and the server vendor.

The VNC connection type supports bi-directional transfer where the server is either UltraVNC or RealVNC. TightVNC doesn't support the client to server transfer, and it requires an additional utility to enable the server to client transfer. Other servers are available.

The Local Desktop connection supports the bi-directional transfer of data. As the local clipboard is being checked using a polling mechanism every 200ms, it is necessary to make the script wait at least 200ms after pressing the Ctrl+C, to make sure the variable gets populated properly. The clipboard content may also change after a call of Type, Typeline or Press which partially rely on the local clipboard to perform the keyboard output.

Other connection types do not support clipboard transfer. For more clipboard related functionality see the Waitfor clipboard command.

Date of the execution starts in the "yyyyMMdd" format. 

For example, May 8, 2005, will be defined as "20050508". The format may be customized in the Language panel of user preferences. To get the current date see the _CURDATE variable below.

Time of the execution starts in the "HHmmss" 24-hrs. format.

For example, 3:10:33 pm will be defined as "151033". The format may be customized in the Language panel of user preferences. To get the current time in milliseconds see the _CURTIME variable below. Should you need a formatted version of current time use _CURDATE with a custom format.

1. The global path in the Language panel of user preferences has the highest priority if it is populated.
2. If the script is part of a project the path defaults to a unique folder created in the project's report directory (since v4.0). Otherwise, it falls back to the user home folder (the default behaviour of v3.x).

1. The global path in the Language panel of user preferences has the highest priority if it is populated.
2. If the script is part of a project the path defaults to the project template directory (since v4.0). Otherwise, it falls back to the user home folder (the default behaviour of v3.x).

Date/time format for the _CURDATE dynamic variable. It must be a string complying with the java.text.SimpleDateFormat specification.

For example, setting the variable to "yyyy" will cause any later use of _CURDATE to produce "2010" (the current year in 4-digit format). The setting of this variable to an empty string will revert the format to the default value.

The factor to multiply all the 'wait' and 'timeout' script times with. This allows to speed up or slow down the script execution. The variable is initialized to the value specified in the Preferences->Execution panel. The default value is 1 which means '100%'.

For example, to slow down the script and make all wait times 50% longer set the value to '1.5'. Supported since 3.2.

The local OS file separator (backslash '\' on Windows, slash '/' on Linux/Unix) and the file path separator (semicolon ';' on Windows, colon ':' on Linux/Unix). 

The separators enable to construct OS independent relative paths and path lists to allow to execute a script from any system.

For example, if the relative Windows path of "..\data" is specified as "..{_FS}data" the script will work correctly also on any Unix/Linux system.

Whenever used the variable retrieves current colour of the desktop image pixel pointed to by coordinates specified by the _RGB_X and _RGB_Y variables. This can be used to test whether a location on the screen contains a particular colour or not. Users are advised to set the _RGB_X and _RGB_Y variables to the target coordinates and then call the _RGB variable to retrieve the colour.

The pixel value is returned in HTML-style format string, 6 characters long, with R, G, B components specified in this order as lower case hexadecimal values (2 characters per component). For example the white color of RGB(255, 255, 255) is presented as "ffffff" while the green color of RGB (0, 255, 0) produces "00ff00".

A typical example testing whether the pixel at [234,128] is green:

Var  _RGB_X=234 _RGB_Y=128
if ("{_RGB}" == "00ff00") {
   // The pixel is green
} This mechanism is suitable for a simple exact colour matching only. For more general testing of a screen area for objects of a particular colour or colour shade, see the Object Search algorithm employed by the Compareto, Screenshot and 'Waifor match' commands.

Step  "Click button1" 
Step  "Click button2" 
Step  "Click button3"  fail 
Var  SUMMARY= "{_STEP_SUMMARY}"

Step "Click button1": PASS
Step "Click button2": PASS
Step "Click button3": FAIL

The variable expands into a semicolon separated list of names of mobile devices attached to the local USB ports on Mac OS X. Supported since 5.0.6.

Whenever called the variable populates additional variables:

_IOS_DEVICE_COUNT=<number>
_IOS_DEVICE_<n>=<n-th_deviceName>

Coordinates (x, y, width and height) of the n-th display. Numbering starts at 1 and is subject to the local OS.

Connections that do not support multiple displays set the X and Y coordinates to zero and the width and height are set to the desktop ones. Supported since 4.3.1.

Display variable which is useful for display redirection on Unix/Linux systems.

It is in the "server:port" format, e.g. "mymachine:2" defines a machine called 'mymachine' running a VNC server on port 5902.

The variable is empty if there is no VNC connection.

Source coordinates of the last compared template. These variables are populated only for templates created with version 2.2 and higher.

See the Image Meta Data chapter for details.

The number of the display the topmost or the n-th match was located on.

Numbering starts with 1 and is subject to the local OS. Supported since 4.3.1. As of this release the only multi-display capable connection is the Local Desktop one. All other connections show the number always as 1 (one).

Image comparison commands such as Compareto, Screenshot , Waifor match/mismatch, Click  and Drag

_TPR_LAST_COMMAND_1=<command>
_TPR_LAST_COMMAND_2=<command>
_TPR_LAST_COMMAND_3=<command>