Ranorex Help Center

How can we help you?

Settings Overview

General Settings


General Ranorex settings

General Ranorex settings



'Use Ensure Visible by default'

Specifies whether a UI element used as Ranorex adapter should be forced to become visible before automation or not. By default this value is automatically used for each repository item.

'Enable search by unique ID (if available)'

Specifies whether web elements should be identified using their unique id or not.

'On mouse/pointer move check if location is within visible desktop bounds'

Specifies whether an exception should be thrown if the mouse/pointer tries to move outside the visible desktop bounds or not.

'Maximum length of text values in RanoreXPaths'

Specifies the maximum length of attribute values used within RanoreXPath.

'The factor that all timeouts of find operations are multiplied with'

Multiplies all repository timeouts with the specified value to prevent test cases from failing in case of different timing behavior. This is especially useful when executing tests on different system configurations.

Note The value can also be set at the time of executing a test suite using the test suite's command line arguments or by directly using the 'Ranorex.Core.Configuration.Current.Adapter.TimeoutFactor' property in code.


'Restore all ignored technology specific limitation warnings'

Resets the 'Do not show again' checkboxes used to suppress the assistance dialog for technology limitations. Click 'Restore Limitation Warnings' to show the dialog again for not instrumented technologies or applications.

'Restore all ignored dialogs ("Do not show again")'

Resets all other 'Do not show again' checkboxes.

'GDI Capture Settings...'

Opens the dialog to change the current GDI capture list. More information about the Ranorex GDI plug-In can be found at Testing of Legacy Applications.

'Mobile Devices...'

Opens the 'Manage Devices' dialog as described in the sections 'iOS Testing' and 'Android Testing'.

Note Click the button 'Restore Defaults' to reset all values to their default values. Use the 'Import...' and 'Export...' buttons to save and load user-specific configurations.



Advanced Settings

Advanced Ranorex settings

Advanced Ranorex settings



Most of the settings shown in the 'Advanced' tab are used to configure Ranorex object recognition and RanoreXPath generation. Please be careful when changing these settings.

'Enable 32/64 Bit Bridge'

Use the checkbox 'Enable 32/64 Bit Bridge' to turn off the bit bridge required to handle 32/64 bit based applications on 64 bit operating systems automatically.

'Use hidden screenshot capturing (if possible)'

Tries to capture screenshots used by recordings, repositories or Ranorex snapshot files, even from application windows which are not in the foreground. If disabled, Ranorex tries to make the application window visible before capturing a screenshot.

'Let snapshot contain complete ancestor subtree'

When checked, the subtree containing the whole application will be stored when saving a snapshot file. If not checked, only the direct subtree to the selected item will be stored.

'Use asynchronous dispatching of mouse and keyboard events'

This setting is used to turn on or off asynchronous dispatching of mouse and keyboard events during recording. With enabled asynchronous dispatching mouse and keyboard events will not be forwarded to an application before Ranorex has finished processing the event.

'Disable expensive attribute in tools'

This setting instructs plug-ins not to evaluate computationally intensive attributes for Ranorex Spy, Recorder, and Ranorex Studio. If checked, attributes like Row.Index do not have a value for certain technologies when shown in Ranorex Spy. This improves performance is some cases.

'Use UiaLauncher to elevate privileges for processes started by tools'

Specifies whether test execution is started with elevated privileges or not.

'Synchronize element selection of Studio's repository with element selection in Spy'

Specifies whether a UI element will be automatically selected in Ranorex Spy when the representing repository item will be selected or not.

'Delay before pressing a key sequence (ms)'

Specifies the time to wait in milliseconds before performing a key sequence simulation.

'RanoreXPath generation mode:'

Defines how RanoreXPaths will be built during recording actions or tracking elements using the Ranorex tools (by default, the mode 'StepCostReduce' is selected).

StepCostReduce

Reduces the number of path predicates such that the path remains non-ambiguous. In addition to that, removes intermediate steps considered as unimportant. Can be heavily tuned using the RxPath.PathBuildMode settings. This usually shortens the path and makes it more robust by eliminating unnecessary attributes.

Reduce

Reduces the number of path predicates such that the path remains non-ambiguous. This usually shortens the path and makes it more robust by eliminating unnecessary attributes.

Simple

No optimization is performed. Path predicates contain valid, appropriate and existing attribute values or indexes if no attributes can be used.

'Edit Path Weights...'

In order to get assistance with editing RanoreXPath weights, have a look at the blog post Automated Testing and Dynamic IDs. Please also have a look at our RanoreXPath Weight Rule Library for the latest RanoreXPath Weight Rules.

'Edit Path Build Options'

Specifies the parameters for 'StepCostReduce' RanoreXPath generation mode.

Recorder Settings

The description of the settings regarding the Ranorex Recorder can be found in the Recorder Settings Dialog section in Lesson 5: Ranorex Recorder.

Repository Settings

The description of the settings regarding the Ranorex Repository can be found in the Repository Settings Dialog section in Lesson 6: UI Mapping with Ranorex Repository.

Imaging Settings

The Imaging settings are explained in the section  Image-Based Automation in  Lesson 5: Ranorex Recorder.

Plugin Specific Settings

Plugin specific user settings

Plugin specific user settings



Plugin specific solution settings

Plugin specific solution settings



Plugin specific settings can be used to alter the behavior of individual Ranorex plugins, for example, to achieve backwards compatibility with older versions.

CEF

Process name black list

This list contains process names (without the file extension) which should be ignored by the CEF plugin. If a process should be ignored by the CEF plugin, add it to the list in a new line.

Java

Enable filtering on the Fx scenegraph

Filters dummy and intermediate containers out of the Fx scenegraph.

Show SWT custom data properties

Includes SWT custom Widget Data values as dynamic properties.

Use Java SWT legacy automation mode

Enable Java SWT legacy automation mode using MSAA and Win32

Whitelisted class names

Adds additional whitelisted class names (comma separated) for java object recognition.

Mobile

Android OS Automation

Enables automation on Android OS screens. Disable to increase performance.

Auto reconnect attempts

When the connection to a device is lost Ranorex tries to reconnect automatically. With this parameter you can specify how many reconnect attempts should be made until the device will be set to the 'Error' state. If you don't want to reconnect automatically, set this parameter to 0.

Connect timeout

After this time span the connection attempt will be aborted if the device is not reachable.

Deploy timeout

Sets the timeout for deploying an mobile app. The required time depends on your application size and the deploy method. Deploying an app takes longer when deploying via network.

Devices

This is used internally by the Ranorex system and is not user editable.

General timeout

The timeout for short running background processes. This timeout is used for very short running processes (less than 10 seconds in general). If you get a lot of timeout exceptions, that do not occur during special operations like instrumentation or deploying, try to increase this value.

Group devices by

Determines how devices are grouped in dialog.

Instrument timeout

Sets the timeout for instrumentation operations. A good initial value is 2 minutes. For very large applications the time required for instrumentation can take up to 10 minutes depending on the machine power.

iOS: Maximum number of invisible children

-1 will fetch all cells of UITable and UICollection views. Use this setting only, when all views have a relatively small number of cells and static/finite data sources. 0 will disable fetching of invisible cells. Generally you should use this setting, when data in your tables is loaded dynamically e.g. from successive web requests. # (e.g. 50) will fetch all visible cells and the first 50 cells surrounding the visible cells area.

Java Runtime installation path.

The path of the currently used Java Runtime Environment (JRE) installation required for Android automation.

Network discovery timeout

Specifies for how long Ranorex sends UDP broadcasts to find devices that can be used for automation. Normally, a device should respond within a few seconds.

Prompt on IP - address change

If set to true, Ranorex will try to check if the IP-address of a device has changed since the last usage and will show a message if so. By setting this parameter to false you can disable this check.

Remote call timeout

The time Ranorex waits for a remote procedure call response until it assumes a connection loss if no response was received.

Screenshots on AndroidOS

Captures screenshots on AndroidOS screens. Disable to improve test execution performance.

Sort devices by

Determines how devices are sorted in dialog.

USB discovery timeout

The timeout for discovering USB connected devices.

MSAA

Evaluate computationally expensive attributes

Setting this value to true will instruct the plugin to evaluate attributes that are expensive to compute and may result in longer delays when getting such attributes. Note that spying an element with such expensive attributes may then take considerable time.

Filter elements

Setting this value to false will make all MSAA elements available without filtering, including elements being unavailable, invisible, or equivalent to elements of other flavors.

Filter Windows Forms elements

Setting this value to false will make MSAA elements available that are direct children of Windows Forms elements and have the same role and screen rectangle as the parent element.

Filtering compatibility level

If you need legacy RanoreXPaths (created with an older Ranorex version) to work with the current Ranorex version, set this property to the appropriate value matching the Ranorex version used to create the legacy RanoreXPaths.

Refine FromPoint results

Setting this value to true results in an additional search operation for a better fitting element for every MSAA FromPoint operation (e.g. used by Element.FindFromPoint). This may produce better results if the MSAA FromPoint implementation of a control is broken.

Qt

Enable filtering on the QtQuick scenegraph

Enables filtering the QtQuick scenegraph by skipping or removing unnecessary layout, loader and style items.

Use QT legacy automation mode

Enable Qt legacy automation mode using MSAA and Qt Accessibility.

UIA

Enable debugging mode for Windows apps

If set to true, the debugging mode for Windows apps will be enabled, causing them to not be suspended until the logon session is closed (user logout). When set to false, the plugin will instead try to resume suspended apps when it needs to access them (possible race condition may cause freeze until app is manually resumed).

Enable filtering of Windows app frames

If set to true, the frames of Windows apps introduced with Windows 10 are filtered and all relevant elements of those frames are displayed as child of the app element. This allows for transparent automation of Windows apps in windowed and full-screen mode.

Enumerate lists using the ItemContainerPattern

Setting this value to true instructs the plugin to use the ItemContainerPattern to iterate items of virtual lists that implement this UI Automation pattern. Depending on the implementation of the control, iterating children using this pattern should also return items that are currently scrolled out of view, but might also be slower than the usual way to get child elements. Note that switching this setting can render existing RanoreXPaths invalid for controls implementing the ItemContainerPattern.

Evaluate computationally expensive attributes

Setting this value to true will instruct the plugin to evaluate attributes that are expensive to compute and may result in longer delays when getting such attributes. Note that spying an element with such expensive attributes may then take considerable time.

Force virtual items to be realized

Forces virtual items to be realized when trying to get their child elements. Setting this value to true will allow to search lists with virtual items, but realizing may have undesired effects on the list depending on the list implementation, e.g. that the list is scrolled to make the realized item visible.

Provide elements for non-WPF windows natively implementing UIA

Setting this value to true instructs the plugin to provide elements also for non-WPF windows which natively implement the UIA interface.

Web

Enable automation of embedded IE web documents

Enable automation of Internet Explorer web documents embedded in other applications.

WebDriver

Attach to open sessions

Attach to existing WebDriver sessions to analyze and debug tests. Not recommended for high-latency environments. If setting is disabled, tests/debug runs have to include an 'Open Browser' Action.

Browser Tab Automation

Enable automation of multiple tabs in a browser. Not recommended for high-latency environments.

DOM fetch mode

Can be set to 'Always' or 'WhenChanged'. Always: DOM will be updated in specific intervals. WhenChanged: Before DOM is fetched a call to check for changes is done. Only after DOM changes are detected, the whole DOM is pulled from the remote. This setting preserves bandwidth.

DOM update interval

Timespan of the interval to update the DOM.

Screenshot update interval

Timespan of the interval to update the screenshots.

Update screenshots after dom change

Update screenshots after DOM changing operations (e.g. mouse clicks). Not recommended for high-latency environments.

WebDriver Command Timeout

Maximum wait duration for a web driver command to return a result. If the call takes longer a timeout exception will be thrown and may set the endpoint into the error state. This parameter does only take effect after a program restart.

Win32

Enable accessibility (MSAA) actions and attributes

Specifies whether Win32 elements provide accessibility (MSAA) actions and attributes (as Dynamic capability).

Enable basic Delphi support

Enables support for basic Delphi controls such as textboxes, buttons, etc. Set to False for backwards compatibility.

Use legacy Form role

Enables 2.X legacy mode where many elements improperly had the Form role. Set to True for backwards compatibility with 2.X paths.

WPF


Note We've introduced an improved WPF plugin with Ranorex 7.0.

Allow selected instance properties

Extend the dynamic attribute list with entries for plain .NET properties. Each line specifies a full-type name and the attribute name, separated by a pipe, like: Ranorex.ExampleType|IsAvailable

Disable WPF plug-in for processes

Do not use the native WPF plug-in for any process specified in the list; keep using UIAutomation for WPF as in Ranorex version up to 5.2.

Enable WpfDebug capability

Enable the WpfDebug capability for all WPF elements. This capability provides attributes and dynamic actions that are useful for analyzing issue in the element tree.

Ignore Attributes starting with

Reduce clutter in the list of dynamic attributes.

Realize Items in Virtualizing Containers

Many WPF containers only show children which are also visible on the screen; to show all child-items, set this option to true. By default this is false, as the performance impact for large grids can be very high.

Show All Elements

Show the complete element tree, incorporating all visual and logical WPF elements. This option disables any other filtering, and is useful for analyzing the structure of WPF applications when elements cannot be accessed.

WPF Legacy/UIA Interaction

Set to 'UiaOnly' to completely deactivate this plug-in, making all other settings obsolete. WpfOnly: Show only the native WPF plug-in tree, suppress UIA. WpfPreferred: Show both WPF and UIA tree, and return WPF elements for tracking. UiaPreferred: Show both WPF and UIA tree, and return UIA elements for tracking. UiaOnly: Do not use the native WPF plug-in at all, and keep using UIAutomation for WPF as in Ranorex versions up to 5.2. WpfImprovedOnly: Show only the improved native WPF plug-in tree, suppress UIA.

WPF Tree

Always Show Visual Children

Always show the visual children for specific types, even if those type do also have one or more logical children. Enables accessing elements that are not part of the logical WPF element tree, like data-binding generated elements for well-known types. Example: "CurrentType|ParentType|ApparentParentType" Each entry is a pipe (the | character) separated tuple of type-names for (current, parent, apparent-parent) elements. An empty field denotes match-all, e.g. "FrameworkElement||" matches for all parent and apparent-parent elements.

Never Show Visual Children

Do not show the visual children for matching elements, even if those types do not have any logical children. Reduces unnecessary element tree branched. Example: "CurrentType|ParentType|ApparentParentType" Each entry is a pipe (the | character) separated tuple of type-names for (current, parent, apparent-parent) elements. An empty field denotes match-all, e.g. "FrameworkElement||" matches for all parent and apparent-parent elements.

Skip Elements

Neither show nor traverse elements for specific types. Reduces the size of the element tree by hiding types not used in UI testing. Example: "CurrentType|ParentType|ApparentParentType" Each entry is a pipe (the | character) separated tuple of type-names for (current, parent, apparent-parent) elements. An empty field denotes match-all, e.g. "FrameworkElement||" matches for all parent and apparent-parent elements.

Skip Elements but Descend to Children

Reduce the hierarchy levels by always hiding redundant elements, and instead continuing the tree with its children. By default this skips over some common nested containers constructs. Example: "CurrentType|ParentType|ApparentParentType" Each entry is a pipe (the | character) separated tuple of type-names for (current, parent, apparent-parent) elements. An empty field denotes match-all, e.g. "FrameworkElement||" matches for all parent and apparent-parent elements.

Skip Elements but Descend to Single Child

Reduce the hierarchy levels by hiding redundant containers, if they have none or only one child element. By default this hides some layout-containers. Containers will be shown if they contain at least two children. Example: "CurrentType|ParentType|ApparentParentType" Each entry is a pipe (the | character) separated tuple of type-names for (current, parent, apparent-parent) elements. An empty field denotes match-all, e.g. "FrameworkElement||" matches for all parent and apparent-parent elements.