From the command line, run each web test using the following syntax:

ParallelRunner -t <test path> -b <browser> -r <results path>

For example:

ParallelRunner -t "C:\GUIWebTest_Demo" -b "Chrome;IE;Firefox" -r "C:\parallelexecution"

If you specify multiple browsers, the test is run multiple times, one run on each browser.

From the command line, run each mobile test using the following syntax:

ParallelRunner -t <test path> -d <device details> -r <results path>

For example:

If you specify multiple devices, the test is run multiple times, one run on each device.

Wait for an available device

You can instruct the ParallelRunner to wait for an appropriate device to become available instead of failing a test run immediately if no device is available. To do this, add the -we option to your ParallelRunner command.

From the command line, run each API test using the following syntax:

ParallelRunner -t <test path> -r <results path>

For example:

ParallelRunner -t "C:\APITest" -r "C:\API_TestResults"

-t

--test

String. Required. Defines the path to the folder containing the UFT One test you want to run.

If your path contains spaces, you must surround the path with double quotes (""). For example: -t ".\GUITest Demo"

Multiple tests are not supported in the same path.

-b

--browsers

String. Optional. Supported for web tests.

Define multiple browsers using semicolons (;). ParallelRunner runs the test multiple times, to test on all specified browsers.

Supported values include:

Chrome, Chrome_Headless, ChromiumEdge, Edge, Firefox, Firefox64, IE, IE64, Safari

Notes:

• This value overrides any settings defined in the Record and Run Settings, and any browser parameterization configured in the test. The WebUtil.LaunchBrowser method is not affected.

• We recommend using consistent casing for the browser name, to avoid separate columns in chromium run result reports for the same browser type. For more details, see Sample ParallelRunner response and run results.

• Safari is supported via testing on a remote Mac machine. For more details, see Connect to a remote Mac computer.

-d

--devices

String. Optional. Supported for mobile tests.

Define multiple devices using semicolons (;). ParallelRunner runs the test multiple times, to test on all specified devices.

Define devices using a specific device ID, or find devices by capabilities, using the following attributes in this string:

• deviceID. Defines a device ID for a specific device in the Digital Lab device lab. This attribute cannot be used with other device capability attributes.

• manufacturer. Defines a device manufacturer.

• model. Defines a device model.

• osType. Defines a device operating system.

  One of the following: Android, iOS, Windows Phone.

  If this value is not defined, UFT One uses the osType defined in the test's Record and Run settings as a default.

• osVersion. Defines a device operating system version. One of the following:

  • Any. Leaves the version number undefined.

  • A specific version. For example: 10.0

  • A boolean operator and version value. For example: >10.0, <10.0, >=10.0, or <=10.0

Note: Do not add extra spaces around the commas, colons, or semicolons in this string. We recommend always surrounding the string in double quotes ("") to support any special characters.

For example:

–d "manufacturer:apple,osType:iOS,osVersion:>=11.0"

-dt

--dataTables

String. Optional. Supported for web and mobile tests.

Defines the path to the data table you want to use for this test. UFT One uses the table you provide instead of the data table saved with the test.

Define multiple data tables using semicolons (;). ParallelRunner runs the test multiple times, to test with all specified data tables.

If your path contains spaces, you must surround the path with double quotes ("").

For example: -dt ".\Data Tables\Datatable1.xlsx;.\Data Tables\Datatable2.xlsx".

--output

String. Optional. Determines the result output shown in the console during and after the test run.

Supported values include:

• Normal. (Default) Run output is automatically updated in the console.

  For example, the run status changes from Pending to Running, and then to Pass or Fail.

• Static. The report path is displayed at the beginning of the test run, and then the run status is shown when the test is complete.

• Disable. No output is shown in the console at all.

-r

--reportPath

String. Optional. Defines the path where you want to save your test run results. By default, run results are saved at %Temp%\TempResults.

If your string contains spaces, you must surround the string with double quotes (""). For example: - r "%Temp%\Temp Results"

--report-auto-launch

Optional. Include in your command to automatically open the run results when the test run starts. Use the -rr--report-auto-refresh option to determine how often it's refreshed.

For more details, see Sample ParallelRunner response and run results.

--reportName

String. Optional. Defines the report name, which is displayed in the browser tab when you open the parallel run's summary report. By default, the name is Parallel Report.

Customize this name to help distinguish between runs when you open multiple report at once. UFT One also adds a timestamp to each report name for this purpose.

If your string contains spaces, you must surround the string with double quotes (""). For example: - rn "My Report Title"

--report-auto-refresh

Optional. Determines how often an open run results file is automatically refreshed, in seconds.

For example: -rr 5

Default, if no integer is presented: 5 seconds.

-tp

String. Optional. Supported for web and mobile tests.

Defines the values to use for the test parameters. Provide a comma-separated list of parameter name-value pairs.

For test parameters that you do not specify, UFT One uses the default values defined in the test itself.

For example: -tp "param1:value1,param2:value2"

Define multiple test parameter sets using semicolons (;). ParallelRunner runs the test multiple times, to test with all specified test parameter sets.

For example: -tp "param1:value1, param2:value2; param1:value3, param2:value4"

If your parameter value includes commas (,), semicolons (;), or colons (:), surround the value with a backslash followed by a double quote (\").

For example, if the value of TimeParam is 10:00;00, use:

-tp "TimeParam:\"10:00;00\""

Note: You cannot include double quotes (") inside a parameter value using the command line options. Instead, use a JSON configuration file for your ParallelRunner command.

--wait-for-environment

Optional. Supported for mobile tests.

Include in your command to instruct each mobile test run to wait for an appropriate device to become available instead of failing immediately if no device is available.

String. Defines the path where you want to save your test run results.

By default, run results are saved at %Temp%\TempResults.

String. Defines the report name, which is displayed in the browser tab when you open the parallel run's summary report. By default, the report name is the same as the .json file name.

Customize this name to help distinguish between runs when you open multiple report at once. UFT One also adds a timestamp to each report name for this purpose.

String. Defines the path to the folder containing the UFT One test you want to run.

String. Defines a suffix to append to the end of your run results file name. For example, you may want to add a suffix that indicates the environment on which the test ran.

Example: "reportSuffix":"Samsung6_Chrome"

Default: "[N]". This indicates the index number of the current result instance, if there are multiple results for the same test in the same parallel run.

Notes: 

• The run results file name consists of <test name>_<reportSuffix> and must be unique. Therefore, do not provide the same suffix for multiple runs of the same test.
• When deciding on a suffix, keep in mind that if the resulting file name is longer than 22 characters, the file name will be truncated in the output that ParallelRunner provides in the command window.

String. Defines the browser to use when running the web test.

Supported values include:

Chrome, Chrome Headless, ChromiumEdge, Edge, IE, IE64, Firefox, Firefox64, Safari

Notes:

• This value overrides any settings defined in the Record and Run Settings, and any browser parameterization configured in the test. The WebUtil.LaunchBrowser method is not affected.
• We recommend using consistent casing for the browser name, to avoid separate columns in the run result report for the same browser type. For more details, see Sample ParallelRunner response and run results.
• Safari is supported via testing on a remote Mac machine. For more details, see Connect to a remote Mac computer.

• UFT One 23.4 and earlier: Edge refers to Microsoft Edge Legacy.

  UFT One 24.2 and later: Edge refers to Chromium-based Microsoft Edge. The ChromiumEdge value is supported for backward compatibility only.

String. Defines a device ID for a specific device in the Digital Lab device lab.

Note: When both deviceID and device capability attributes are provided, the device capability attributes will be ignored.

String. Defines a device manufacturer.

String. Defines a device model.

String. Defines a device operating system version.

One of the following:

• Any. Leaves the version number undefined.

• A specific version. For example 10.0

• A boolean operator and version value. For example: >10.0, <10.0, >=10.0, or <=10.

Defines a device operating system.

One of the following:

• Android
• iOS
• Windows Phone

dataTable

String. Supported for GUI Web, Mobile, and Java tests.

Defines the path to the data table you want to use for this test run. UFT One uses the table you provide instead of the data table saved with the test.

Place the dataTable definition in the section that describes the relevant test run.

String. Supported for GUI Web, Mobile, and Java tests.

Defines the values to use for the test parameters in this test run. Provide a comma-separated list of parameter name-value pairs.

For example: 

"testParameter":{
      "para1":"val1",
      "para2":"val2"
    }

Place the testParameter definition in the section that describes the relevant test run.

If your parameter value includes a backslash (\) or double quote ("), add a backslash before the character. For example: "para1":"val\"1" assigns the value val"1 to the parameter para1.

For test parameters that you do not specify, UFT One uses the default values defined in the test itself.

Set this option to true to instruct each mobile test run to wait for an appropriate device to become available instead of failing immediately if no device is available.

The IP address and port number of your Digital Lab server.

Default port: 8080

The authentication mode to use for connecting to Digital Lab.

Available values:

• 1: Access key authentication. Authenticate using access keys you receive from Digital Lab.

• 0: Basic authentication. Authenticate using user name and password.

ClientId / SecretKey / TenantId

The access keys received from Digital Lab.

The main element containing all of the wait conditions used to control this test's run.

Can contain wait options or nested conditions elements.

An element that contains an array of one or more simple conditions or additional combined conditions.

conditions elements can be contained in combined conditions.

Indicates whether the conditions in the conditions element following the operator must all be met.

Possible values: 

• AND. All of the conditions following the operator must be met before the test run begins.
• OR. The test run begins as soon as one of the conditions following the operator is met.

Instructs ParallelRunner to wait the specified number of seconds before beginning this test run.

Instructs ParallelRunner to run this test run after the specified run ends. Specify the run to wait for by using its testRunName.

You can combine the waitForTestRun option with other options:

• Use waitSeconds to wait a number of seconds after the specified run ends.
• Use waitForRunStatuses to wait until the specified test reaches a specific status.

For example: The following condition instructs ParallelRunner to run test run 1 10 seconds after run 3 reaches one of the specified statuses.

"testRunName": "1", 
    "condition":{ 
        "waitForTestRun": "3",
        "waitSeconds": 10,
        "waitForRunStatuses": ["passed", "failed", "warning", "canceled"]
}

Note: When combining multiple wait options, the implied operation is AND.

Instructs ParallelRunner to run this test run after the specified run reaches a specific status.

• Specify the run to wait for by using its testRunName.

• Provide a string of one or more test statuses to wait for. The condition is met once the specified test reaches one of the specified statuses.

  For example: "waitForRunStatuses": ["passed", "failed", "warning", "canceled"]