GUI macro variables

Some parts of the graphical user interface (GUI) allow you to specify command lines, such as in the Tools menu or in User Command nodes.

To enhance the usability of this feature, the product includes a macro language, allowing you to pass system and application variables to the command line.


Macro variables are preceded by $$ (for example: $$WSPNAME).

Macro functions are preceded by @@ (for example: @@PROMPT).

Environment variables are also accessible, and start with $ (for example: $DISPLAY).

When specifying a command line, variables and functions are replaced with their value.

In Windows, when long filenames are involved, it is necessary to add double quotes (" ") around filename variables. For example:

"C:\Program Files\Internet Explorer\IEXPLORE.EXE" "$$NODEPATH"

Node variables are context-sensitive: the variable returned relates to the node selected in the File or Test Browser. Multiple selections are supported. If a node variable is invoked when there is no selection, no value is returned by the variables.

Macro variables and functions are case-insensitive. For clarity, they are represented in this document in upper case characters.

Language Reference

  • Global variables: not node-related, include Workspace and application parameters.

  • Node attribute variables: general attributes of a node.

  • Functions: return a value to the command line after an action has been performed.