1.Latest Release Document Collection
All documents listed below are bundled inside the distributed T-Plan Robot Enterprise binaries and they are available locally from within the product through the Help links and buttons.
|Release notes contain installation, execution and migration instructions, dependencies, platform support, known issues and notes on compatibility with previous versions.|
|The Command Line (CLI) Reference lists command line options supported by the T-Plan Robot Enterprise binary. The same options are also accepted as parameters of programmatically created automated testing threads.|
|The TPR Language Reference is a complete specification of the TPR test script language supported by T-Plan Robot Enterprise version 4.2.1. Its goal is to provide a complete syntax and functionality reference to those who write automated test scripts using this tool and its testing framework. As the scripting language is tightly coupled with the Java Test Script API, it is also intended to provide a complementary functionality reference for design of Java test scripts.|
|The Java API reference comprises of Java development manuals and a JavaDoc collection built from the Java source code comments. It provides information on writing of Java test scripts and customization procedures.|
|The GUI Reference provides help related to components of the T-Plan Robot Enterprise GUI, such as the main menu and tool bar, script editor, tool panel, desktop viewer and standalone windows and dialogs.|
|Integration Reference describes integration with T-Plan test management products, especially with T-Plan Professional.|
1.3.TPR Language Reference
1.4.Java API Reference
This document provides a top-level summary information on how to integrate T-Plan Robot Enterprise with 3rd party solutions.
This chapter lists existing integration guides for particular software products.
T-Plan Professional T-Plan Professional (TPP) is a test management tool produced by T-Plan. It supports export of test cases to Robot test scripts, automation execution and result reporting. For details refer to the online integration guide.
Our online T-Plan Robot Enterprise And Continuous Integration guide provides a instructions on how to integrate with Jenkins. The steps may be reused for Hudson. Java IDE
There are no IDE specific plugins for direct integration with T-Plan Robot Enterprise. Robot’s project structure is however compatible with the one used by most IDEs and the project folder may serve as home of both the Robot and Netbeans/Eclipse projects. This enables development of Java test scripts and any supporting Java code in both environments in parallel.
Detailed instructions on how to set up a Netbeans development environment are maintained in our Developing Java Test Scripts document. The steps may be reused for Eclipse or another IDE.
AdderLink iPEPS AdderLink iPEPS – This document describes how to set up VNC connection between T-Plan Robot Enterprise and the AdderLink iPEPS KVM switch, for EPOS Test Automation. HP ALM / Quality Center Integration Describes the setup, operation and features of integrating T-Plan Robot Enterprise with HP ALM / Quality Center. Please refer to the integration guide.
The following Robot features, plugins and tools are suitable for integration with 3rd party solutions:
- The Robot’s Command Line Interface(CLI) is designed to support easy generic integration:
- To execute a script or schedule use the -r/–run option.
- The System Under Test (SUT) can be specified at the start up through the -c/–connect and -p/–password options. The scripts may otherwise connect on their own using the Connect command.
- Custom values can be passed to the script through the -v/–variable options.
- On production of headless environments (terminal/rsh/telnet connections) use the -n/–nodisplay option to suppress the GUI.
- The overall result of the automation is indicated back through the process exit code (0 is PASS, anything else is FAIL). For more details parse the XML report created by the script through a call of the Report command. It’s path may be set from the CLI through the -v option (
- The TPR language provides a few commands suitable for simple integration:
- The Exec command can execute a local OS command, for example to pass some data to another process through the CLI.
- The File and Excel commands allow to read and write data from and to plain text, CSV or MS Excel files. This can be used for simple communication with another process.
- The SendMail command sends an email from the script.
- The environment (system) variables are seen in the script as the _ENV_ prefixed variables. For example, the Path variable on MS Windows is available as the _ENV_Path variable.
- The Robot’s Java API is ideal for those who wish to integrate with a Java app or framework or to call custom functionality from test scripts:
- Java test scripts can be started from any 3rd party Java app. To call the TPR code from Java create a wrapping Java test script and call the TPR file(s) using the run(java.lang.String) method.
- Java test scripts can call any 3rd party functionality and are ideal to implement connectivity from test scripts to your framework. The classes may declare the parameters to create a user friendly GUI editor. The compiled Java code may be then packaged to a JAR file called test script plugin and plugged back to the TPR language through the Include and Run commands. This system allows you to mix Java and TPR code as you wish. For reference code examples see the free open source Extent Reports and SQL Database plugins on our Plugins web site.
- Several Robot features can be customized at the Java API level through parameters and system properties.
- The Utilities plugin delivers the FileControl script which allows to feed TPR or Java code to a running Robot instance on the fly. Your framework may provide the data and task flow and drive Robot to do the automation.
- The Remote Control client allows to communicate with a running Robot instance over TCP/IP. It supports to perform basic script tasks such as start or stop test scripts, get the current execution status or kill the server. This functionality allows to build a distributed system which controls Robot instances on remote machines.
1.6.1.HP ALM / Quality Center Integration
This guide provides instructions on how to setup both T-Plan Robot and HP Quality Center in order to integrate your automation scripts, allowing you to execute and view the results from the context of HP ALM.
HP Quality Center is a quality management software solution offered by the HP Software Division of Hewlett Packard. HP Quality Center is a component of the HP Application Lifecycle Management (“ALM”) software solution set.
The integration is achieved by utilising the VAPI-XP test type within Quality Center to launch console based applications i.e. T-Plan Robot.
T-Plan Robot is compatible with the CLI and even offers a “CLI Wizard” to help determine the correct required command and save as an executable file such as .bat. It is this that we will use to allow the integration to drive T-Plan Robot.
Setting up T-Plan Robot
Within T-Plan Robot there needs to be two aspects in place to allow the execution and reports to run successfully from and with HP ALM.
1 – ALM specific report output directory
2 – Generate a Script executable
Report Output Directory
Each T-Plan Robot script contains a “Report” command which allows to specify the output report format and location. The default location for script output is within the <projectDir>\reports\<custom> directory, however this doesn’t lend itself to the integration due to its dynamic nature. Instead we recommend to store your output files to a static directory of your choice which ALM will read from.
T-Plan Robot does allow for saving of multiple report files within a single “Report” command using a semi-colon separated list of filenames. We also recommend making use of the zip format output which will allow all associated output files to be uploaded to ALM post execution.
A sample report command might therefore look as follows:
NOTE: Relative paths for the report output are resolvable against the currently set “Output Path” of the Robot Project. Absolute paths are also accepted.
Test Script Executable
Within T-Plan Robot use the CLI Wizard located under the Tools main menu option to generate the script executable (.bat) file.
NOTE: As you can see, the resulting batch file will call the T-Plan Robot application and test scripts using the relevant files, therefore these all need to be accessible form the driving machine.
With the desired settings in place select “Save To File” and save the executable batch file in an accessible (shared) location.
To run the T-Plan Robot executable file (created above) from the context of HP ALM and correctly return the output results we need to configure Quality Center a particular way.
Setting up Quality Center
we have to create a “VAPI_XP” script using the following options…
Within the “Application Executable File” field enter the full path to the Robot script batch file (created using the Robot CLI Wizard earlie) and the click the “+” button. The entry should then be added into the bottom field:
The resulting test script now has the ability to call the T-Plan Robot script executable in order to run the automated script. However in order for it to also correctly pickup the Robot automation results we need to amend the generated VBScript.
The auto-generated VBScript ‘Sub’ code should be replaced with the following:
Sub Test_Main(Debug, CurrentTestSet, CurrentTSTest, CurrentRun)
' *** VBScript Limitation ! ***
' "On Error Resume Next" statement suppresses run-time script errors.
' To handle run-time error in a right way, you need to put "If Err.Number <> 0 Then"
' after each line of code that can cause such a run-time error.
On Error Resume Next
' clear output window
CurrentRun.Status = "Not Completed"
CurrentTSTest.Status = "Not Completed"
CurrentTSTest.Status = "Not Completed"
result=XTools.run ("C:\Users\Administrator\MyAutomation\tpr\CollateNewOrders.bat", "", -1)
TDOutput.Print "Result: " & result
if result = 0 then
CurrentRun.Status = "Passed"
CurrentTSTest.Status = "Passed"
CurrentRun.Status = "Failed"
CurrentTSTest.Status = "Failed"
' TODO: put your code here
If Not Debug Then
' handle run-time errors
If Err.Number <> 0 Then
TDOutput.Print "Run-time error [" & Err.Number & "] : " & Err.Description
' update execution status in "Test" mode
If Not Debug Then
CurrentRun.Status = "Failed"
CurrentTSTest.Status = "Failed"
TDHelper.UploadAttachment OutputReportHTML, CurrentRun
TDHelper.UploadAttachment OutputReportLog, CurrentRun
TDHelper.UploadAttachment OutputReportTPR, CurrentRun
TDHelper.UploadAttachment OutputReportZIP, CurrentRun
NOTE: The file paths for the XTools.run and the OutputReport commands (lines 20-24) should be set according to your Robot Project location
Save your code changes using the mini toolbar:
Now that we have our new test prepared and able to run our T-Plan Robot automation script, we can now place that into a “Test Set” within the “Test Lab” section of ALM allowing us to initiate the execution.
You are now ready to execute your T-Plan Robot automation scripts from HP ALM!
Viewing Test Results
Clicking the attachment icon gives you quick access to the output report for that instance, otherwise you can select the executions “Run ID” to open up the “Run Details” screen. Selecting the Attachments option on the left will then give you access to the T-Plan output report/files:
T-Plan Robot automated test scripts can be executed from the context of HP ALM through the use of the CLI. The results of said executions are then visible also directly from within HP ALM.
The above instructions allow you to setup both T-Plan Robot and HP ALM (QC) in order to achieve this functionality. The above steps are also potentially a starting point from where you can further edit and enhance the integration to suit. Perhaps you want to pass some parameters at run-time, perhaps you want to retrieve other files etc., by following the above principles this should all be possible.
2.Change Log 4.2.x
This document describes new features, changes and bug fixes delivered by T-Plan Robot Enterprise 4.2.x releases.
The latest public release available: T-Plan Robot Enterprise 4.2.2 released on 10 July 2017.
The IMS references in the text refer to our T-Plan Incident Management System (IMS).
PRB-3889: Variables passed to schedule task are not created in the CLI mode
PRB-3888: Low script execution performance in the CLI mode
PRB-3887: Misleading error message on report() failure
PRB-3886: Latest version of IE fails to open local help files
PRB-3885: Escaped Java literals not retrieved correctly by the Properties window
PRB-3884: Excel command uses sheet index instead of ordinary number
PRB-3883: Move files to Recycle Bin instead of deleting them
PRB-3882: OutOfMemoryError on recurring schedule executions
PRB-3881: Editing of an executing script displays intermittent procedure errors
PRB-3880: Remove deprecated Waitfor Update preference
PRB-3879: Mouse drag with Alt pressed leaves the modifier on
PRB-3878: Broken help links in the initial Login window
PRB-3877: Unnecessary exception shown in image comparison
PRB-3876: Editor search performance issues
PRB-3875: Waitfor mismatch doesn’t handle image collections as expected
PRB-3874: The “String matches” command doesn’t support fuzzy match as documented
PRB-3873: Java API: Report null context properly
PRB-3872: Exit command fails for the ‘block’ and ‘procedure’ scopes
PRB-3871: Command parameter values containing numbers in curly braces not handled properly
PRB-3870: Schedule editor issues
PRB-3869: Object Search called from Java with cmparea exceeding the screen size crashes
PRB-3868: Connection Manager fails to save Static Image connection on Windows
PRB-3867: iOS Mirror fails to start and connect to Reflector 2
- Support of the Robot Automation Portal (RAP) (CR-991). It is a web application allowing to monitor and manage T-Plan Robot Enterprise driven automation over the TCP/IP network (internet and/or intranet) from a web browser.
PRB-3866: Connection established through the CLI options not applied to schedule scripts
PRB-3865: CLI variables not passed to schedule scripts
PRB-3864: Crippled file paths of project copied from Windows to Mac/Linux
PRB-3863: Slow Schedule execution and large project loading
PRB-3862: Preferences window too wide
PRB-3861: Splash screen issues
PRB-3860: Local Desktop clipboard text not converted properly (java.nio.ByteBuffer)
- There are two connection improvements addressing automation of mobile devices:
- The Connection Manager stores data of your known connections (IMS CR-981). Connections may have names which can be used to connect without having to specify all the parameters.
- There’s a new method of integration with T-Plan Professional 8.1 based on a REST web service (IMS CR-978).
- Click and Drag command enhancements (IMS CR-982):
- Click supports tasks such as “click 20 points to the right from an object” through the newly introduced move parameter.
- Both commands allow the script to continue if the target click or drag object is not found (the continue parameter).
- A simple integration with the Step command allows to record a test step and populate it with the
failresult (the step parameter).
T-Plan Robot supports two methods of applying the application licenses. The sections below describe each method.
3.1.Files Based Licensing
Using the basic license file approach, you can instruct T-Plan Robot to locate and use a provided license using your standard file system.
If the license file is saved to the T-Plan Robot installation directory, it will be automatically picked up when T-Plan Robot is next launched.
Alternatively the license file itself can be saved to any accessible file directory, either on your local workstation or on a shared network directory. In this case when T-Plan Robot is first launched you will be asked to browse to your designated license file(s) or you can add further licenses from within the tool using the “License Key Manager”, accessed under the application Tools menu.
Multiple license files can be use, from multiple locations at any one time.
Using the T-Plan License Server allows you to centrally manage and control your license usage across your organization.
The T-Plan License Server runs on your internal network and dynamically assigns application access based on a “first come first served”, concurrent policy based on your license restrictions.
The License Server must be installed on a Windows 64bit environment.
Install the license server using the supplied msi. It should be installed on a centrally accessible machine as all Robots will need to communicate with it.During the License Server installation you can define the desired URL and port for which each T-Plan Robot instance will use to communicate with the License Server and ultimately obtain a license.
In order to apply a supplied license within your T-Plan License Server you must first activate it. The T-Plan License Server Configuration utility allows you to browse to your provided license file. If it has not yet been activated you will be presented with the option to do so ‘online’, or manually paste the “Activation Block” as communicated by the T-Plan Support Team.
Once the Activation Block section in populated you should select “Update License” which will attempt to Save the activated license – it is this activated license which is used moving forward.
When back to the initial screen select “Update” to apply the new activated license.
In order for Robot to communicate with the License Server you need to tell Robot to use this method as opposed to the default file based approach.
When Robot is launched for the first time, if no valid license file is found you will be presented with the license warning dialog, from here you can open the License Key Manager window.
Within the License Key Manager window select the “License Server” tab and enter the License Server machine URL i.e. http://TPlanLicenseServer:8080.
Selecting “Refresh” should then populate the top section with details about your license allowance, with the lower pane showing any existing ‘live’ Robot instances.
4.Robot Automation Portal (RAP)
This document describes the features, changes and bug fixes delivered by T-Plan Robot Automation Portal (RAP) releases.
The RAP is a web based management solution that allows the control, scheduling, reporting and execution of the T-Plan Robot army or bots deployed at an organisation. The solution is predominantly deployed by customers performing RPA (Robotic Process Automation) but is also utilised by customers for test automation management.
The T-Plan RAP Portal is available for Docker, or Windows 2012 R2.
The Portal Server and application components are available as Docker containers, and work with the following configurations:
- Docker CE on Windows 10 Pro
- Docker CE on Ubuntu/Debian Linux
The Docker containers can be obtained by contacting T-Plan Support.
Windows 2012 R2
The following prerequisites are required for installing the T-Plan RAP Portal components on Windows 2012 R2:
- NodeJS 6.10 +
- Java Runtime Environment 1.8 or higher
- URL Rewrite module for IIS, 2.0
- MySQL 5.7
The Windows installer for T-Plan RAP Portal will not permit installation until these prerequisites are satisfied.