How to generate a custom web report

How to generate a custom web report

Cycle allows you to generate a custom web report to review the results of a test execution. This gives you the ability to develop your own custom report template that displays the test output data that is most relevant to your automated testing use case.

This article describes the process for configuring Cycle to generate a web report using a custom web report template.

Note: Custom report templates are created using Jasper Reports. This article does not describe the process of developing a custom web report in Jasper, instead this article describes the process for configuring Cycle to produce a custom web report from a report template ('.jasper' file) that was developed and compiled in Jaspersoft Studio. To create a custom report, download Jaspersoft Studio Community Edition.  An excellent resource to get started with Jasper Reports is the JasperReports Library Ultimate Guide.

The ComplianceReport.zip file attached to this article can be used as an example custom web report template. This example custom report simply writes any captured screenshots using any of the 'I save screenshot' Cycle steps, to the web report and does not save any additional output to the report.

Substitute your own '.jasper' files and other report assets with the files used in the example below to generate your own custom web reports.

These instructions assume you have downloaded and extracted the ComplianceReport.zip file attached to this article.

Step 1: Identify a folder or create a new folder to store your custom report template on your device.
For my example, I have created a folder called 'CustomReportTemplate' within my Cycle project folder. You can name your folder with any name that is appropriate for your project standards.


Step 2: Place a copy of all '.jasper' files and any other report assets into the folder you created.
For my example, notice that I have saved several '.jasper' files and a folder named 'images' in my CustomReportTemplate directory.

    1. Main-ComplianceReport.jasper - This is the main custom report template file generated in Jaspersoft Studio.
    2. Sub-ComplianceReport-ScenarioTree.jasper & Sub-ComplianceReport-StepList.jasper - These are sub reports used within the main custom report, both generated in Jaspersoft Studio.
    3. images - This folder contains some images used within the report. Any additional report assets required by the custom report should be saved in an appropriate location as required by the report template.
Step 3: Configure Cycle Reporting Settings to use the custom report template.
Click the Settings Icon and navigate to Reporting Settings

To produce a custom web report, complete the following steps:
  1. Ensure the 'Produce web report' option is enabled.
  2. Ensure there is an 'Output directory' configured. This is the location where Cycle will save the generated report files.
  3. Select the 'Custom' option under 'Web Report Template'.
  4. Navigate to and select the '.jasper' file for your custom report under the 'Custom Web Report Template' option.

Step 4: Run your test and review the report.
Cycle will  create a new folder in the 'Output' directory specified in your Reporting Settings.

The folder name will include the data and time the report was generated. The web report and any additional assets such as screen captures that were generated for the report will be saved in the folder.







    • Related Articles

    • How to make better xpaths for web tests.

      Problem My web-based steps in Cycle are not finding the elements I want them to, or finding the wrong elements and giving me false-positives. Solution When possible, it is best to define elements to interact with on a web page by a static value that ...

    • How to use Web API steps

      Web API steps introduced in Cycle 2.5 can be used to send HTTP requests to exposed web API endpoints. The Cycle Web API steps support POST and GET request methods using the JSON data format. Cycle also includes steps for handling HTTP responses ...

    • How to use a Custom Key Mapping File in Cycle

      Cycle has the ability to use a custom key mapping file for its terminal interactions. Some applications that Cycle interacts with require key presses beyond what can be done from the standard key mapping. Examples of this might include F keys higher ...

    • My web-based Cycle tests are failing.

      Problem My browser-based Cycle Features are failing. Solution Check that the following common mistakes are not causing your failures: 1. Opening the browser first Any browser-based Steps in Cycle should be preceded in their Scenario with: I open ...

    • How to Set Up and Troubleshoot Webdrivers

      Initial Webdriver Setup In order to use Cycle web Steps, a driver must be installed for Chrome, Internet Explorer, or Microsoft Edge. Step 1: Download your Webdriver The downloads for Chromedriver and IEDriver can be found from Chromium and Selenuim ...