Custom PDF Report Generation

Custom PDF Report Generator in Testsigma allows you to create detailed and customized reports according to your needs. This feature lets you generate reports for test cases, suites, or machines without restrictions. You can also adjust your reports using different preferences, making it a strong tool for in-depth analysis and presentation.

Prerequisites

Before you begin, ensure you have the following:

• An API Key from your Testsigma account.
• Java 17 or a newer version installed on your system.
• You can request the JAR file from the Customer Support team and download it before executing a Custom PDF Report Generation.
• An HTML template for the PDF report. Click here to download the HTML template.

Retrieving Result IDs

To generate reports, you need specific IDs depending on the level of detail you want:

1. Navigate to the Run Result from which you want to retrieve the Run ID.
2. For test plan level reports, Use the Run ID directly from the Run Result page. You can find this in the Execution ID or the URL endpoint. Copy the Run ID from the Run Result page.

3. For Test Machine, Test Suite, or Test Case level reports:

   • Right-click on the page and select Inspect to open Developer Tools.
   • Go to the Network tab.
   • In the Testsigma application, select the test case, suite, or test machine in the Run Result details page to get the response.
   • In the Developer Tools, under the Network tab, find the response results in the name section and click Preview.
   • Unhide the Content and copy the required ID.

Executing the JAR File for Test Plans

Run the Custom Report Generator with the required inputs to create a PDF report. This step converts your HTML template into a PDF based on your preferences. To execute the JAR file, follow these steps:

1. Open Terminal or Command Prompt and navigate to the folder containing the JAR file.

2. Run the following command,
   

   • For Mac

     java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
     --config.apiKey=YOUR-API-KEY \
     --config.plan.runId=YOUR-PLAN-RUN-ID \
     --config.template.location=/path/to/your/template.html \
     --config.pdf.directory=/path/to/save/report.pdf

   • For Windows

     java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar --config.apiKey=<API-KEY> --config.plan.runId=97040 --config.template.location=/path/to/template.html --config.pdf.directory=/path/to/save/report.pdf

     
     

Replace the placeholders with your actual values:

• YOUR-API-KEY: Your API key for authentication with Testsigma.
• YOUR-PLAN-RUN-ID: The run ID of your test plan.
• /path/to/your/template.html: Path to your HTML template file.
• /path/to/save/report.pdf: Location where the generated PDF report will be saved.

Executing Custom PDF Report for Test Case, Test Suite, or Test Machine Level

Generate reports at the Test Case, Test Suite, or Test Machine level by following these steps::

1. Get the Run ID as explained in the Retrieving Result IDs section.
2. Use the following command, including your specific preferences:

java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
  --config.apiKey=YOUR-API-KEY \
  --config.plan.runId=YOUR-PLAN-RUN-ID \
  --config.id=YOUR-ID \
  --config.preference.resultLevel=YOUR-PREFERENCE-RESULT-LEVEL \
  --config.template.location=/path/to/your/template.html \
  --config.pdf.directory=/path/to/save/report.pdf

• YOUR-API-KEY: Your API key for authentication with Testsigma.
• YOUR-PLAN-RUN-ID: The run ID of your test plan.
• YOUR-ID: The specific ID for Test Case, Test Suite, or Test Machine level reports.
• YOUR-PREFERENCE-RESULT-LEVEL: Specifies the detail level of the report (CASE, MACHINE, SUITE).
• /path/to/your/template.html: Path to your HTML template file.
• /path/to/save/report.pdf: Location where the generated PDF report will be saved.

Using Preferences to Generate Custom PDF Report

Customize your report content and structure using various preferences:

java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
  --config.apiKey=YOUR-API-KEY \
  --config.plan.runId=YOUR-PLAN-RUN-ID \
  --config.id=YOUR-ID \
  --config.preference.resultLevel=YOUR-PREFERENCE-RESULT-LEVEL \
  --config.preference.step=(YOUR-PREFERENCE-STEP) \
  --config.preference.screenshot=(YOUR-PREFERENCE-SCREENSHOT) \
  --config.preference.visualDifference=(YOUR-PREFERENCE-VISUAL-DIFFERENCE) \
  --config.preference.summaryFields=(YOUR-PREFERENCE-CASE-DETAILS-HEADERS) \
  --config.template.location=/path/to/your/template.html \
  --config.pdf.directory=/path/to/save/report.pdf

• YOUR-API-KEY: Your API key for authentication with Testsigma.
• YOUR-PLAN-RUN-ID: The run ID of your test plan.
• YOUR-ID: The specific ID for Test Case, Test Suite, or Test Machine level reports.
• YOUR-PREFERENCE-RESULT-LEVEL: Specifies the detail level of the report (CASE, MACHINE, SUITE).

• YOUR-PREFERENCE-STEP:Defines the steps to include in the report. Possible values:

  • PASSED: Only include passed steps.
  • FAILED: Only include failed steps.
  • EXECUTED: Only include executed steps.
  • NOT_EXECUTED: Only include steps that were not executed.
  • ALL: Include all steps.
  • NONE: Exclude all steps.

• YOUR-PREFERENCE-SCREENSHOT: Defines which screenshots to include. Possible values:

  • PASSED: Only include screenshots for passed tests.
  • FAILED: Only include screenshots for failed tests.
  • ALL: Include all screenshots.
  • NONE: Exclude all screenshots.

• YOUR-PREFERENCE-VISUAL-DIFFERENCE: Defines which visual screenshots to include. Possible values:

  • PASSED: Only include visual screenshots for passed tests.
  • FAILED: Only include visual screenshots for failed tests.
  • ALL: Include all visual screenshots.
  • NONE: Exclude all visual screenshots.

• YOUR-PREFERENCE-CASE-DETAILS-HEADERS: Specifies which headers to include in case details. Example values:

  • testCaseName
  • testSuiteName
• /path/to/your/template.html: Path to your HTML template file.
• /path/to/save/report.pdf: Location where the generated PDF report will be saved.

Preferences for Custom Report Generation

List of configurable preferences to tailor your PDF reports according to your needs.