Basic report characteristics & data | Ranorex
HomeUser GuideRanorex Studio FundamentalsReportingBasic report characteristics & data

Basic report characteristics & data

Independent from the use and application of Ranorex reports, there are report characteristics and report data which are shared across all types of reports. The purpose of this chapter is to introduce and explain them.
In this chapter

    Basic characteristics

    Reporting starts with the beginning of the test run. Find a summary of the basic report characteristics below:
    • Data collection is started synchronously by starting a test run.
    • Type and amount of report data which is to be included in a current report are controlled by report levels, a concept being introduced in the next chapter.
    • Test solutions may contain numerous test cases with dozens/hundreds of structuring elements and test items. Therefore, test runs may last from minutes to hours. Report data usually is available in a progressive way right from the beginning of the test run. This principle is also explained later in this chapter.

    Reported action execution

    Basically, every action which is executed during a test run triggers a status message by default and therefore can be included in a test report.
    Example for reported action execution

    Example for reported action execution

    Example for reported action executions  

    Important to know:

    • Each action execution may be present as one report item in the report
    • Test cases and test runs usually are large and can contain thousands of actions to be executed. The representation of all action executions within the report, therefore, will lead to large and unmanageable reports
    • The concept of error-levels helps control which test run events find their way into the report
    • Furthermore, the report access of an action can be controlled by its action properties

    Controlling the report access of actions

    Select an action in the action list
    Open the action properties pane by clicking F4
    Open the drop-down list of the Use logging property
    Controlling report access of actions

    Controlling report access of actions

    Default

    The default setting for logging the action item may be ‘true’, or ‘false’. This is specified within the settings of Ranorex Studio.

    Further reading

    The complete options for setting and configuring reports are introduced and explained in > Ranorex Studio system details > Settings & configuration > ⇢ Report settings.
    True – Action item is logged
    False – Action item is not logged

    Reported test validation

    Test validation is a special type of action which demands special interest with respect to reporting.
    Successful & failure test validation in report

    Successful & failure test validation in report

    Successful test validation

    A successfully executed test validation action attaches its status message with the report level ‘Success’ and is usually printed in green.

    Failure test validation

    A failed validation action usually leads to the abortion of the test run and attaches its status message with the report level ‘Failure’ and is printed in red.

    Note icon

    Note

    The default abortion of a test run after a failed test validation might not be useful. Therefore, it can be ‘enabled to continue on fail’.

    Further reading

    Enabling an action to continue on failure is introduced along with the management of actions in  > Ranorex Studio fundamentals > Actions > ⇢ Managing actions.

    Controlling the report access of test validation

    The access of test validations to reports can be controlled through the property pane of validation actions.
    Select a validation action
    Open the action properties pane by clicking F4
    Specify the report level for test validation failure and success  
    Report access on success & failure for test validation

    Report access on success & failure for test validation

    Recording separator

    Recording separators allow structuring recording modules and provide an easy way for making a test run more transparent through report messages.

    Further reading

    Separators are also part of the various options for managing recordings. Therefore, it is also introduced and explained in >  Ranorex Studio fundamentals > Ranorex Recorder > ⇢ Managing recording modules.
    Inserting separator action
    Inserting separator action
    Add a separator by adding a Separator action
    See the separator action in the action table

    Result(s):

    As a result, the recording is not only structured visually. The separator also raises a report issue with the separator header text as report information.
    Separator report message
    Separator report message
    Note icon

    Note

    A separator owns the report level ‘Info’, a concept which is introduced in the next chapter.

    User-defined log message

    User-defined log messages are a method for inserting additional report message if needed. This method is mainly used as a debugging instrument and the objective is to generate a report message at a specific position during the test run.
    Select a position in the action table and > Add new action
    Click > Log message for the user-defined log message
    Inserting a user-defined log message
    Inserting a user-defined log message

    Result(s):

    Action type ‘Report’

    Log messages are of action type ‘Report’ which is also be made visible through the action icon in column #1

    Report type

    The report type can be specified by opening the corresponding list

     
    Log message report type
    • Log = The contents of the log action, i.e. a text, or the contents of a defined variable is displayed in the report
    • Screenshot = A screenshot of the linked repository item is taken in the moment of execution and stored within the report
    • Snapshot = This option triggers Ranorex Spy to analyze and store the repository status of the corresponding linked repository item in the moment of execution and store it. A link in the report opens Ranorex Spy and displays the stored repository status
    Log message specification
    • Column #2 holds the log message content
    • This can either be a constant value (i.e. text message), or a reference to a variable where data-based testing can be applied
    Error level
    • Column #5 outlines the corresponding error level

    User-defined log message in report

    User-defined log message in report
    User-defined log message in report
    User-defined log message in action table
    Resulting log message in report