Run & debug recordings | Ranorex
HomeUser GuideRanorex Studio FundamentalsRanorex RecorderRun & debug recordings

Run & debug recordings

The purpose of this chapter is to demonstrate how to run and debug existing recordings.
  • Running a test, or a recording – in its simplest form – means replaying the recorded actions one after another and executing them step-by-step from the first to the last action.
  • Putting it into a larger context, automated testing means replaying the test with a (large) number of different user data in an iterated way with different parameters and multiple test scenarios.
  • This is where automated testing comes into play!
Here we show you the basic concept of running and debugging tests and recordings.
In this chapter

    Turbo mode

    Ranorex replays recordings just the way they have been recorded. This means that Ranorex simulates the time duration between actions in the way they were conducted by the user during recording. There are type dependent action time limits which define the maximum time between two different actions. But, the slower a test was recorded, the slower it will be re-played.
    To speed up replaying the Turbo mode option can be turned on:
    Click the Turbo mode button in the toolbar to turn turbo mode on/off.
    Turbo mode button in Ranorex Recorder

    Turbo mode button in Ranorex Recorder

    Good to know:

    • When turned on, the replay is being performed nearly without time-delay between actions.
    • The Turbo mode is applied to all actions of the recording module where it is activated

    Run a recording module

    This section shows you how to run a single recording module.
    Running a recording module

    Running a recording module

    Click the RUN button in the recorder view to run the current recording module
    Watch the run preparations and see the run progress
    Finally, you receive a test report of for the recording module test run
    tipp icon


    Remember to keep your fingers from mouse and keyboard during the test run.

    Further reading

    Reports, their structure, content, and interpretation are introduced and explained in detail in > Ranorex Studio fundamentals > Reporting > ⇢ Introduction.

    Run test cases

    Usually, tests are not run based on recording modules, but as complete test cases from within the test suite view. The test suite is the central point of control for modularization and management of test cases. If you are not familiar with the test suite and its application, we recommend reading:

    Further reading

    The test suite and its application are introduced and explained in detail in > Ranorex Studio fundamentals > Test suite > ⇢ Introduction.

    Switch to test suite view

    Click the register tab Introduction.rxtst to change to test suite view (rxtst = Ranorex test suite file).
    Switching to test suite view

    Switching to test suite view

    Good to know:
    • The example test suite has the same name as the test project: Introduction
    • The current test suite contains one test case default named TestCase
    • Finally, the test case contains one recording module Recording1
    • Checkboxes enable you to include/exclude test cases from test runs

    Run the test case:

    Running a test case

    Running a test case

    Click RUN in the test suite view
    See the debug information window of the test run
    See the progress information of the test run
    Success test report

    Success test report


    • Finally, a test report indicating success, or failure is displayed as separate file view

    Further reading

    Reports, their structure, content, and interpretation are introduced and explained in detail in > Ranorex Studio fundamentals > Reporting > ⇢ Introduction.

    Run shortcuts

    The run of the test suite can always be started by means of shortcut symbols in the Studio toolbar.
    Run & Stop shortcut buttons in Studio toolbar

    Run & Stop shortcut buttons in Studio toolbar

    Run options

    Sometimes it is necessary not to run a complete recording, or test, but to control the run similar to debugging a computer program. These various run options are explained herein after.
    Change to recorder view by clicking the referring register
    Select the action item on which to apply run options
    Open the context menu
    Context menu on action item #4

    Context menu on action item #4

    Run selected item(s)
    • It is possible to run one or many (selected) action items isolated
    • Only the selected action item(s) will be replayed
    Run to here (excl. selection)

    This option enables to run the complete recording from action #1 until the action prior to the selected action item.

    Run from here

    This option enables to run the recording from a selected action item (including the item) until the end.

    Record from here (after selection)

    Finally, this option is a special type of ‘run option’ which usually is used to complete a yet uncompleted recording. By means of this option, you can run the test from the beginning to a defined ‘end’ and immediately continue the recording from there.

    Debug – enable/disable on fail

    Whenever an action leads to an exceptional state during the test the default reaction is that the test aborts. Sometimes this is not what you want the test run to do. So, there is the option to enable a continue on fail setting for an action.

    Further reading

    The debugging option continue on fail is part of the concept of actions and is explained in detail in > Ranorex Studio fundamentals > Actions > ⇢ Managing actions.

    Debug – inserting a log message

    If test cases become complex, or if tests are run with many user data and in numerous iterations with optional parameters, the tracking of progress by means of log messages in the report might be helpful.

    Further reading

    Log messages and other options for controlling the test report are introduced and explained in detail in  > Ranorex Studio fundamentals > Reporting > ⇢ Basic report characteristics & data.

    Enabling/disabling debug mode

    Ranorex allows enabling a debug mode which works in conjunction with installing breakpoints in the programming code. Therefore, this option is recommended for expert use only.
    Ranorex Studio debug mode

    Ranorex Studio debug mode

    Turning debug mode on/off
    When you start the enabled debugging test run, verify that you run Ranorex Studio with administrator rights. A referring information is shown in case if you are not!
    tipp icon


    Debug mode slows down operating speed by approximately 30%.

    Sample solution

    If you want to try the herein introduced options we invite you to download and use a prepared sample solution.

    Training! What do I do?

    Theme: Run & debug recordings Time: Less than 10min Download sample file


    1. Unzip the project directory to any folder on your computer
    2. Start Ranorex Studio and open the solution file Introduction.rxsln