4.4 System Variables

XPOZ defines a set of system variables. These have special meaning and can be used to enhance a test's interpretation and usability.

Table 4-1 XPOZ System Variables

Variable

Type

Description

Title1

string

Text to be printed in the GUI upper dialog first field. Default: NULL.

Title2

string

Text to be printed in the GUI lower dialog first field. Default: NULL.

ScriptFile

string

Filename of the currently executing script.

ScriptDir

string

File system directory from which to initiate a script. Default: “.”

LogFile

string

Name of the current log file.

LogDir

string

File system directory in which to place LogFile.

RetryDelay

int

Number of seconds to wait before retrying a failed function call. Ignored if RetryMax is <=0. Default: 0

RetryMax

int

Number of times to retry a failed function call before failing the test. Default: 0

RetryMaxFlag

int

0: (default) Does not prompt the user on failed function calls, 1: Prompt user on failed function calls.

LogToFileFlag

boolean

False: Do not log to the output file. True: Log to output file. Default: True.

LogToScreenFlag

boolean

False: Do not log to the screen. True: Log to screen. Default: True.

TestCase

string

Marker to delineate the beginning of a new test case. The value is used as the name of the test case. Default: NULL.

TestCaseEnd

string

Marker to delineate the end of a test case. Default: NULL. The start of a new TestCase automatically implies the end of the previous TestCase.

TestDefID

string

Name of the test definition associated with this script.

TestName

string

Name of the test. Placed in the upper status bar. Default: NULL. When the results are turned on, this tag starts the script execution.

NotYetImplemented

int

Specifies that the next test case defined is not fully implemented. This prevents an incomplete test from counting as either a pass or fail within a script.

LogOnRetryFlag

boolean

False: Do not log retries to the display True: Log retries to the display. In the GUI, the retry counts are recorded in the lower status area. This flag attempts to clean up the display output area of the GUI. Default: False.

ReleaseName

string

Data is printed in upper dialog second field. Default: NULL.

rcmdSingleThreaded

int

Causes all calls made to RCMD to run on same thread. Default: 0