The standard report is usually appropriate for most scenarios. However, to suit individual needs, it’s fully customizable. Because customization is a large topic, we’ve split it up into two chapters.
In this chapter, you’ll learn about the basics of customization and go through a few examples to customize the look of the report without coding.
Download the sample solution
The explanations in this chapter are based on a sample solution that you can download below.
Install the sample solution:
Unzip to any folder on your computer.
Start Ranorex Studio and open the solution file
From raw data to the report
The image below illustrates the process that prepares raw data to be displayed in an easily readable format in the report.
Concept of Ranorex reporting
- During the test run, the report engine collects data in an XML format.
- The report engine converts this data to HTML and creates a report file based on CSS and XSL specifications.
- Ranorex Studio displays this HTML-based report with its built-in HTML viewer.
Collected test data
Data from a test run is collected and stored in an XML format. This raw data can also be read and used outside of Ranorex Studio with any XML viewer/editor.
Test data in XML format
Report file and XML-data file
CSS and XSL specifications
The raw XML data is used to create
CSS and XSL specification files
HTML report file
The final report generated from XML by XSL and CSS is stored in a HTML-based format in the
Reports folder of your project directory.
HTML-based report file and report as displayed in Ranorex Studio
- The report can be viewed in any web browser.
- The report file can be edited in any HTML editor.
Create a custom report template
Now that we’ve established how reports are generated, we can start customizing the report. There’s a convenient way to do this in Ranorex Studio without affecting the standard report:
Click the Report tab.
A message appears, telling you where the new report template folder has been created. Confirm with OK.
In the projects view, you can see the new template folder with the copied report files.
NewCustomTemplate1 folder in projects view
- These are the copied files that you can edit to the customize layout and content of the report.
- The PNG file contains the Ranorex logo as default logo for the report as well as other images used in the standard report. You can replace these with your own images.
- These files enable you to quickly check what your customizations will look like in an actual report. Just open View.rxlog to get a preview.
- You can also open it from Windows, so you don’t have to start Ranorex Studio.
Multiple custom report templates
You can create as many custom report templates as you want. However, only one template can be active at a time for a test suite.
To create additional custom templates:
Click Create custom template again and confirm with OK.
Another template folder appears in the projects view.
Example for multiple custom report templates
Rename custom report templates
You can rename custom report templates.
Renaming a custom report template
Error if the template isn’t reapplied.
Choose/reapply a custom report template
This function is used for three different purposes:
- To add an existing custom template from a folder.
- If you have multiple custom templates, to choose which one should be used.
- If you’ve renamed a template, to reapply it so Ranorex Studio can find it again.
If there’s a custom template currently active, click Reset to default template.
Choose a custom template in the browser window.
Reset to default report template
If you want to stop using a custom template, you can reset to the default Ranorex Studio template at any time.
Ranorex standard report template
How Ranorex Studio processes custom templates
Ranorex Studio has a special mechanism for processing customized report templates, which includes the output folder and the reports folder for each project. Understanding this process is important when you want to include external files in a report template, e.g. a PNG containing your logo, because these files aren’t included in the process by default.
Output folder \bin\Debug\
When you execute a test, Ranorex Studio copies all files needed for the test run into a designated output folder
Ranorex output folder
Reports folder \Reports\
When you run a test, Ranorex Studio also copies the default report files and any custom templates to
Ranorex reports folder
The image and descriptions below illustrate the process. As mentioned earlier, external files need special configuration to be included in the process. In this case, we assume that this has been done. You can learn how to do so further below.
A custom report template has been applied to the test suite. The folder for the custom template is located in your project’s folder,
On the first test run, the report files are copied to the output folder
\bin\Debug\ from the
\Reports\ folder. On subsequent runs, these two folders are synchronized, i.e. the output folder always contains the newest files from the
Including external files in the report
By default, Ranorex Studio only includes internal files (.rxlog, rxlog.data, .css, .xsl) in the reporting process, i.e. only these are copied to the output folder. For external files such as logos to show up in your custom report, you will need to include them in this process manually.
Any file(s) copied into the custom report folder are initially not part of the project, meaning they aren’t included in the reporting process either. They appear grayed out in the projects view.
You can see Copy to output folder is set to Never, so the file would be excluded from the reporting process. Change it to Always or Preserve newest.
Preserve newest means the file will only be copied if the version in the
\Reports\ folder is newer than the already existing one in the output folder. If no file exists yet in the output folder, it will always be copied.
Background color and logo customization
In this example, you’ll change the background color of the report and replace the Ranorex logo with a custom one. The example is based on the sample solution that’s available for download at the beginning of this chapter.
- Your logo doesn’t have to be a specific size. Experiment with different dimensions.
- It’s good to know the exact HEX values of the color(s) used in your logo.
We’ve prepared a sample logo. The green background has the HEX value
Replace the logo
To replace the logo, you’ll need to make changes to the CSS specification file.
- The background color is set to the same green HEX value as the logo background color.
- All other settings are unchanged.
- Height and width of the logo are set to their respective values (see logo size).
- The default logo name is replaced with “frogconsulting.png”.
- The other settings are unchanged.
- Finally, a top margin of 40px is set for the general information box.
Replace Computer/Endpoint with username
There are also various options for changing the contents of the report. We’ll go through three examples that will introduce the basic principle and help you customize reports according to your own ideas. In the first example, you’ll customize the report so that the entry for “Computer/Endpoint” reads “Username” and instead of the machine name displays the username.
Replacing Computer/Endpoint with user name
In the XSL specification, replace “Computer/Endpoint” with “Frog user”.
Also in the XSL specification, replace the variable
Report username customization
Report with customized username
Change report message formatting
In this example, you’ll change the formatting of a specific type of report message.
As you can see in the image below, messages in the default report with the Success level are printed in green font. Let’s change this to a bold blue font.
Paste it in the customization section at the end of the CSS file and modify it as shown in the image.
Save and close the file.
Customized Success message
Remove information from report
In this example, you’ll remove information from the report. This is useful when something’s not relevant and you want to free up space in the report.
In our example, we want to remove the Time column for report messages.
Deactivate all of them by commenting them out as shown below.
Deactivate it by commenting it out as below.
Custom report without Time column