Supported parameters

You can use two types of parameters to configure your tests in Tosca Cloud:

  • Custom parameters that you defined and can reuse across multiple test steps in your test case. For custom parameters, you can choose your own name and value.

  • Special task parameters that perform "background work", typically related to your test environment. For special task parameters, you need to enter a specific name and value.

This topic lists all special task parameters in Tosca Cloud:

Parameter

Technology

Description

AccessibilityFastMode

Web automation

Improve the performance of your accessibility tests.

Possible values: 

  • Ignore Passed Checks: Exclude 'passed' checks. As a result, the accessibility report displays only violations without comparison. This is especially useful for large webpages.

  • Disable Redundant Checks: Avoid redundant analyses of unchanged elements. After the initial analysis, Tosca Cloud focuses only on the HTML elements that have changed between analyses. Note that this feature detects changes in the following elements: subtrees, child lists, attributes, character data.

  • Optimize Analysis: Use the functionalities from Ignore Passed Checks and Disable Redundant Checks. This means Tosca Cloud applies the combined benefits of earlier analyses to review only new or modified HTML elements, avoiding redundant and previously passed checks.

  • Off: Disable performance improvements.

AllowedAriaControls

Web automation

Specifies the ARIA elements Tosca Cloud can interact with during test runs.

The value is a list of controls separated by colon or semicolon. For example, combobox; link; listbox.

AvoidExecutionRecorder

All

Disable recording of test cases you run.

Browser

Web automation

Browser you want to use for this test case. The default value is Chrome.

Possible values: InternetExplorer, Firefox, Chrome, Edge.

BrowserVersion

Web automation

Version of the browser.

BrowserStack_<CapabilityName>

Web automation

Specifies BrowserStack capabilities for remote tests.

Name syntax:

  • Replace <CapabilityName> with a BrowserStack capability.

  • Replace any periods in the capability name with two underscores.

  • Replace any colons in the capability name with three underscores.

For example: BrowserStack_Example__name___1 for the Example.name:1 capability.

For information on BrowserStack capabilities and their values, check out the BrowserStack documentation (opens in new tab).

BusyShapes

All

Defines which shape the cursor should take if it's busy.

Possible values: AppStarting, Arrow, Cross, Hand, Help, IBeam, Icon, No, Size, SizeAll, SizeNESW, SizeNS, SizeNWSE, SizeWE, UpArrow, Wait.

ControlFramework

Web automation

Control framework used in your web application.

CursorIdleDuration

All

Time (in milliseconds) to wait after the cursor has returned to its original shape. The default value is 100.

DokuSnapperAllPropertiesAvailable

All

Specifies whether you can use test case properties as placeholders in a template. This gives you more customization options than the standard placeholders.

Select True if you want to use any test case property as a placeholder in your template.

DokuSnapperEnabled

All

Specifies whether DokuSnapper is enabled. Possible values are True and False.

When you enable DokuSnapper, Tosca Cloud generates a report for every test case on each run. The document name consists of the test case name and a timestamp.

DokuSnapperPath

All

The folder path where Tosca Cloud stores your generated reports.

DokuSnapperReportFormat

All

Specifies the file format for the report that you want DokuSnapper to generate. Choose one of the following values:

  • PDF document (.pdf)

  • Word document (.docx)

  • Excel document (.xlsx). Note that Excel reports don't support templates, which means you can't customize .xlsx reports.

DokuSnapperShowBuffersInTables

All

Specifies whether to display buffer test steps in tables.

Select True to display buffer operations as tables in your report.

DokuSnapperStorageLocationType

All

Select Tosca, so that you can find your report Attachments tab.

Select Local, so that Tosca Cloud saves the document to the folder you specified in DokuSnapperPath on the machine that runs your test. For that reason, you can't retrieve local reports from a cloud agent.

DokuSnapperTemplate

All

Specifies the absolute path to the template file that the generated document is based on.

You can customize the template. For more information, check out Work with templates.

Note the following preconditions:

  • The template must contain exactly one table with two columns.

  • You can insert different placeholders throughout the right column of this document.

EnableSlotContentHandling

Web automation

Specifies whether to display controls as children of their assigned slot element.

ExampleDirectoryJSON

JSON

Directory to be used for saving the JSON files during test runs.

ExampleDirectoryXML

XML

Directory to be used for saving the XML files during test runs.

ExcelLanguage

All

Change the language for your calculations to the local language on your workstation.

AppiumServer

Mobile

Address of the AppiumServer.

TMAServer

Mobile

Specifies the Tricentis Mobile Agent server address.

ExecuteInParallel

Mobile

Language for your calculations with CALC, which can be English or Local.

ExperitestAccessKey

Mobile

Access key for Experitest.

ExperitestAppiumVersion

Mobile

Appium version of Experitest.

LiveView

Mobile

Use the Live View function if you need to see the screen of the device during the scan or test run. Live View displays dynamically generated screenshots in a pop-up window to give you a preview of what is happening on the device. It also allows you to interact with the device during the scan.

OSVersion

Mobile

Add this parameter in the following situations:

  • If you automate a local or remote iOS simulator.

  • If you don't want to provide the exact ID of your Android device, but you want to trigger test automation on a specific version of Android. In this case, enter the version of your Android operating system. Tosca Cloud automatically runs the tests on a device that matches this parameter.

TapByCoordinates

Mobile

Add this parameter if you want to simulate a tap on a control for which you specified a {CLICK} action.

Use this parameter as a fall-back mechanism if you experience steering issues related to the {CLICK} action.

ScrollToVisible

Mobile

Add this parameter and set its value to True, if you want Tricentis Tosca Cloud to automatically scroll and steer an element that's not visible.

UseXBrowserForMobile

Mobile

Add this parameter if you want to use the web automation technology instead of Mobile.

Fibermode

Web automation

Improve test run time.

FocusOnActivate

Web automation

Prevent the user-simulated keyboard from failing.

HostEnableHeadlessExecution

HOST

Enable headless test runs.

HostName

HOST

IP address of your HOST.

HostPort

HOST

Port of your HOST. The default value is 23.

HostTimeout

HOST

Sets the maximum time allowed for any communication between Tosca Cloud and HOST server to occur. The default value is 40000 milliseconds.

HubAddress

Web automation

IP address of the grid hub where you want to run the test case.

IgnoreAriaControls

Web automation

Ignore ARIA elements during test runs. To enable it, set the value to True.

IgnoreInvisibleTableContent

All

Specifies whether invisible table contents are ignored during test runs. To enable it, set the value to True.

IgnoreWhitespace

All

Specifies whether to ignore whitespaces in strings.

Possible values: None, Leading only, Trailing only, Leading and trailing.

MouseDelay

All

Speed of the cursor for mouse operations in HTML applications. Possible values are between 0 and 100.

MouseoverOffsetXAxis

All

Distance in percent between the left window side and the cursor. By default, the cursor is placed into the center of the window.

MouseoverOffsetYAxis

All

Distance between the upper window side and the cursor. By default, the cursor is placed into the center of the window.

MoveMouseOverApplication

All

Specifies whether the mouse pointer should hover over the application window before checking the cursor's state. To enable it, set the value to True.

OnDialogFailure

All

Specifies what Tricentis Tosca Cloud should do if the interaction between Tricentis Tosca Cloud and the system under test fails.

OnExceptionFailure

All

Specifies what Tricentis Tosca Cloud should do when an exception occurs.

Onlydefaultcomponents

All

Only the default components of Tosca Cloud are used at runtime. Any individual customizations aren't taken into account.

OnVerificationFailure

All

Specifies what Tricentis Tosca Cloud should do if the value provided by the system under test doesn't match the specified test value.

Operating System

Web automation

Operating system on which you want to run the test case.

PageSync

All

Discontinue a test run until all AJAX requests of the browser have been processed. To enable it, set the value to True.

PreventUIAChildrenRecursion

UIA

Specifies whether to check for infinite loops when navigating through the hierarchical structure of UI elements:

  • If set to True, Tosca Cloud runs an additional check to prevent recursion. We recommend that you use this value if you encounter issues with infinite recursions.

  • If set to False, Tosca Cloud doesn't run this check, which speeds up your test runs. This is the default value.

ReportSuccessfulExecutionOf

All

Define the level on which Tosca Cloud logs test results: 

  • TestSteps: log details on the test step level if the test step passes, fails, or is paused.

  • TestStepValues - All: log details on the test step value level if the test step either passes, fails, or is paused.

  • TestStepValues - Verify only: works only with test step values whose action mode is Verify. Tosca Cloud logs details on the test step value level if the test step passes, fails, or is paused. Note that if a test step fails, Tosca Cloud logs the results even if the action mode isn't Verify.

  • TestCases: logs details until the test case level if the test case passes. If the test case fails or is paused, Tosca Cloud logs the details on the test step value level for the failed or paused test step, along with the details on the test step value level for all passed test steps before the failed or paused one.

RunAccessibilityAnalysis

Web automation

Define what kind of accessibility tests you want to add to your regression tests.

Possible values:

  • After Inputs: Runs an accessibility analysis after each test step with action mode Input, alongside your existing regression tests. For example, to analyze the new UI state after your inputs.

  • Before Inputs: Runs an accessibility analysis before each test step with action mode Input, alongside your existing regression tests.

Please note: Adding analyses to large test sets may increase test execution time.

ScreenFlow

Web automation, Mobile

Generates screenshots of all test step values that use the action mode Input.

ScreenFlowPath

Web automation, Mobile

Directory where you want Tosca Cloud to save the screenshots.

ScrollingBehavior

All

Define where the control should be positioned on the screen in order to steer it: Top, Bottom, Center (standard), None.

Selfhealing

All

Enables self-healing for a test case.

Possible values: Weighted, Combination.

SelfHealingWeightThreshold

All

Limits the amount of algorithm combinations to find a suitable control. The default value is 0.75.

SendKeysDelay

All

Specifies a delay in milliseconds.

IgnoreInvisibleHtmlElements

Salesforce

Specifies whether HTML elements are ignored during test runs. To enable it, set the value to True.

Add this parameter to your Salesforce test cases or playlists if you want to steer only visible controls in your Salesforce application.

OptimizeForSalesforce

Salesforce

Decrease test execution time. The default value is True.

SFDC_CPQ

Salesforce

Enable or disable adapters that uniquely identify CPQ objects for CPQ automation. Choose one of the following values:

  • True: enable loading of CPQ .dll.

  • False: disable loading of CPQ .dll.

  • Auto (default): Tosca Cloud automatically identifies objects as CPQ or not.

SFDCConsumerKey

Salesforce

Client ID of the application trying to connect to Salesforce APIs.

SFDCConsumerSecret

Salesforce

Client secret for authentication.

SFDCCustomDomain

Salesforce

Custom domain of the application.

SFDCPassword

Salesforce

Password to sign in to Salesforce.

SFDCQuickSearch

Salesforce

Boost control identification speed, improving overall test execution performance. The default value is True.

SFDCUsername

Salesforce

Username to sign in to Salesforce.

SfTimeoutForElementLoading

Salesforce

Specify the maximum time Tosca Cloud waits for a Salesforce element to load before performing any actions.

SAPTimeout

SAP

Time (in seconds) to wait for SAP to respond.

SynchronizationTimeout

All

Specify how long (in milliseconds) Tosca Cloud should wait for any control. The default value is 10000.

SynchronizationTimeoutDuringWaitOn

All

Specify how long (in milliseconds) Tosca Cloud should wait for verifications with WaitOn. The default value is 20000.

SyncStateInteractive

All

Run tests on a web application with the loading status interactive. To enable it, set the value to True.

TargetDateFormat

All

Date format that your application accepts and uses. You may need to define this when you create date and time values.

The default value is dd.MM.yyyy.

You can also enter .NET date format strings. For information on .NET formats, check out the Microsoft documentation: standard formats (opens in new tab) and custom formats (opens in new tab).

TargetDateTimeFormat

All

Date/time format that your application accepts and uses. You may need to define this when you create date and time values.

The default value is yyyyMMddHHmmss.

You can also enter .NET date/time format strings. For information on .NET formats, check out the Microsoft documentation: standard formats (opens in new tab) and custom formats (opens in new tab).

TargetDecimalCharacter

All

Your application's decimal character.

TargetGroupingCharacter

All

Your application's grouping character.

TargetTimeFormat

All

Time format that your application accepts and uses. You may need to define this when you create date and time values.

The default value is HH:mm.

You can also enter .NET time format strings. For information on .NET formats, check out the Microsoft documentation: standard formats (opens in new tab) and custom formats (opens in new tab).

TBox_Logging_ReportSuccessfulExecutionof

All

Level of detail of test run log results. The default value is TestStepValuesAll.

Possible values: TestCases, TestSteps, TestStepValuesVerification, TestStepValuesAll.

TestCaseRetries

All

Maximum number of recovery attempts for a test case.

ToscaDateFormat

All

Date value format in Tosca Cloud, which you might need for date and time expressions.

ToscaDateTimeFormat

All

Combined date-time value format in Tosca Cloud.

ToscaDecimalCharacter

All

Decimal character in Tosca Cloud.

ToscaGroupingCharacter

All

Grouping character in Tosca Cloud.

ToscaTimeFormat

All

Time value format in Tosca Cloud.

UIAFasterLists

UIA

Steers large listboxes and comboboxes faster during test runs. To enable it, set the value to True.

UseKeyboardLayout

All

This parameter is important if you want to use keyboard commands on virtual machines or Citrix systems, but SendKeys or Textinput commands don't work. To enable it, set the value to True.

UserSimulation

All

Enables to trigger click events or keyboard commands with the Input action. To enable it, set the value to True.

Possible events:

  • Selecting or deselecting checkboxes and radio buttons

  • Pressing push buttons

  • Selecting links

  • Entering text into text boxes

WaitingForCursor

All

Specifies whether Tosca Cloud should check the cursor's state before running test steps. To enable it, set the value to True.

WebDriver_<CapabilityName>

Web automation

Specifies WebDriver capabilities for remote tests.

Name syntax:

  • Replace <CapabilityName> with a WebDriver capability.

  • Replace any periods in the capability name with two underscores.

  • Replace any colons in the capability name with three underscores.

For example: WebDriver_Example__name___1 for the Example.name:1 capability.

For information on WebDriver or BrowserStack capabilities and their values, check out the WebDriver documentation (opens in new tab) or the BrowserStack documentation (opens in new tab).

WebDriverJson_<ProviderOptionsTag>

Web automation

Specifies cloud provider specific capabilities for remote tests.

Name syntax:

  • Replace <ProviderOptionsTag> with the options tag of your cloud provider.

  • Replace any periods in the capability name with two underscores.

  • Replace any colons in the capability name with three underscores.

For example: WebDriverJson_bstack___options for BrowserStack's bstack:options tag.

The value of this parameter must be a JSON string that can contain multiple capabilities and uses the following syntax:

  • Curly brackets to open and close strings.

  • Semicolons to define a capability's specific value.

  • Commas to separate the capabilities.

  • Double quotation marks to escape special characters.

  • Our value expressions for any other specifications.

For example: "{""userName"": ""<UserName>"", ""accessKey"": ""<accessKey>"", ""browserVersion"": ""136"", os"": ""OS X"", ""osVersion"": ""Monterey"", ""acceptInsecureCerts"": true, ""timeouts"": {""implicit"": 10000, ""pageLoad"": 30000}}"

For information on their options tag, capability names, and capabilities' specific values, check out your cloud provider documentation.

WebDriverProxyAddress

Web automation

IP address of the proxy server on which you want to run the test case.

WebDriverProxyPassword

Web automation

Password to authenticate with the proxy server.

WebDriverProxyUsername

Web automation

User name to authenticate with the proxy server.

WebDriverUserProfilePreference_<PreferenceName>

Web automation

Applies browser-specific user profile preferences to WebDriver remote tests for Chrome, Edge, or Firefox.

Name syntax:

  • Replace <PreferenceName> with a browser preference.

  • Replace any periods in the capability name with two underscores.

  • Replace any colons in the capability name with three underscores.

For example: WebDriverUserProfilePreference_Preference__name___1 for the preference Preference.name:1.

For more information on preferences and their values, check out your web browser documentation.

WebserviceEngineLogRequestResponse

API

Requests and Responses can be saved as an HTTP message in a text file to search for errors (logging). This requires the parameter WebserviceEngineLogRequestResponse to be defined.

WebserviceEngineResponseTimeout

API

Sets the response timeout locally.