To launch the runner from the ReadyAPI user interface, select the appropriate menu command.
Note
To use the command line runner, you need an active ReadyAPI Test license. If you do not have a license, sign up for a free trial.
Select any node in Functional Tests and select Project > Launch TestRunner from the main menu.
Right-click the test case you need and select Launch TestRunner.
After you selected a menu command, ReadyAPI displays a dialog box, where you can configure the run parameters. You can then use that command string to run the utility from the command line.
The configuration dialog organizes the utility parameters in the following tabs:
![]() |
Parameter | Description |
---|---|
Test Suite | Specifies the test suite to run. means the runner will execute all test suites in your project.This parameter is identical to the |
Test Case | Specifies the test case to run. means the runner will execute all test cases in the test suite, or, if you have not specified the suite, all test cases in your project.This parameter is identical to the |
Enable UI | Use this option to enable UI components. Use it if your test uses the This parameter is identical to the |
TestRunner Path | Specifies the fully-qualified name of the runner file ( |
Save Project | Commands ReadyAPI to save the project before the test run. Use it to ensure all recent changes to the project will be available during the run. |
Add Settings | Commands the runner to use workspace settings from the |
Project Password | Specifies the encryption password, if you have encrypted the entire project or some of its custom properties. See Protecting Sensitive Data . This parameter is identical to the |
user-settings.xml Password | Specifies the password for the XML settings file. This parameter is identical to the |
Ignore Errors | Commands the runner to ignore errors occurred during the test run. If you select this check box, the runner will not stop the test if an error occurs. However, in this case the runner will not log information on errors. If you keep this check box clear, the runner will stop when an error occurs and will log information about that error. This parameter identical to the |
Save After | Commands the runner to save the project after the test run finishes. This may be useful if your test stores data to the project. This parameter is identical to the |
Run in-process | Enable this option to run the test runner in the same process as ReadyAPI. Otherwise, the runner will work in a separate process. |
![]() |
Parameter | Description |
---|---|
Environment | Specifies the environment configuration for the test run. This value overrides the environment configuration you have selected for your project in the ReadyAPI toolbar. This parameter is identical to the NoteIf the test runner is unable to find the specified environment, the test run will fail. |
Endpoint | Specifies the endpoint to use for requests during the test run. This value overrides endpoints you have specified in request properties in your project. This parameter is identical to the |
Host:Port | Specifies the host and port to use in requests during the test run. Usage format: This parameter is identical to the |
Username | Specifies a username for authorization tasks during the test run. This value overrides usernames you have specified in authorization properties of test requests. This parameter is identical to the |
Password | Specifies a password for authorization tasks during the test run. This value overrides the password you have specified in authorization properties of test requests. This parameter is an analogue of the |
Domain | Specifies a domain for authorization tasks during the test run. This value overrides the domains you have specified in authorization properties of test requests. This parameter is identical to the |
WSS Password Type | Specifies the WS-Security password type. You can select This parameter is identical to the |
![]() |
Properties | Description |
---|---|
Print Report | Commands the runner to include summary data into the reports ReadyAPI creates. This parameter is identical to the Default value: enabled. |
Export JUnit Results | Commands the runner to create a JUnit-style report. This parameter is identical to the Default value: enabled. |
Export JUnit Results with test properties | Commands the runner to include JUnit XML reports with test properties to the report. This parameter is identical to the |
Export All | If this check box is clear, the report will contain information only about errors. If you select this check box, the report will include messages of other types too. This parameter is identical to the Default value: enabled. |
Root Folder | The fully qualified name of the directory that will store test reports ReadyAPI exports. If the directory does not exist, ReadyAPI will create it. NoteThe default value is TipIf the directory exists, reports’ files in it will be overwritten. This parameter is identical to the |
Coverage Report | Commands the runner to create test coverage reports (in HTML format). This parameter is identical to the |
Open Report | Commands the runner to open the reports ReadyAPI has created in your default browser after the test run finishes. This parameter is identical to the |
Select Report Type | Specifies the type of the report ReadyAPI creates. You can use the following values:
This parameter is identical to the |
Report Format(s) | Specifies the format of the report ReadyAPI creates. Possible values: PDF, XLS, HTML, RTF, CSV, TXT, XML (default). If you keep this edit box empty, ReadyAPI will use the PDF format. Do not specify periods in format names. To specify multiple formats, separate them with commas. For example: This parameter is identical to the |
Slack Access Token | Specifies the authentication token of your Slack bot user. TipTo get the token, open the Slack settings, switch to the OAuth & Permissions tab, and copy the Bot User OAuth Access Token. This parameter is used in the To learn more, see Slack Integration. |
Slack Channel(s) | Specifies a comma-separated list of Slack channels in the This parameter is used in the To learn more, see Slack Integration. |
For more information about reports and customization, see Reporting.
![]() |
On the Properties tab, you can specify variable values that will take effect during the test run.
To specify variable values, use strings of the following format: <variable-name>=<value>
.
Separate multiple name=value pairs with spaces or put each pair into a new line. If a variable name or value includes spaces, enclose the entire pair in quotes. For example:
file=C:\Work\File.txt
image_to_upload="C:\My Application\image.png"
Properties | Description |
---|---|
Global Properties | Specifies global property values for the test run. The values you specify will override properties on the Global Properties page of the ReadyAPI preferences. This parameter is identical to the |
System Properties | Specifies system property values for the test run. The values you specify will override properties’ values in the Help > System Properties dialog. This parameter is identical to the |
Project Properties | Specifies the project property values for the test run. The values you specify will override project-level properties. This parameter is identical to the |

Properties | Description |
---|---|
Test Suite Tags | List of tags you have assigned to test suites within the project. When you check one or more tags, the test runner will include in the test run only the test suites containing all these tags. This parameter is identical to the |
Test Case Tags | List of tags you have assigned to test cases within the project or the test suite. When you check one or more tags, the test runner will include in the test run only test cases containing all these tags. This parameter is identical to the |
Note
When selecting tags for custom arguments in TestRunner, you can now choose how to combine the tags using OR or AND operators.
For more information about tags, see Working with Tags.
![]() |
The Custom Args tab allows you to add extra arguments for the runner.
For example, you can command the runner to use a setting file that is different from the default soapui-settings.xml
file. To do this, you can enter the following text into the Tool Args edit box:
-tC:\Work\test-settings.xml
TestRunner is installed along with ReadyAPI and uses the same modules. It does not require any special license as it uses the existing ReadyAPI Test license you have.
SPNEGO-Kerberos authorization will cause tests you start from the test runner to fail. To avoid this issue, add the following code to the end of the first set JAVA_OPTS
line in the ReadyAPI.bat
file.
-Djavax.security.auth.useSubjectCredsOnly=false