Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

main to dev #505

Merged
merged 3 commits into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 29 additions & 28 deletions src/pages/docs/reports/runs/custom-pdf-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,26 @@ page_id: "custom-pdf-report-generation"
search_keyword: ""
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Retrieving Result IDs"
url: "#retrieving-result-ids"
- type: link
name: "Executing Custom PDF Report for Test Plans"
url: "#executing-the-jar-file-for-test-plans"
- type: link
name: "Executing Custom PDF Report for Test Case, Test Suite, or Test Machine Level"
url: "#executing-custom-pdf-report-for-test-case-test-suite-or-test-machine-level"
- type: link
name: "Using Preferences to Generate Custom PDF Report"
url: "#using-preferences-to-generate-custom-pdf-report"
- type: link
name: "Preferences for Custom Report Generation"
url: "#preferences-for-custom-report-generation"
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Retrieving Result IDs"
url: "#retrieving-result-ids"
- type: link
name: "Executing Custom PDF Report for Test Plans"
url: "#executing-the-jar-file-for-test-plans"
- type: link
name: "Executing Custom PDF Report for Test Case, Test Suite, or Test Machine Level"
url: "#executing-custom-pdf-report-for-test-case-test-suite-or-test-machine-level"
- type: link
name: "Using Preferences to Generate Custom PDF Report"
url: "#using-preferences-to-generate-custom-pdf-report"
- type: link
name: "Preferences for Custom Report Generation"
url: "#preferences-for-custom-report-generation"
---

---
Expand Down Expand Up @@ -320,6 +320,7 @@ Before you begin, ensure you have the following:

</body>
</html>

</div>
</details>

Expand All @@ -332,11 +333,11 @@ To generate reports, you need specific IDs depending on the level of detail you
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. ![retrieving runid for test plan level](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testplan_run_id.cpr.gif)
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**. ![retrieving result ids](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/case-machine-suitelevel-id-cpr.gif)
- 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**. ![retrieving result ids](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/case-machine-suitelevel-id-cpr.gif)

---

Expand All @@ -346,6 +347,7 @@ Run the Custom Report Generator with the required inputs to create a PDF report.

1. Open Terminal or Command Prompt and navigate to the folder containing the JAR file.
2. Run the following command, replacing the placeholders with your actual values:

```bash
java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
--config.apiKey=YOUR-API-KEY \
Expand All @@ -370,6 +372,7 @@ Generate reports at the Test Case, Test Suite, or Test Machine level by followin

1. Get the Run ID as explained in the [Retrieving Result IDs](https://testsigma.com/docs/reports/runs/custom-pdf-report/#retrieving-result-ids) section.
2. Use the following command, including your specific preferences:

```bash
java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
--config.apiKey=YOUR-API-KEY \
Expand All @@ -395,6 +398,7 @@ Replace the placeholders with your actual values:
## **Using Preferences to Generate Custom PDF Report**

Customize your report content and structure using various preferences:

```bash
java -jar custom_pdf_generator-0.0.1-SNAPSHOT.jar \
--config.apiKey=YOUR-API-KEY \
Expand Down Expand Up @@ -450,7 +454,6 @@ List of configurable preferences to tailor your PDF reports according to your ne
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Custom Report Preferences</title>
<style>
body {
font-family: Arial, sans-serif;
Expand Down Expand Up @@ -542,5 +545,3 @@ List of configurable preferences to tailor your PDF reports according to your ne
</html>

---


Loading