Convert Existing Reports to PDF – Ranorex

This article explains how to use the ReportToPDF command-line tool to convert an existing Ranorex Studio report into PDF. This is useful when you want to share reports with people who don’t have Ranorex Studio installed.

Note: If you want Ranorex Studio to convert reports to PDF as they are being generated during test execution, use the ReportToPDFModule contained in the Ranorex Studio Automation Helpers.

Screencast: The screencast Converting reports walks you through the information found in this article.

Download the ReportToPDF tool

Download the latest version of the ReportToPDF tool: Ranorex.ReportToPDF.

Before you start

You need a compressed report (.rxzlog)

ReportToPDF converts compressed reports (.rxzlog), not raw .rxlog files. A .rxzlog is a single archive that includes the report plus all required files (images, additional assets, etc.).

How to create a .rxzlog

Use any of these options:

Automatically create a compressed copy (recommended): Enable the compressed-report option in test suite Properties > Report.
Manually compress an existing report: in Ranorex Studio, right-click a report and use Save as… to export it as .rxzlog.
Command line (CI-friendly): run your test executable with /zr to generate an .rxzlog in the report output.

Convert an existing report

ReportToPDF executable is a command-line tool that allows you to convert existing Ranorex Studio reports to PDF. The report must be passed to the converter in its compressed form, the so-called rxzlog. The rxzlog is a single archive (.rxzlog extension) including the report and all associated files.

Use the following call to execute the ReportToPDF tool from the command line:

Report.PDF.exe [input file] [output file] /[argument]

The input and output file are required; the arguments are optional.

[input]: Sets the file (*.rxzlog) which is converted.
[output]: Sets the name of the PDF file.

Allowed arguments

style: Sets a custom stylesheet.

detail: Specifies how much information is shown in the generated PDF:

none: No module actions are shown.
failed: Only actions from failed modules are shown.
all: All actions are shown (default value).