Ranorex Recorder settings | Ranorex
Help CenterUser GuideRanorex Studio system details

Ranorex Recorder settings

The purpose of this chapter is to introduce and explain the various options for setting and configuring Ranorex Recorder.

In this chapter

    General settings

    General settings are the ones which can be accessed by selecting the ‘General‘ register tab in the settings dialog window.

    Ranorex General settings - part I

    Ranorex General settings – part I

    Use ‘ensure visible’ by default: Specifies whether a UI-element used as Ranorex role 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 icon

    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.
    Ranorex General settings - part II

    Ranorex General settings – part II

    Restore limitation warnings: Resets the ‘Do not show again’ checkboxes used to suppress the assistance dialog for technology limitations. Click to show the dialog again for non-instrumented technologies or applications
    Restore ignored dialogs: Resets all other ‘Do not show again’ checkboxes
    GDI capture settings…: Opens the dialog to change the current GDI capture list

    Further reading

    The GDI capture feature of Ranorex is introduced and explained in detail in > Ranorex Studio advanced > Ranorex Spy > ⇢ GDI capture feature.

    Copy runtime to output: If checked, copies the Ranorex Studio runtime to the output folder when compiling/running a test

    Include license information: Click to include the local machine’s floating license information with the test. For this to work, you must have a solution opened and a floating license configured on the local machine.

    Ranorex General settings - part III

    Ranorex General settings – part III

    Restore defaults: to reset all values to their default values
    Import…/Export…: to save and load user-specific configurations
    Apply: is necessary to make changes valid

    Recorder settings overview

    Recorder settings can be accessed through the settings dialog. Depending on from where the dialog is opened, different options are available. If you open the settings from within the Studio Recorder view (SETTINGS button in action table), the configuration options for the current recording are available in addition to the recorder default settings.

    Recorder settings overview

    Recorder settings overview

    Current recording: This tab primarily contains configuration parameters for code generation specific to the current recording. All settings on this tab page are stored within the recording.
    Recorder defaults: In this tab global default values for every newly created recording are specified.
    tipp icon

    Hint

    The settings tab page for Current recording can only be accessed from the SETTINGS button within a recording.

    Recorder default settings

    In this tab, you can specify global default values for every newly created recording. The settings are divided into three sections:

    Recording

    Recorder default settings - part I

    Recorder default settings – part I

    Capture a screenshot for each step: Specifies whether a screenshot of the current action should be made during the recording.
    Highlight elements: Specifies whether element highlighting during recording should be enabled.
    Coordinate recording mode: Specifies the way coordinates will be recorded. Following options are available:
    None: Actions will always be invoked on the ‘center’ of the recognized elements
    Pixel: Relative coordinates within a recognized element are recorded in pixels
    Proportional: Relative coordinates within a recognized element are recorded in percent

    Timings for new actions

    Note icon

    Note

    Please note that the following settings only affect newly created actions, not existing actions.

    Recorder default settings - part II

    Recorder default settings – part II

    Use timings also for recorded actions: When enabled, the specified timings below will be taken instead of the recorded durations.
    Use keystroke optimization: Enabled by default. This setting makes recorded key sequences easier to read. Only applies to characters of the English alphabet, i.e. A–Z. Can also be enabled/disabled in the keystroke editor of an action.
    Disabled Enabled
    {LShiftKey down} h {LShiftKey up} H
    {CAPITAL} hello HELLO
    helll {Back} o hello
    hello {Space} there hello there
    Key sequence split time (ms): Use this setting to specify the maximum time between key presses in a key sequence during recording. If this time is exceeded, the sequence is split into multiple key sequences.
    Mouse move time per action (ms): Specifies the time in milliseconds used to move the mouse to the UI object related to the action.
    Mouse/Pointer-related action time (ms): Specifies the overall time in milliseconds used for a manually created mouse action. The value set for this setting is only taken into account for manually created actions, when the time of an action cannot be determined during recording or when ‘Use timings also for recorded actions’ is activated.
    Keyboard-related action time (ms): Specifies the default overall time in milliseconds used for a manually created keyboard action. The value set for this setting is only taken into account for manually created actions, when the time of an action cannot be determined during recording or when ‘Use timings also for recorded actions’ is activated.

    Code generation

    Recorder default settings - part III

    Recorder default settings – part III

    Recording namespace: Specifies the namespace used for the generated code.
    Recording class name: Specifies the class name used for the generated code.
    Use item logging by default: Activate this setting to turn on a default logging message for each action item.
    Generate replay reports: This setting is used to turn the generation of reports during replay on or off.
    Show warnings for possible invalid property values: Option to turn invalid property warnings on/off.

    Current recording setting

    This tab primarily contains configuration parameters for code generation specific to the current recording. All settings on this tab page are stored within the corresponding recording.

    Current recording setting - part I

    Current recording setting – part I

    Description: Can be used to briefly describe the actions the recording performs.
    Recording namespace: Specifies the namespace used for the generated code.
    Recording class name: Specifies the class name used for the generated code.
    Replay speed factor (%): The speed factor is used to increase or decrease the replay overall speed by a specific factor value.
    Replay iteration count: The repeat count is used to specify the number of iterations.
    Recorder UI mode: By specifying the recorder UI mode the set of actions available in the actions table will be adapted (“Global”: all actions, “Desktop & Web”: no mobile actions, “Mobile”: no mouse and keyboard actions).
    Current recording setting - part II

    Current recording setting – part II

    Enable turbo mode for replay and generated code: Is used to specify whether recorded delays between actions should be part of the generated code.
    Generate replay reports: This setting is used to turn the generation of reports during replay on and off.
    Use item logging by default: Activate this setting to turn on a default logging message for each action item.