Special module parameters

In addition to the general properties, modules and module attributed have special parameters that are relevant for interacting with controls. We distinguish between configuration, identification, steering, and transition parameters. This topic provides an overview of all available parameters, and their meaning.

To view module properties, go to Inventory > Modules and select a module in the Properties pane on the right side of the window.

To add a special parameter, select the Add icon in the respective parameter section.

Configuration parameters

Configuration parameters specify the components the system uses to steer controls.

Parameter

Description

Valid values for example

AlgorithmicAssociation

The search algorithm uses this specific parameter in the selected context to find target objects according to the logic of the algorithmic query.

  • Items

  • Columns

  • Rows

  • Cells

  • engine-specific

BusinessAssociation

Tosca Cloud creates this parameter automatically during scanning with Tosca XScan to provide steering information for the automation layer.

 

ConstraintIndex

Specifies the index that uniquely identifies a control during a test run.

  • <integer>

Engine (mandatory)

ID of the technology.

Customized extensions can assign IDs.

This corresponds to the assembly tag EngineId.

  • Html

  • Xml

  • Framework

  • File

ExplicitName

By default, you can't change the names of test step values. However, if you set the value of this property to true, you can edit the name of the referenced test step value. Instead of using true, you can also specify multiple values, separated from each other by semicolons. These values can be selected in the corresponding test step value.

  • true

  • false

  • <value range>

Extension

Specify an extension ID as a value of this parameter to use the steering routines of the respective library.

This corresponds to the assembly tag ExtensionId.

customized values

Parameter

Parameters used for the steering layer.

  • true

  • false

SpecialExecutionTask

You can perform specific tasks with this parameter, for instance, opening xml files.

Examples:

  • ValidateXsd

  • SaveXmlFile

TechnicalAssociation

Specific parameter for the search algorithm in the selected context.

Uses the property of a test object directly as the context when searching for an object.

engine-specific

Identification parameters

Identification parameters are important to locate the control that you want to steer. You can combine any number of parameters by using AND-links.

Property

Description

Valid values for example

BusinessID Parameter

Use this parameter to identify specific control types. These are the same for all technologies you want to steer.

Each button has the property Label, and each textbox the property Text.

ReflectedID Parameter

Tosca Cloud uses reflected parameters to identify controls when standard methods don't work. This approach relies on the application's internal structure and only works if the application allows access to these details.

To manage reflected parameters select More > Load all in the Identify by Properties pane of Tosca XScan.

A search or identification with Reflected IDs is generally slower because much more information from the target processes must be processed.

Using Reflected IDs in web automation may limit functionality due to differences in browser vendors' object models.

baseUri, autofocus, etc.

TechnicalID Parameter

A Technical ID is a property that Tosca Cloud provides for technology-specific controls.

value for HTML input elements, InnerText for all HTML elements, Encoding for an XML declaration, etc.

Steering parameters

Steering parameters define how a control behaves during test runs, ensuring precise and reliable interactions.

Property

Description

valid values for example

AllowedAriaControls

Specify the ARIA elements you want Tosca Cloud to interact with during test runs.

Tosca Cloud automatically adds the steering parameter AllowedAriaControls to new modules and sets its value, based on the configuration of the IgnoreAriaControls setting.

A list of controls, separated by colon or semicolon. For example, combobox; link, listbox.

BringToFront

You can define this parameter on the module level. By default, windows are automatically brought to the foreground during test runs. Set it to False to disable this behavior.

Default value = True

HeaderColumn

Defines the column in which the system searches for the row name in a table.

Default value = 1

HeaderRow

Defines the row where the system searches for the column name in a table.

Default value = 1

IgnoreAriaControls

Specify if you want Tosca Cloud to ignore all or specific ARIA elements during test runs.

We recommend that you use the AllowedAriaControls parameter to specify which ARIA elements Tosca Cloud ignores, to ensure the functionality of your modules as we extend ARIA support.

  • True

  • False

  • List of controls, separated by colon or semicolon. For example, combobox; link; listbox.

IgnoreInvisibleHtmlElements

Specify if you want Tosca Cloud to ignore invisible HTML elements during test runs.

We recommend to set this to True if you have performance issues in pages with several invisible HTML elements.

  • True

  • False

IgnoreInvisibleTableContent

By default, Tosca XScan includes invisible table contents during scanning or table steering. Set this value to true to ignore them.

  • true

  • false (default)

LoadStrategy

You can set this parameter at the table module attribute level. Setting it to IgnoreSpans improves the table loading performance.

 

Default value for Database and SAP = IgnoreSpans

Default value for all other technologies = Default

ScrollingBehavior

Determines where on the screen the control should be positioned to steer it.

Use this function, for example, when the header of a page overlaps the control you want to steer.

  • Top

  • Bottom

  • Center (standard)

  • None

SendKeysDelay

Specifies the delay in milliseconds between sending each character of a keyboard command.

Example: 100

SiebelBusyCheck

Prevents the system from checking whether a Siebel page is busy. To disable the check, set the value to false.

  • true

  • false

SynchronizationTimeout

Specify in milliseconds how long Tosca Cloud should wait for the test object to reach its expected state.

  • <time in ms>

  • 1000

SynchronizationTimeoutDuringWaitOn

Specify in milliseconds how long Tosca Cloud should wait for the test object to reach its expected state.

This setting is specifically for test steps with action mode WaitOn.

  • <time in ms>

  • 1000

UIAFasterLists

(for UIA technology only)

Use this parameter to steers large listboxes and comboboxes during test runs.

  • true

  • false (default)

UseDivCenterScrolling

Specify if you want to scroll the control to the center of the viewport, before automatically selecting it.

This is useful for scrollable elements that aren't a document.

  • true

  • false (default)

UseWildcards

Specify whether or not you want to use the * wildcard character to delete buffers with the TBox Delete Buffer module.

If you don't use this parameter, or set it to false, Tosca Cloud sees the * as a normal character instead of a wildcard.

  • true

  • false

UserSimulation

Triggers click events or keyboard commands with the action mode Input. 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

  • true

  • false (default)

If this property is set to true, the system allows inputs, such as clicking a push button.

WaitAfter

Specifies the time in milliseconds to wait after the control has been steered.

Default value = 0

WaitBefore

Specifies the time in milliseconds to wait before a control is steered.

Default value = 0

WaitIntermediate (for JavaFX technology only)

Use this parameter to set the wait time in milliseconds for scrolling in tables.

Default value = 130