SessionCreator

Specifies the user name that will be used to start a session or to connect to an existing session.

Specifies the password that will be used to start a session or to connect to an existing session.

The password will not be encrypted.

Specifies the file from which the utility will read the password that will be used to start a session or to connect to an existing session. The file must support the UTF-8 encoding and must reside in a location where the utility can access it.

Specifies whether the utility will use the currently active session. If you omit this parameter, the utility will stop the current session and will start a new session using the provided credentials.

The screen resolution to set in the created user session, in the width*height format. The default value is '1280*1024'.

Specifies the path to the project suite file (.pjs) or to the project file (.mds) that contains the tests you want to run.

The utility commands the product to export the test results to the file specified by the file_name parameter after the test run is over.

The following formats are supported:

• .mht
• .tcLogX
• .html
• .htm

Notes:

• file_name should specify the name of a non-existing file. If it specifies an existing file, TestExecute will fail to run the test.

• It is recommended that file_name specify the fully-qualified file name. If the parameter value does not include the folder path, TestExecute will save the file to the current TestExecute folder (by default, it is the project folder).

The utility commands TestExecute to generate a Summary report for the current test run and to save it in the JUnit report format to the XML file specified by the file_name parameter.

The report will include the total number of run tests, the number of passed tests and the number of failed tests.

Notes:

• If the file_name parameter specifies an existing file, TestExecute will overwrite it.

• We recommend that the file_name parameter specify the fully-qualified file name. If the parameter value does not include the folder path, TestExecute will save the file to the current working folder (by default, it is the project folder).

Specifies a timeout for the testing session, in seconds.

If the testing session is still running after the timeout has elapsed, the utility will stop the session and report an error. The other tests will be canceled and TestExecute will be closed.

Possible values are 30…4 294 967 seconds (49.7 days). If the specified value is out of range, the closest in-range value is used.

Enables (On) or disables (Off) self-healing tests in TestExecute.

If self-healing tests are enabled (default behavior) and TestExecute fails to find a tested object during the test run, it will try to find a replacement object to use it in the test instead of the missing one and will continue the test run. After the test run is over, the test log will include a warning message informing about the issue and suggesting updating the mapping criteria of the missing object to match the replacement object. Open the project in TestComplete and update the criteria as suggested.

If self-healing tests are disabled and TestExecute fails to find a tested object during the test run, it will report the “The Object Does Not Exist” error. Depending on the project settings, it will stop the test run.

The utility will command the product to run the specified project. Specify the project name as it is shown in the Project Explorer.

The project will run all the test items enabled in its Execution Plan editor.

The utility will command the product to run the specified project item. You can view project items in the Project Explorer panel in TestComplete.

Project_name is the name of the project as it is shown in the Project Explorer panel.

Item_name is the name of a project item (you can view these items in the Project Explorer). You can run only those project items that have the Run item in their context menu. For example, in this way, you can run the Network Suite project item.

The utility commands the product to run the specified project’s test or the project’s tests that match the specified tag.

Project_name specifies the name of the project that holds the needed test or tests (use the same name as that shown in the Project Explorer panel).

Test_name is the full name of the needed test or the tag assigned to the needed tests:

• Test full name

  • For project items, the full name includes the name of the collection to which the item belongs and the item name separated by the pipe character. For script tests, the full name also includes the the name of the unit. Enclose your tests’ full names in quotes.

    Do not include any logical project folders in your test's full name.

    For example:

    "KeywordTests|Test1"

    "Scenarios|FeatureFile1"

    "Scenarios|Feature 1|My scenario description"

    "Scenarios|@tag"

    "LLCollection1|LLP1"

    "ManualTests|ManualTest1"

    "ReadyAPI1|Test1"

    "UnitTesting1|NUnit1"

    "Script|Unit1|Main"

    "NetworkSuite|Jobs|Job1|Job1" (For a network suite’s jobs, the name of the Jobs collection and the name of the job are the same)

    "NetworkSuite|Jobs|Job1|Task1"

  • For test items, the full name is specified according to the item hierarchy on the View > Organize Tests page, including parent test items and groups. Enclose the test full names in quotation marks.

    For example:

    "ProjectTestItem1"

    "ProjectTestItem1|ProjectChildTestItem1"

    "Group1|ProjectTestItem1"

  Note:

  TestExecute executes only those test items that are enabled in the Execution Plan editor. The disabled items are not run.

• Tag

  To run scripts, keyword tests, and BDD scenarios that match a tag, specify the tag name in the @tag_name format. For example:

  "@AllTests"

  "@low-priority"

The utility commands the product to run the specified script routine of the specified project. Project_name specifies the name of the project to which the routine belongs. Unit_name specifies the name of the unit holding the desired routine. Routine_name is the name of the script routine to be called. The routine to be called must not use parameters or return any values.

The utility commands the product to run the specified project’s test or tests that match the specified tag expression.

Tag expression syntax

Tag expression syntaxTag expression syntax

• Use @ before tag names, that is, use @tag1 rather than tag1.

• To combine tags, use the and, or and not operations, for example:

  @tag1 or @tag2
  @tag1 and not @tag3
  not @tag5

  These operations don’t depend on the scripting language you use in your TestComplete project. That is, for example, in JavaScript projects you should use and, or and not rather than &&, || and !  —

  @tag1 and not @tag2  ← Correct!
  @tag1 && !@tag1      ← Incorrect!

• If needed, you can use braces to group tags, for example:

  @tag1 and (@tag2 or @tag3)
  (@tag1 or not @tag2) and (not @tag3 or @tag4)

For example:

The utility commands the product to pass the specified argument value as is to the test.

Shows information on the RunTest command.

Specifies a port for the RESTful web service. The default value is 2377.

Specifies the user name that will be used to start a session or to connect to an existing session.

Specifies the password that will be used to start a session or to connect to an existing session.

The password will not be encrypted.

Specifies the file from which the utility will read the password that will be used to start a session or to connect to an existing session. The file must support the UTF-8 encoding and must reside in a location where the utility can access it.

Specifies whether the utility will use the currently active session. If you omit this parameter, the utility will stop the current session and will start a new session using the provided credentials.

Shows information on the StartRestServer command.