Run a schedule from the command line

Run a schedule from the command line

Overview

You can run a schedule or test from the command line outside of the Eclipse workspace and automatically export the results.
Verify that a supported Java executable file (java.exe) is in your path. A supported Java executable file is provided with RPT v8.3.
On UNIX operating systems, java.exe is installed by default in...
/opt/IBM/SDP/jdk/bin/

On Windows operating systems, java.exe is installed by default in...
C:\Program Files\IBM\SDP\jdk\bin\

On Linux, an X server must be available, even when run from the command line.

Run a schedule from the command line
Go to the directory containing cmdline.bat and cmdline.sh files.
On Windows...
cd "C:/Program Files/IBM/IBMIMShared/plugins/com.ibm.rational.test.lt.cmdlineexecuteversion_date"
Issue the following command:
cmdline -workspace workspace_full_path  \
        -project proj_rel_path  \
        -eclipsehome eclipse_full_path  \
        -plugins plugin_full_path  \
        -schedule sched_rel_path  \
        -suite suite_rel_path  \
        -servicename service  \
        -serviceargs service_args  \
        -configfile file_full_path  \
        -results result_file  \
        -overwrite {true | false}  \
        -quiet  \
        -users nn  \
        -vmargs JVM_args  \
        -exportlog log_full_path  \
        -exportstats stats_full_path  \
        -exportstatreportlist stats_list 
If a value contains spaces, enclose the value in quotation marks. To see the online help for this command, while you are in the directory containing the .bat file, type cmdline -help.
The following table explains each option:

Option Description
-workspace Required. The complete path to the Eclipse workspace.
-project Required. The path, including the file name, of the project relative to the workspace.
-eclipsehome Required. The complete path to the directory containing eclipse.exe.
-plugins Required. The complete path to the folder containing the plug-ins. Typically, on Windows...
C:/Program Files/IBM/IBMIMShared/plugins

-schedule Path including the file name of the schedule to run relative to the project.
-suite Path including the file name of the test to run relative to the project.
-servicename Name of the service to run. Instead of running a schedule or performance test, the specified service is run when it becomes available.
-serviceargs Optional. The series of arguments to pass to the service specified by the -servicename option. For example...
-serviceargs "-myserviceparm1 myserviceparm1value". The values are in quotation marks because they contain spaces

-configfile Optional. The complete path to a file containing the parameters for a schedule or test run. Each parameter must be on a single line. To create a configuration file, use an editor that does not wrap lines. Any parameters, whether required or optional, can be set in the configuration file. Command line parameters override the values in this file. Do not use quotation marks in this file, even for values containing spaces.
-results Optional. The name of the results file. The default result file is the schedule or test name with a time stamp appended.
-overwrite Optional. Determines whether a results file with the same name is overwritten. The default value, true, means that the results file is overwritten.
-quiet Optional. Turns off any message output from the launcher and returns to the command shell when the run or the attempt is complete.
-users Optional. Overrides the default number of virtual users in the run. For a schedule, the default is the number of users specified in the schedule editor. For a test, the default is one user. This option creates a new copy of the schedule containing the specified number of users.
-vmargs Optional. JVM arguments to pass in. For example,
-vmargs "-debug -Xmx512m"

The values are in quotation marks because they contain spaces.
-exportlog Optional. The complete path to a file in which to store the exported HTTP test log.
-exportstats Optional. The complete path to a directory in which to store exported statistical report data. The statistical report data is stored in CSV format, with the file name derived from the report name. If the -exportstatreportlist option is not specified, the reports specified on the Export Reports page of the Performance Test Report preferences are exported.
-exportstatreportlist Optional. A comma-separated list of absolute paths to custom report format files (.view files) to use when exporting statistical report data with the -exportstats option. This parameter overrides workspace preferences. For example...
-exportstatreportlist c:/customreport.view,c:/customreport2.view
Messages are displayed to indicate when the test or schedule is launched and when it is completed, unless you include the -quiet option.
Issuing the command locks the workspace. To check the progress of the schedule or test during the run, invoke another workspace and open the project through that workspace.

When you return to the command prompt, the run is finished.
Optionally, start Performance Tester to review the results. To automatically export results after a run completes from the command line, click...
Windows | Preferences | Test | Performance Test Reports | Export Reports
Example

The configuration file must contain information in option=value pairs. Although paths containing spaces must be enclosed in quotation marks on the command line, do not enclose spaces in quotation marks in the configuration file.
Sample configuration file...
workspace=D:\My Workspace
eclipsehome=C:\Program Files\IBM\SDP
plugins=C:\Program Files\IBM\IBMIMShared\plugins
project=myProject
schedule=mySchedule.testsuite
What to do next

After you run the schedule, you may want to export the results the results. For more information, see Export report counters automatically.

Related tasks:

Export report counters automatically

Error 404 - Not Found
Error 404 - Not Found
The document you are looking for may have been removed or re-named. Please contact the web site owner for further assistance.

Option	Description
-workspace	Required. The complete path to the Eclipse workspace.
-project	Required. The path, including the file name, of the project relative to the workspace.
-eclipsehome	Required. The complete path to the directory containing eclipse.exe.
-plugins	Required. The complete path to the folder containing the plug-ins. Typically, on Windows... C:/Program Files/IBM/IBMIMShared/plugins
-schedule	Path including the file name of the schedule to run relative to the project.
-suite	Path including the file name of the test to run relative to the project.
-servicename	Name of the service to run. Instead of running a schedule or performance test, the specified service is run when it becomes available.
-serviceargs	Optional. The series of arguments to pass to the service specified by the -servicename option. For example... -serviceargs "-myserviceparm1 myserviceparm1value". The values are in quotation marks because they contain spaces
-configfile	Optional. The complete path to a file containing the parameters for a schedule or test run. Each parameter must be on a single line. To create a configuration file, use an editor that does not wrap lines. Any parameters, whether required or optional, can be set in the configuration file. Command line parameters override the values in this file. Do not use quotation marks in this file, even for values containing spaces.
-results	Optional. The name of the results file. The default result file is the schedule or test name with a time stamp appended.
-overwrite	Optional. Determines whether a results file with the same name is overwritten. The default value, true, means that the results file is overwritten.
-quiet	Optional. Turns off any message output from the launcher and returns to the command shell when the run or the attempt is complete.
-users	Optional. Overrides the default number of virtual users in the run. For a schedule, the default is the number of users specified in the schedule editor. For a test, the default is one user. This option creates a new copy of the schedule containing the specified number of users.
-vmargs	Optional. JVM arguments to pass in. For example, -vmargs "-debug -Xmx512m" The values are in quotation marks because they contain spaces.
-exportlog	Optional. The complete path to a file in which to store the exported HTTP test log.
-exportstats	Optional. The complete path to a directory in which to store exported statistical report data. The statistical report data is stored in CSV format, with the file name derived from the report name. If the -exportstatreportlist option is not specified, the reports specified on the Export Reports page of the Performance Test Report preferences are exported.
-exportstatreportlist	Optional. A comma-separated list of absolute paths to custom report format files (.view files) to use when exporting statistical report data with the -exportstats option. This parameter overrides workspace preferences. For example... -exportstatreportlist c:/customreport.view,c:/customreport2.view