Ranorex Studio Settings and configuration
Help CenterUser GuideRanorex Studio system details

Settings & configuration

This chapter introduces and explains the various options for setting and configuring Ranorex Studio and its tools.

In this chapter

    Machine-stored settings

    If you access settings from a Ranorex tool without a solution associated with it, the settings are stored on the machine in a Ranorex internal file structure.

    Machine-stored settings

    Machine-stored settings

    How to access machine-stored settings:

    Click the SETTINGS button from stand-alone Spy

    Click the settings button from Ranorex Studio start page (with no solution opened)

    Click stand-alone Ranorex Settings program from Windows start menu

    Settings dialog:

    See the settings title with no solution associated

    See the information stating that the settings are stored on the machine and not with a solution

    Solution-stored settings

    Whenever you access settings from a Ranorex tool with an associated solution, the settings are stored in this solution.

    Solution-stored settings

    Solution-stored settings

    How to access solution-stored settings:

    Click the SETTINGS button in Ranorex Studio while a solution is opened

    • This option opens an extended settings dialog with …
    • Current recording settings dialog and …
    • Current repository settings dialog register tab

    Click the settings toolbar button in Ranorex Studio to open the regular settings dialog

    Settings dialog:

    See the setting title with associated solution name

    See the information stating that the setting is stored in the associated solution

    User-settings & solution-settings

    User settings are always stored locally on a machine and include user-specific settings related to the Ranorex Studio working environment.

    Solution settings include all settings which relate to the test solution, such as plugins, RanoreXPath generation, Ranorex Recorder defaults and many more, which can be shared between different systems, within teams and also be put under Version control.

    User-settings & solution-settings distinction

    User-settings & solution-settings distinction

    User-settings are printed in regular font
    Solution settings are printed in italic font

    Solution settings file

    The solution settings are saved in the settings file Ranorex.rxsettings, which is located in the ‘Solution Items’ folder of the corresponding solution. 

    Solution settings file

    Solution settings file

    Solution settings file in project file view of Ranorex Studio
    tipp icon

    Attention

    • Do not change the name of the folder or the file
    • If you remove the settings file (Ranorex.rxsettings), the solution settings stored on the local machine are automatically used during test execution
    • If you open the settings file, it is shown in its raw format. It is not recommended to edit the file in this view

    Adding a solution settings file

    If a solution does not contain a settings file, it can be added following the below-listed instructions.

    Creating a solution settings file

    Creating a solution settings file

    Click the Create solution settings in the ‘Projects view’ toolbar of a solution

    Solution settings and test execution

    The solution settings file Ranorex.rxsettings is automatically copied into the output directory of the test project. It is saved in the same folder as the test executable. This is why the solution settings will be used for test execution.

    Note icon

    Note

    • Do not rename the solution settings file
    • When deploying the test executable, make sure to include the solution settings.

    If the solution settings are not stored in the same folder as the test executable, the solution settings from the local machine will be used. 

    Solution settings and Ranorex Remote

    When selecting a solution for remote test execution, the solution settings saved in this solution will automatically be sent to the Ranorex Agent and used during test execution. 

    If the solution does not include a solution settings file, the solution settings stored locally on the Ranorex Agent’s machine will automatically be used during test execution.