-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Made changes in Left-Nav & Updated Custom Reports doc (#512)
* Edited Salesforce NLPs doc & Updated Interlinks Edited Salesforce NLPs doc & Updated Interlinks as per suggestions by SEO Team. * Image updated * Made changes in Left-Nav & Updated Custom Reports doc
- Loading branch information
1 parent
47808a8
commit 01f757a
Showing
4 changed files
with
6 additions
and
296 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -41,288 +41,12 @@ Custom PDF Report Generator in Testsigma allows you to create detailed and custo | |
| Before you begin, ensure you have the following: | ||
|
|
||
| - An [API Key ](https://testsigma.com/docs/reports/runs/filter-custom-reports/) 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. | ||
|
|
||
| <details style="border: 1px solid gray; border-radius: 4px; padding: 0.5em; margin: 0.5em 0; background-color: #f2f2f2;"> | ||
| <summary style="color: darkgreen; font-weight: bold; cursor: pointer;"> | ||
| <span style="margin-right: 5px;">ℹ️</span>Example HTML Template | ||
| </summary> | ||
| <div style="padding: 0.5em;"> | ||
| <!DOCTYPE HTML> | ||
| <html xmlns:th="http://www.thymeleaf.org"> | ||
|
|
||
| <head> | ||
| <style> | ||
| @page { | ||
| size: A3 landscape; | ||
| background-color: #efefef; | ||
| } | ||
|
|
||
| body { | ||
| text-align: center; | ||
| font-family: 'Helvetica', sans-serif; | ||
| background-color: #efefef; | ||
| } | ||
|
|
||
| .landing-page { | ||
| position: relative; | ||
| text-align: center; | ||
| } | ||
|
|
||
| .main-heading { | ||
| color: #0c865d; | ||
| position: absolute; | ||
| top: 40%; | ||
| left: 10%; | ||
| font-size: 36px; | ||
| font-weight: bold; | ||
| } | ||
|
|
||
| .report { | ||
| width: 50%; | ||
| margin: 0 auto; | ||
| } | ||
|
|
||
| .support { | ||
| width: 60%; | ||
| padding-top: 30%; | ||
| margin: 0 auto; | ||
| } | ||
|
|
||
| a { | ||
| text-decoration: none; | ||
| color: blue; | ||
| } | ||
|
|
||
| table { | ||
| table-layout: fixed; | ||
| margin: 0 auto; | ||
| width: 80%; | ||
| border-collapse: collapse; | ||
| } | ||
|
|
||
| h1, h2 { | ||
| color: #0c865d; | ||
| text-align: left; | ||
| margin-left: 5%; | ||
| } | ||
|
|
||
| .left { | ||
| text-align: left; | ||
| color: #304c64; | ||
| } | ||
|
|
||
| .right { | ||
| text-align: right; | ||
| } | ||
|
|
||
| .fail { | ||
| background-color: #fee2e2; | ||
| } | ||
|
|
||
| .highlight { | ||
| background-color: #ecf8f3; | ||
| } | ||
|
|
||
| .row { | ||
| background-color: #ffffff; | ||
| } | ||
|
|
||
| .report-table, .support-table { | ||
| width: 50%; | ||
| margin: 0 auto; | ||
| } | ||
|
|
||
| .report-table td, .support-table td { | ||
| width: 50%; | ||
| padding: 7px; | ||
| border-top: 2px solid #efefef; | ||
| word-wrap: break-word; | ||
| text-align: left; | ||
| } | ||
|
|
||
| .report-table tr td:nth-child(odd) { | ||
| text-align: left; | ||
| color: #304c64; | ||
| } | ||
|
|
||
| .report-table tr td:nth-child(even) { | ||
| text-align: right; | ||
| } | ||
|
|
||
| .support-table tr td:nth-child(odd) { | ||
| text-align: left; | ||
| color: #304c64; | ||
| width: 30%; | ||
| } | ||
|
|
||
| .support-table tr td:nth-child(even) { | ||
| text-align: right; | ||
| width: 70%; | ||
| } | ||
|
|
||
| .message { | ||
| color: dimgray; | ||
| font-weight: bold; | ||
| font-size: large; | ||
| margin: 0 auto; | ||
| padding: 10%; | ||
| } | ||
|
|
||
| th { | ||
| font-weight: bold; | ||
| word-wrap: break-word; | ||
| padding: 7px; | ||
| text-align: left; | ||
| } | ||
|
|
||
| tr { | ||
| page-break-inside: avoid; | ||
| } | ||
|
|
||
| td { | ||
| border-top: 2px solid #efefef; | ||
| word-wrap: break-word; | ||
| padding: 7px; | ||
| text-align: left; | ||
| } | ||
|
|
||
| .support { | ||
| table-layout: fixed; | ||
| width: 30%; | ||
| padding-top: 30%; | ||
| margin: 0 auto; | ||
| } | ||
| </style> | ||
| </head> | ||
|
|
||
| <body> | ||
|
|
||
| <img th:src="${relativePath + 'ts_logo.png'}" alt="Company Logo" style="height: 30px; margin-top: 10px;" /> | ||
| <div class="landing-page"> | ||
| <img th:src="${relativePath + 'ts_bg_landing_page.png'}" width="100%" alt="Full Size Image" /> | ||
| <div class="main-heading"> | ||
| <h1>EXECUTIVE</h1> | ||
| <h1>REPORT</h1> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="report"> | ||
|
|
||
| <h1 th:text="${level + ' REPORT'}"></h1> | ||
| <table class="report-table"> | ||
| <tr th:if="${#lists.contains(summaryField, 'name')}"> | ||
| <td>Name</td> | ||
| <td th:text="${reportData.name != null ? reportData.name : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'executor')}"> | ||
| <td>Executed By</td> | ||
| <td th:text="${reportData.executor != null ? reportData.executor : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'environment')}"> | ||
| <td>Environment</td> | ||
| <td th:text="${reportData.environment != null ? reportData.environment : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'testPlanName') && level != 'PLAN'}"> | ||
| <td>Test Plan</td> | ||
| <td th:text="${reportData.testPlanName != null ? reportData.testPlanName : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'testDeviceName') && level != 'MACHINE' && level != 'PLAN'}"> | ||
| <td>Test Device</td> | ||
| <td th:text="${reportData.testDeviceName != null ? reportData.testDeviceName : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'testSuiteName') && level == 'CASE'}"> | ||
| <td>Test Suite</td> | ||
| <td th:text="${reportData.testSuiteName != null ? reportData.testSuiteName : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'result')}"> | ||
| <td>Result</td> | ||
| <td th:text="${reportData.result != null ? reportData.result : 'N/A'}" | ||
| th:style="'color: ' + ${reportData.resultColor} + ';'"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'buildNo')}"> | ||
| <td>Build No</td> | ||
| <td th:text="${reportData.buildNo != null ? reportData.buildNo : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'runId')}"> | ||
| <td>Run ID</td> | ||
| <td th:if="${reportData.url != null}"> | ||
| <a th:href="${reportData.url}" target="_blank" | ||
| th:text="${reportData.runId != null ? reportData.runId : 'N/A'}"></a> | ||
| </td> | ||
| <td th:if="${reportData.url == null}" th:text="${reportData.runId != null ? reportData.runId : 'N/A'}"> | ||
| </td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'screenshotCapturedFor')}"> | ||
| <td>Screenshot captured for</td> | ||
| <td th:text="${reportData.screenshot != null ? reportData.screenshot : 'N/A'}"></td> | ||
| </tr> | ||
| <tr th:if="${#lists.contains(summaryField, 'screenshotMode')}"> | ||
| <td>Screenshot mode</td> | ||
| <td th:text="${reportData.screenshotMode != null ? reportData.screenshotMode : 'N/A'}"></td> | ||
| </tr> | ||
| </table> | ||
| <br /> | ||
| <br /> | ||
|
|
||
| <div> | ||
| <h2>OVERALL SUMMARY</h2> | ||
| <img th:src="'data:image/png;base64,' + ${imageSrc}" alt="Chart Image" style="margin: 0 auto;" /> | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| <div style="page-break-before: always;"></div> | ||
|
|
||
| <h2 th:if="${isNotTestCase}">TEST CASES LIST</h2> | ||
| <table th:if="${isNotTestCase}"> | ||
| <tr class="highlight"> | ||
| <th style="width: 5%;"><img th:src="${relativePath + 'ts_icon_list_item.png'}" width="30" alt="Result" /></th> | ||
| <th>Test Case</th> | ||
| <th th:if="${#lists.contains(caseListColumns, 'testSuite')}">Test Suite</th> | ||
| <th th:if="${#lists.contains(caseListColumns, 'testMachine')}">Test Machine</th> | ||
| <th th:if="${#lists.contains(caseListColumns, 'assignee')}">Assignee</th> | ||
| <th th:if="${#lists.contains(caseListColumns, 'reviewer')}">Reviewer</th> | ||
| </tr> | ||
| <tr th:each="testCaseResult : ${testCaseResultList}" | ||
| th:class="${testCaseResult.result == 'FAILURE' ? 'fail' : 'row'}"> | ||
| <td style="width: 5%;"> | ||
| <img th:src="${relativePath + testCaseResult.icon}" style="border-radius: 50%;" width="30" | ||
| alt="Result" /> | ||
| </td> | ||
| <td th:text="${testCaseResult.testCase}"></td> | ||
| <td th:if="${#lists.contains(caseListColumns, 'testSuite')}" th:text="${testCaseResult.testSuite}"></td> | ||
| <td th:if="${#lists.contains(caseListColumns, 'testMachine')}" th:text="${testCaseResult.testMachine}"> | ||
| </td> | ||
| <td th:if="${#lists.contains(caseListColumns, 'assignee')}" th:text="${testCaseResult.assignee}"> | ||
| </td> | ||
| <td th:if="${#lists.contains(caseListColumns, 'reviewer')}" th:text="${testCaseResult.reviewer}"> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <div style="page-break-before: always;"></div> | ||
|
|
||
| <div class="support"> | ||
| <h2>SUPPORT</h2> | ||
| <table class="support-table"> | ||
| <tr> | ||
| <td>For any assistance, contact:</td> | ||
| <td> | ||
| <a href="mailto:[email protected]">[email protected]</a><br /> | ||
| Phone: 123-456-7890 | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </div> | ||
|
|
||
| </body> | ||
| </html> | ||
|
|
||
| </div> | ||
| </details> | ||
|
|
||
| - An **HTML template** for the PDF report. [Click here](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Custom_Report_Template.html) to download the HTML template. | ||
|
|
||
| --- | ||
|
|
||
|
|
||