Testim Modules

The Engines->Testim folder in the Standard subset contains Modules that allow you to perform specific integration tasks with Tricentis Testim (opens in new tab) directly in Tosca.

Run Testim Test

Use the The Run Testim Test Module to run a specific Testim test.

For more details on how to use this Module, check out Execute Testim tests directly in Tosca.

It has the following ModuleAttributes:

ModuleAttribute

Description

Testim API Key

Your Testim API key (opens in new tab). Required to authenticate and connect Tosca to your Testim account, as well as to trigger a Testim test execution.

Test ID

ID of the Testim test you want to execute.

Grid

Name of the grid (opens in new tab) the test should run on.

Branch (optional)

Name of the branch (opens in new tab) to execute tests from.

Retries (optional)

Amount of retries you want to allow per test.

Timeout (optional)

Maximum amount of seconds allowed to pass before the test automatically stops.

Tosca Flow Control

Execution ID

Unique identifier for the Testim test execution. If you run tests asynchronously, this ID is automatically generated and stored in a specified buffer. This allows you to track and retrieve the results later without waiting for the Testim test to finish.
Wait for result

Determines whether Tosca waits for the result of the Testim test execution before moving on to the next TestSteps in the TestCase.

  • True (default): Tosca waits for the result (sync).

  • False: Tosca continues without waiting for the Testim test to finish (async).
Pass on test failures

Determines whether Tosca considers the TestStep successful even if the Testim test fails.

  • True: Marks the TestStep as passed, allowing the execution to continue.

  • False (default): Marks the TestStep as failed, and execution may stop based on your error handling configuration.

Run Testim Test Suite

Use the Run Testim Test Suite Module to run all tests in a specified Testim test suite(opens in new tab).

For more details on how to use this Module, Execute Testim tests directly in Tosca.

It has the following ModuleAttributes:

ModuleAttribute

Description

Testim API Key

Your Testim API key (opens in new tab). Required to authenticate and connect Tosca to your Testim account, as well as to trigger a Testim test execution.

Test Suite ID

ID of the Testim test suite you want to execute.

Grid

Name of the grid (opens in new tab) the test should run on.

Branch (optional)

Name of the branch (opens in new tab) to execute tests from.

Retries (optional)

Amount of retries you want to allow per test.

Timeout (optional)

Maximum amount of seconds allowed to pass before the test automatically stops.

Tosca Flow Control

Execution ID

Unique identifier for the Testim test execution. If you run tests asynchronously, this ID is automatically generated and stored in a specified buffer. This allows you to track and retrieve the results later without waiting for the Testim test to finish.
Wait for result

Determines whether Tosca waits for the result of the Testim test execution before moving on to the next TestSteps in the TestCase.

  • True (default): Tosca waits for the result (sync).

  • False: Tosca continues without waiting for the Testim test to finish (async).
Pass on test failures

Determines whether Tosca considers the TestStep successful even if the Testim test fails.

  • True: Marks the TestStep as passed, allowing the execution to continue.

  • False (default): Marks the TestStep as failed, and execution may stop based on your error handling configuration.

Run Testim Test Plan

Use the Run Testim Test Plan Module to run a specific Testim test plan (opens in new tab).

For more details on how to use this Module, check out Execute Testim tests directly in Tosca.

It has the following ModuleAttributes:

ModuleAttribute

Description

Testim API Key

Your Testim API key (opens in new tab). Required to authenticate and connect Tosca to your Testim account, as well as to trigger a Testim test execution.

Test Plan ID

ID of the Testim test plan you want to execute.

Branch (optional)

Name of the branch (opens in new tab) to execute tests from.

Retries (optional)

Amount of retries you want to allow per test.

Timeout (optional)

Maximum amount of seconds allowed to pass before the test automatically stops.

Tosca Flow Control

Execution ID

Unique identifier for the Testim test execution. If you run tests asynchronously, this ID is automatically generated and stored in a specified buffer. This allows you to track and retrieve the results later without waiting for the Testim test to finish.
Wait for result

Determines whether Tosca waits for the result of the Testim test execution before moving on to the next TestSteps in the TestCase.

  • True (default): Tosca waits for the result (sync).

  • False: Tosca continues without waiting for the Testim test to finish (async).
Pass on test failures

Determines whether Tosca considers the TestStep successful even if the Testim test fails.

  • True: Marks the TestStep as passed, allowing the execution to continue.

  • False (default): Marks the TestStep as failed, and execution may stop based on your error handling configuration.

Wait for Testim Test

With the Wait for Testim Test Module, you can wait for an asynchronously triggered Testim test to finish.

To trigger a Testim test asynchronously, you can use the Run Testim Test, Run Testim Test Suite, or Run Testim Test Plan Module with Wait for result set to False. This instructs Tosca to move to the next TestSteps in the TestCase, while the Testim test runs in parallel. If Tosca finishesthe remaining TestSteps before the Testim test is complete, the Wait for Testim Test Module pauses Tosca execution until the Testim test is complete.

For more details on how to use this Module, check out Execute Testim tests directly in Tosca.

It has the following ModuleAttributes:

ModuleAttribute

Description

Execution ID

ID of the Testim test execution you triggered asynchronously. Tosca uses this ID to track the result of the test and determine whether it passed or failed.

Pass on test failures

Determines whether Tosca considers the TestStep successful, even if the test fails in Testim.

  • True: Marks the TestStep as passed, allowing the execution to continue.

  • False (default): Marks the TestStep as failed, which may stop execution, depending on your error handling configuration.

Testim API Key

Your Testim API key (opens in new tab). Required to authenticate and to allow Tosca to access the Testim test execution results.