Complex Customizations

The easiest way to create a report message in code is by using one of the six different standard report classes.

Standard report classes

The easiest way to create report messages in code is to use the built-in report methods (these map to the default report levels).

Ranorex.Report.Debug(“Debug message”);

Ranorex.Report.Info(“Information message”);

Ranorex.Report.Warn(“Warning message”);

Ranorex.Report.Error(“Error message”);

Ranorex.Report.Success(“Success message”);

Ranorex.Report.Failure(“Failure message”);

1. Create a code module and open it.
2. Add the messages above to the Run() method.
   
3. Run the code module from the test suite and check the report.
   

Hint: To display all messages (including Debug), set the test suite’s report level threshold accordingly in Report settings.

Report with user code actions

In addition to code modules, you can log messages from recording modules using User code actions.

1. Open a recording module..
2. Insert a new user code action (for example: ReportInformation()) and open it.
   
3. Add a report message in the user code action implementation.
4. Run the recording module and review the report output
   

By default, custom report messages use the category User. You can set a category per message or change the default category.

Per message

1. Create a new code module and open it.
2. Add the code shown below.

1. This report message appears under the category Cat.A.
2. This report message appears under the default category User.
3. The report messages with their categories as defined above.

Result

Change default category

Create a new code module and open it.

Add the code shown below.

1. This line defines Cat.A as the new value for the default category for user-defined report messages.
2. These report messages appear under the new default category.
3. User-defined messages appear under the category Cat.A until you change it.

Result

You can define report levels with a custom name and an integer value.

1. Define the custom report levels MID and LOW using the code below.
2. Create two user-defined report messages with the new report levels.

Result

1. The report messages appear with the new report levels.

Format custom report levels

You can also attach CSS styling to a custom level:

1. Add the code below to apply custom CSS formatting to a report level.

1. See the formatted result in the test report

To filter what appears in the report, set the current threshold so only messages at (or above) your chosen level are included.

1. Define two custom report levels.
2. Set the current threshold report level to MID and higher.
3. Create two report messages, one with LOW and one with MID as report levels.

Result

1. Only report messages with the report level MID and higher appear in the report.

To ensure a message is logged regardless of the current threshold, use ReportLevel.Always.

1. Define two custom report levels.
2. Set the current threshold report level to MID and higher.
3. Create two report messages, one overriding the current report level.
   

Result

1. The second message appears regardless of the current report level.

Add the code below to send a screenshot to the report. If you don’t specify a repository item, Ranorex Studio takes a screenshot of what’s visible at the time of code execution.

1. The desktop screenshot is in the test report.

Further reading: To learn how to take screenshots of specific repository items, refer to Code modules.

Add the code below to display a system summary in the report.

1. The system summary appears as an Info message in the report.

You can collect customized data during a test run and write it to the raw data file (.rxlog.data) that are used to generate the final report.

Add custom data to raw data file

Customized data collection is triggered by a user code action with a method that tracks customized data.

1. Define an object that references the current activity stack of Ranorex Studio.
   The activity stack is where all activities during a test run are collected by means of a stack data structure.
2. Add an activity to the activity stack.
   The activity stack method CustomProperties adds a reported activity to the activity stack. It is defined by two strings, name (e.g. myName) and value (e.g. myValue).
   

Result

The result is a custom data field pair in the corresponding data file

1. The raw data file contains the custom data.

• If you want to apply the test data outside of Ranorex Studio report generation, you can parse the XML file as needed.
• To include the custom data in a Ranorex Studio report, please refer to the next section.

To include custom data in Ranorex Studio reports, you must modify the corresponding XSL specification file of the report. You can do this in any XML editor or Ranorex Studio.

Add the code in the picture below to the file.

1. This line identifies the field pair where the custom data is located in the raw data file.
2. This optional line adds a header that will be displayed before the custom data.
3. This line gets the field value of the corresponding field name.

Result

1. The report contains the custom data.