T-Plan Robot Enterprise Doc Collection |
13 November 2014 |
telnet
.T-Plan Robot Enterprise
The T-Plan Robot Enterprise instance must be version 3.5 or
higher (RC v1.0) or 4.0.1 and higher (RC v2.0). To start the Remote
Control Server start Robot with the --
remotecontrol
option. The port number may be optionally specified after the
option, for example --remotecontrol 5556
. If the
port is omitted the server starts on the default port of 5899.
Make sure that the target port is not occupied or blocked by the
firewall.
Since Robot 4.0.1 the server may be started in the CLI mode
through a combination of --remotecontrol
and -n/--nodisplay
.
It avoids starting the GUI which minimizes the resource
requirements and provides the best performance. This mode is
recommended for deployment scenarios.
Remote Control Tool
Download the tool from:
http://www.t-plan.ltd.uk/releases/robot/plugins/remotecontrol_v2.zip
The tool requires Java SE 1.6 (JRE or JDK). The steps below presume that the Java executable is on the system path. This can be verified through the steps described in the Java Requirements chapter of the Robot's Release Notes. If Java is not on the system path replace the
java
call with a full path to the java.exe
(Windows) or java
(Unix/Linux) binary, for example "C:\Program
Files\Java\jdk1.6.0_<version>\bin\java.exe"
.or start one of the provided scripts (requires Java on the system path):java -jar remotecontrol.jar [OPTIONS] [COMMAND]
OPTIONS:
MS Windows:
remotecontrol.bat
[OPTIONS] [COMMAND]
Unix/Linux:
./remotecontrol.sh
[OPTIONS] [COMMAND]
The COMMAND is optional. It may be a single command to be executed, for example
-h, --host [hostname]
the host name to connect to (optional, defaults to localhost) -p, --port [port]
the port number to connect to (optional, defaults to 5899) --help
displays help on the usage and options
"pause"
. When no command is specified the
tool starts an interactive prompt similar to telnet
.
Supported commands:The term of "executing test script" refers to one script started through the Java API, through the -r/--run CLI option, manually by clicking the Execute button in the GUI or through the
bye
close the connection and exit the session start
[FILE]
[OPTIONS]
start the specified test script or schedule and do not wait for it to finish. Supported since RC v2 and Robot 4.0.1
execute
[FILE]
[OPTIONS]
same as start but wait for the script/schedule to finish. Supported since RC v2 and Robot 4.0.1. If the session gets killed
externally it won't stop the remote script/schedule execution. To stop it open a new session and call thestop
command.
pause [NAME]
pause the specified or currently executed script or schedule
resume [NAME]
resume the specified or currently paused test script or schedule
stop [NAME]
stop the specified or currently executed script or schedule
list
list the currently executing test scripts and/or schedules
kill-server
shut down the server. Supported since RC v2 and Robot 4.0.1. If the server runs in the CLI mode (Robot was started with
the-n/--nodisplay
option) the command will kill the whole Robot process.
help
display help on commands
start/execute
RC commands.
Subscripts started using the Run command do not apply, they are not
being listed and they can not be controlled separately from the
calling script.-v/--var
, -c/--connect
and -p/--password
.C:\MyAutomation\tpr\Script1.tpr
Script1.tpr
.
If there are more executing test scripts of the same file name
the command will be applied to the one that started as the first
one. Connect to T-Plan Robot Enterprise running on address red.fox.com:5222, pause the currently executing script and close the session:java -jar remotecontrol.jar
Connect using telnet to the locally running T-Plan Robot Enterprise on the default port of 5899:java -jar remotecontrol.jar -h red.fox.com -p 5222 pause
Connect using telnet to T-Plan Robot Enterprise running on address red.fox.com:5222:telnet localhost 5899
telnet red.fox.com 5222
The following improvements may be delivered in the future
versions. Contact our support to raise the priority.