Supported options in Maven

You must provide the values for the following required parameters:
  • workspace
  • project
  • suite
If you include these required parameters in a configuration file and use the configfile parameter to specify the complete file path, then these parameters are not required.
The following table lists all the supported options with description:
Option Description
Required
workspace The complete path to the Eclipse workspace.
project The path, including the file name of the project relative to the workspace.
suite The path, including the file name of the test relative to the project. A test can be a Web UI test or a compound test.
Optional
aftsuite The path, including the file name of the xml file to run an AFT test. The aftsuite option accepts aft XML as the parameter value. It supports only one aft XML as input.

For example, aftsuite="aftinput"

Note: You must provide the file name along with the file extension to run an Accelerated Functional Test suite.
configfile The option to specify the complete path to a file that contains the parameters for a test run. Each parameter must be on a single line. To create a configuration file, you must use an editor that does not wrap lines. Any parameter, whether required or optional, can be set in the configuration file. The command line parameters override the values in this file.
Notes:

  • If you are creating a config file manually, the file must be in the UTF-8 format. You must not use quotation marks in this file even for values that contain spaces.

  • You can create command line config file from the desktop client, which you can use while running tests from Maven. See Creating a command-line config file. This option is available only for Web UI and compound tests.
compare The option to export the result in the compare mode. You must use this option with exportstatshtml and execsummary. The value can be paths to the runs and are relative to the workspace. You must separate the paths by a comma.
exportlog The option to specify the file path to store the exported test log.

You can provide multiple parameter entries when running multiple tests. You must use a colon to separate the parameter entries.

For example: exportlog c:/logexport.txt:c:/secondlogexport.txt

If there are multiple suite option entries with a single exportlog parameter entry, then the exportlog option generates the appropriate number of test logs by appending 0, 1, 2, and so on to the exportlog option entry name.

For example: suite="sampletest1:sampletest2:sampletest3" exportlog="c:/logexport.txt "

The command generates the following test logs:

  • logexport_0.txt
  • logexport_1.txt
  • logexport.txt
exportstatreportlist The option to specify a comma-separated list of report IDs along with exportstats or exportstatshtml to list the reports that you want to export in place of the default reports, or the reports selected under Preferences.

To view this setting, navigate to Window > Preferences > Test > Performance Test Reports > Export Reports.

To copy the report IDs list into your command line, navigate to Window > Preferences > Test > Performance Test Reports > Export Reports.

Under Select reports to export, select the required reports, and click Copy ID to clipboard. You can then paste the clipboard content on to your editor.
exportstats The option to export reports in comma-separated values (CSV) format, with the file name derived from the report name. This directory can be relative to the project or a directory on your file system. If the exportstatreportlist option is not specified, the reports specified on the Export Reports page of the Performance Test Report preferences are exported.
exportstatshtml The option to export web analytic results to the specified directory. You can then analyze the results on a web browser without using the test workbench.
overwrite

Determines whether a result file with the same name is overwritten. The default value, false, indicates that the new result file is created. If the value is true, the file is overwritten and retains the same file name. You must use double quotes for values true or false.
plugins The complete path to the folder that contains the plugins. Typically, on Windows operating systems, this folder is located at C:\Program Files\HCL\HCLIMShared\plugins.

You must specify the path if the folder is at a different location.
protocolinput The option to run a Web UI test in parallel on different browsers.

protocolinput="all.available.targets.in.parallel=all"

protocolinput="all.available.targets.in.parallel=chrome,ff,ie"

Note: If you use the protocolinput argument, you must not use the equivalent vmargs arguments:
vmargs="-Dall.available.targets.in.parallel=all"
vmargs "-Dall.available.targets.in.parallel=browser1,browser2,browser3"
quiet The option to turn off any message output from the launcher and return to the command shell when the run or the attempt is complete.
results The name of the results file. The default result file name is the test name with a time stamp appended. You must specify a folder name that is relative to the project to store the test results.

For example, results="folder/resultname"
usercomments

The text to be displayed in the usercomments row of the report.

Add text within the double quotation mark ()

Note:
  • When you run tests by using the double quotation marks ("") for the usercomments field, then the usercomments row of a report does not contain double quotation marks.
  • To work around this problem, you must create a command-line config file, and then run the test by using the configfile field.
varfile The complete path to the XML file that contains the variable name and value pairs.

To run a Web UI test on a different browser than that was used for the recording, specify the predefined variable. For more information, see Defining a variable to run a test with a selected browser.
vmargs

The option to pass Java™ virtual machine arguments.

You can use the -vmargs option in the following scenarios:
  • To specify the Java™ maximum heap size for the Java™ process that controls the command line playback, use the -vmargs option with the -Xmx argument.

    For example, when you use-vmargs -Xmx4096m, specify a maximum heap size of 4096m. This method is similar to specifying -Xmx4096m in the eclipse.ini file for the workbench when playing back the test from the user interface.

  • To collect the response time data for the app itself and for the server and network and display them in different bar charts, use -vmargs "-De2e.collect=true". For desktop-based web applications, the response time data is captured and displayed by default.

  • To execute tests in parallel on all mobile devices, which are in passive mode, connected to the workbench and ready for playback, use -vmargs "-Dall.available.targets.in.parallel=true".

  • To execute tests in parallel on all supported desktop browsers and connected mobile devices, use -vmargs "-Dall.available.targets.in.parallel=all".

  • To execute tests in parallel on selected desktop browsers and connected mobile devices, use -vmargs "-Dall.available.targets.in.parallel=browser1,browswer2,browser3". You must separate browser names with a comma. For example, firefox, ff, chrome, ie, ie64, safari, "-Dall.available.targets.in.parallel=browser1,browser2,browser3".
publish The option to publish test results to DevOps Test Hub.

You must provide the URL and offline user token of the server in Window > Preferences > Test > DevOps Test Hub of Test UI before you use the publish parameter in the test script.

Use the following arguments with the publish parameter:

  • To specify the project name, use any of the following formats:

    • serverURL #project.name=projectName&teamspace.name=name_of_the _teamspace

    • serverURL #project.name=projectName&teamspace.alias=name_of_the _teamspace_alias

    You must consider the following points while providing the project name:

    • If the project name is not specified, then the value of the Project parameter is used.

    • If you have a project with the same name in different team spaces, then you can append either the &teamspace.name=name_of_the _teamspace or &teamspace.alias==name_of_the_teamspace_alias options.

      For example: 
      name="test1" workspace="C:/Users/IBM/devopstest/workspace1" 
project="proj1" suite="Tests/testHttp.testsuite" 
publish="https://localhost:5443#project.name=test&teamspace.name=ts1"
      Where:

      • https://localhost:5443 is the URL of the server.

      • test is the name of the project.

      • ts1 is the name of the team space.

    • While providing the name of the team space or team space alias, you must replace the ampersand (&) character with & as shown in the preceding example.
    • If the name of the project or team space contains a special character, then you must replace it with %<Hex_value_of_special_character>.

      For example, if the name of the team space is Initial Team Space, then you must provide it as Intial%20Team%20Space.

      Where, %20 is the hexadecimal value of the space character.

  • To avoid publishing of reports, use no.

    You can use the no option if you do not want to publish test results after the run. This option is useful if the product preferences are set to publish the results, but you do not want to publish them.

    For example:
    name="test1" workspace="C:/Users/IBM/devopstest/workspace1" project="proj1" 
suite="Tests/testHttp.testsuite" publish="no"

If you do not use the configfile parameter to run the tests, then the values provided in the test script always take precedence over the Results options set in the product preferences

(Window > Preferences > Test > DevOps Test Hub > Results).

The Reports information section on the Output window displays the names of the report along with its corresponding URLs in the following conditions:

  • When you configured the URL of DevOps Test Hub in preferences of Test UI (Window > Preferences > Test > DevOps Test Hub.

  • When you set Publish result after execution as Always or Prompt in the preferences of Test UI

    (Window > Preferences > Test > DevOps Test Hub > Results).
publish_for

The option to publish test results to DevOps Test Hub based on the completion status of the tests. You must use the publish_for parameter along with the publish parameter.

The following are the available options that you can use for the publish_for parameter:

  • ALL - This is the default option. You can use this option to publish test results for any text execution verdict.
  • PASS - You can use this option to publish test results for the tests that have passed.
  • FAIL - You can use this option to publish test results for the tests that have failed.
  • ERROR - You can use this option to publish test results for the tests that included errors.
  • INCONCLUSIVE - You can use this option to publish test results for the inconclusive tests.
You can add multiple parameters separated by a comma.
For example: 
name="test1" workspace="C:/Users/IBM/devopstest/workspace1" 
project="proj1" suite="Tests/testHttp.testsuite" 
publish="https://localhost:5443#project.name=test&amp;teamspace.name=ts1" publish_for="FAIL,ERROR"
eclipsehome

The option to provide the complete path of the directory that contains eclipse.exe.

For example, C:\Program Files\HCL\DevOpsTest
importzip

The option to import the project as test assets with dependencies into your workspace.

For example, 
workspace="C:/Users/IBM/devopstest/workspace1" project="proj1" 
eclipsehome="C:\Program Files\HCL\DevOpsTest" 
plugins="C:\Program Files\HCL\HCLIMShared\plugins" 
suite="Tests/testHttp.testsuite" importzip="D:\assets\test.zip"
execsummary

The option to export all of the reports for the test run in a printable format, also known as an executive summary, to the local computer. You must specify the path to store the executive summary.
execsummaryreport

This option to export a specific report as an executive summary for the test run to the local computer. You must specify the ID of the report to export as execsummaryreport <reportID>.

For example, to export an HTTP performance report, specify http.
Note: You must use this option along with execsummary.

To copy the report IDs list into your command line, navigate to Window > Preferences > Test > Performance Test Reports > Export Reports.

Under Select reports to export, select the required reports, and click Copy ID to clipboard. You can then paste the clipboard content on to your command line editor.
swapdatasets

For a test, the default value is the dataset specified in the test editor.

You must use the swapdatasets option to replace dataset values during a test run. You must ensure that both original and new datasets are in the same workspace and have the same column names. You must also include the path to the dataset.

For example: /project_name/ds_path/ds_filename.csv:/project_name/ds_path/new_ds_filename.csv. You can swap multiple datasets that are saved in a different project by adding multiple paths to the dataset separated by a semicolon (;).
exportReport
The option to export the unified report of UI tests to the file formats such as PDF, HTML, and XML.
Note: The exported XML file is a JUnit XML file. You can view this file in applications that support JUnit reporting formats.

The command syntax is as follows:

exportReport "type=<reporttype>;format=<file type1,file type2,file type3>;folder<destination folder path;filename=<name of the exported file>"

For example, to export the report to only the pdf format, you can use exportReport "type=unified;format=pdf;folder=Exportedreport102;filename=testreport"

If you want to export the report to multiple formats, you can specify the file formats as comma-separated values. The file type value can be in uppercase or lowercase.

For example, to export the report to all the supported formats, you can use

exportReport "type=unified;format=pdf,xml,html;folder=Exportedreport102;filename=testreport"

The report in different file formats use the same file name that is specified in the command.
labels

The option to add labels to the test results when the test run is complete. You can add multiple labels to a test result separated by a comma.

For example, labels =label1, label2

When you run test assets then the same labels are displayed on the UI Test Statistical Report in Test UI.

If you have set Publish result after execution as Always or Prompt in the Test UI preferences

(Window > Preferences > Test > DevOps Test Hub) and use labels option, then the Results page of DevOps Test Hub displays the same label for the specific test asset.

Note:
  • When you run tests by using the double quotation marks ("") for the labels parameter, then the labels in the test result do not include the double quotation marks.
  • To work around this problem, you must create a command-line config file, and then run the test by using the configfile parameter.
  • When you use the configfile parameter to run tests, then labels provided in the configuration file take precedence over the labels provided in the ExecuteWebUIFunctionalTest.xml file.
exportstatsformat
The option to specify a format for the result that you want to export along with the exportstats option. You must use at least one of the following parameters with the exportstatsformat option:

  • simple.csv

  • full.csv

  • simple.json

  • full.json

  • csv

  • json

For example, exportstats="<local_dir_path>" exportstatsformat="simple.json"

You can add multiple arguments separated by a comma.

For example, exportstats="<local_dir_path>" exportstatsformat="simple.json, full.csv"

When you want to export both simple and full type of test results in a json or csv format, you can specify json or csv as the arguments in the command. When the test run completes, the test result exports to simple.json and full.json files.

For example, exportstats="<local_dir_path>" exportstatsformat="json"