Report settings

This chapter introduces the various options for setting and configuring reports.

In this chapter

    Accessing report settings

    Report settings are accessed through the Property pane of the corresponding test suite.

    Select the test suite and open the context menuClick Properties in the context menuIn the settings window, click the Report register tab

    Accessing report settings

    Report Description

    Under the Report tab, go the Report Settings section, and enter a Report Description.

    The description displays under the title of your generated report, review the image below which illustrates the action.

    Report file & directory settings

    Report file & directory settings are changed in the top of the report settings dialog.

    Report file & directory settings

    Option to enable/disable the generation of reports

    • If de-selected, no report (files) will be created

    Option to select an individual report file directory for storing Ranorex report files

    • If a folder is selected here, this folder is replacing the former standard report directory

    Option to design/create the automated standard report file nameSet of file name parts for automated report file names (set available as tool-tip)

    Further reading

    The concept of report file names and report directories is introduced and explained in detail in > Ranorex Studio fundamentals > Reporting > ⇢ Ranorex standard reporting.

    Timestamp settings

    Setting the ‘Auto-save-interval’ and the type of report timestamps is done in the report settings.

    Report time settings

    Option to set the auto save interval. Timing units are seconds. If set to ‘0’, auto-save is turned offDefinition of timestamp in reports

    Enabling compressed reports

    The creation of compressed report copies can be set in the report settings dialog.

    Enabling creation of compressed reports

    Further reading

    The creation of compressed reports is introduced and explained in detail in > Hands-on application topics > Best practices > ⇢ Creating a compressed Ranorex report.

    Enabling JUnit-compatible reports

    In Ranorex 7.0 and above, JUnit-compatible reports for use in CI tools can automatically be created. 

    Creating JUnit-compatible reports

    Enabling PDF Reports Merger

    Ranorex Studio creates PDF files for individual test cases as well as for an entire test run.  The PDF includes the following report types: *.rxlog, *, *.xsl, *.css, *.png, images, and links to videos. 

    In addition, you can select the directory location for the created reports files.

    Enabling either option for the creation of a PDF report, the option to select the report directly for your files displays.

    After setting up the PDF export directory, the following options are enabled:

    • Overwrite file
    • Include images
    • Include video reporting

    The above options are not enabled by default.

    Enabling CSV Report

    The CSV Export tab allows you to select items in your report to be formatted and exported as a CSV file.

    In the Export settings sections you have the following options:

    • Select Export all Columns to select all items
    • Select Export selected columns, the report includes a drop-down list of columns. The columns that are default and cannot be eliminated are grayed out for non-selection. 

    The data included in the file is used for the report, it is based on existing report levels, and the action filters. 

    Setting report templates

    The various options for defining, applying and changing report templates can also be set in the report settings dialog.

    Report tracing mode setting

    Further reading

    The concept of report customization by means of report templates is introduced and explained in > Ranorex Studio fundamentals > Reporting > ⇢ Report customization.

    Tracing screenshot settings

    The settings for tracing screenshots in reports are to be defined in the lower part of the settings dialog.

    Report tracing mode setting

    The settings for the tracing mode are:

    • Foreground: Tracing screenshot is captured before the corresponding action is executed (more accurate, but slower performance)
    • Background: Tracing screenshot is captured while action is being executed (less accurate, better performance)
    • Off: No tracing screenshots are captured
    Tracing screenshot quality settings

    Quality & size of tracing screenshot files. Click Apply.

    Video reporting

    Video reporting lets you record a test run as a collection of videos. This also works on Ranorex Agents.

    Set the recording mode:

    • Off: Video reporting is disabled. No videos will be recorded.
    • Failed test cases only: Records the entire test run, but saves videos for failed test cases only.
    • All test cases: Records and saves videos for all test cases.
    Note icon


    Ranorex Studio records a separate video for each test case. For the purpose of video reporting, test case means:

    • Test cases
    • Setup/teardown regions outside of test cases

    The bitrate of the videos in kilobytes per second. Lower values make video files smaller, but also lower image quality.

    The frame rate of the videos in frames per second. Lower values make video files smaller, but fewer frames also mean less information.

    Select the screen you want Ranorex Studio to record. The screen numbers correspond to the display settings in Windows. Auto uses the screen the mouse is on at the start of the test run.

    Note icon


    If you only have three screens and select screen 4, Ranorex Studio will automatically record the primary screen as defined in the display settings in Windows.