Report Uploader Integration

This document shows you how to upload Katalon test reports to Katalon True Platform using Report Uploader.

Report Uploader is a utility to upload reports to Katalon True Platform. The utility supports JUnit, Katalon Studio, and Katalon Recorder report format. It can be used with CLI, Docker, GitHub Action, and other CIs.

Prerequisites

• Katalon API key – If you haven’t set one up yet, follow this guide to generate your API key.
• Project ID - You can find your Katalon project ID in the URL (typically after /project/, e.g., ".../project/1234567/...").

Upload test reports using Report Uploader in CLI

1. Download Report Uploader and install Java JRE and Java JDK.

2. Get the local path to your Katalon report folders, e.g. “C:\Users\alex\Katalon Studio\Web Sample\Reports\Test Suite\20190523_143946" that you want to upload.

3. Replace the placeholder values then run the following command:

   java -jar katalon-report-uploader-0.0.8.jar
   --projectId=your_project_id
   --path=path/to/test/report
   --password=your_api_key_value
   --type=your_report_type

   Available parameters are:

   Parameter	Description
   projectId	Your project ID in Katalon True Platform.
   path	The local path of the Katalon Studio Reports folder identified in step 2.
   email	The email registered for your Katalon account. This field is not required if an API key is used as password.
   password	The password used to sign in to Katalon True Platform, or an API key for that account. Using an API key is recommended because it does not expose your password.
   type	Select one of the following options: katalon, junit, or katalon_recorder.
   server	(Optional) The Katalon True Platform server endpoint. By default, this is https://platform.katalon.com.
   --push-to-xray=true	(Optional) If your Katalon True Platform project is integrated with Xray test management, this option enables pushing the test results to Xray.

Result

Once executed successfully, the command will upload your report to Katalon True Platform. Navigate to Reports to view all uploaded test reports.