T-Plan Home
T-Plan Robot Enterprise 2.1 Doc Collection
GUI Reference

T-Plan Robot Enterprise 2.1 Tool Panel

1. Tool Panel Overview
2. Settings Tab
3. Events Tab
4. Keys Tab
5. Variables Tab

1. Tool Panel Overview

Tool Panel is situated in the top left corner of the T-Plan Robot Enterprise window. It provides various controls which usually work accross the scripting editor, test script interpret and desktop viewer functionality. It consists of four tabs:
  1. Settings tab configures I/O settings of the script in the active editor, especially the output and template paths and the report file.
  2. Events tab displays a summary of recent events received from the desktop server. The content depends on the desktop protocol capabilities and some clients may not populate it at all.
  3. Keys tab deals with key transfer to the desktop and allows to construct and send various key combinations including those which are otherwise captured by the local operating system.
  4. Variables tab provides table of variables available for the script in the active editor.
The Tool Panel is by default always visible. To hide it select the  Display Tool Panel check box in the Tools menu. This flag is valid for the time the application is running. To set the panel invisible on application startup open the Preferences window and select the Tool Panel tree node.

2. Settings Tab

This tab works closely with the script in the active editor. The controls it contains correspond to commands in the test script and any change will be also reflected in the script content. Its components include:

Tool Panel - Settings Tab An example displayed on the left will insert the following code into the active editor:

Var _REPORT_DIR="/tmp/report"
Var _TEMPLATE_DIR="/tmp/templates"
Report "index.html" desc="Example report"

Similarily when you update any of the commands listed above manually in the editor, the fields of the Settings tab will change as soon as the script gets compiled. Be aware that if the on-the-fly compilation is switched off, the fields remain out of sync with the script until you either compile the script manually or execute it.

3. Events Tab

Events tab displays the most recent list of events received from the desktop server. The event list gets reset by user actions, e.g. mouse click, press of Enter etc. The point is to provide just the list of events (updates) generated by the server in response on a user action. This allows to create an instance WaitFor command which waits for a particular event, for example for an update of the desktop image.

Be aware that content of the event list depends on the particular client capabilities and some clients may fail to populate it. The most used RFB (VNC) server delivers two types of events:
As an example we executed a command "ls -l /usr/java/jdk1.6.0_13 && echo -e '\007'" in a terminal window on Linux. It lists content of the given directory and emits a beep (prints out the ASCII 0x07 BELL character) if the listing is successful. The first event in the list represents update of the console window caused by the directory listing. When you select this event in the table, the updated area will display as a red frame in the remote desktop as is visible on the picture. The second event is the bell character printed by the echo command. Though WaitFor command may be generated for any of these two events, waiting for the bell is in this case more reliable because you are sure that the directory listing executed correctly.

Tool Panel - Events Tab

There's a small tool bar below the event table. It contains 3 buttons:

4. Keys Tab

Keys tab is aimed to help you to send such keys to the remote desktop which are reserved by your system. A typical example is Ctrl+Alt+Del, which is interpreted both by Windows and Linux systems as a system command. If you want to send this key to the remote desktop without conflicting with your system, you may use the tools provided by this panel. There are two options:

Tool Panel - Keys Tab If recording is selected and you generate a key using this tool, a Press command will be inserted into the active editor. If the recording feature is off, you will be asked whether you want to insert the command besides sending it to the desktop or not.

5. Variables Tab

This tab contains a table of variables which are currently present in the execution context. If no script execution is in progress, the window displays list of variables from the last script compilation.

There are generally two types of variables:
  1.  Predefined variables, sometimes also called implicit ones. Their name typically starts with underscore '_'. These are created by the underlying automation framework automatically for each script compilation or execution.
  2. Custom variables defined in the script through the Var and Eval commands. These variables are not available for Java test scripts.
Variables TabThe picture on the left displays an example of the variable table after compilation of a simple script with a variable called MY_VARIABLE. There are four buttons below the table allowing to copy the selected variable name or value as follows.
Variables may have a fixed value through the -v/--variable CLI option. Such variables have the '(fixed)' suffix appended to their name. For example, the image on the left displays a fixed variable called MY_FIXED_VARIABLE because the tool was started with the -v "MY_FIXED_VARIABLE=fixed" CLI option. Fixed variables can't be changed in the script and their value remains constant for the whole time of T-Plan Robot Enterprise execution. If you make an attempt to modify such variable using the Var or Eval command, it will be ignored and no error message or warning will be reported. This mechanism was designed to allow to design parametrized test scripts.