| Panel | |
|---|---|
On this page:
|
| Info |
|---|
Summary: This page provides instructions for configuring and using the Report Generation feature. |
...
The Report Generation feature allows you to generate reports on the fly direct from the CAST Security Dashboard interface. Various reports can be generated, however, some require some configuration before some configuration before they will work.
Accessing the Report Generation feature
...
Various report categories are available:
| Category | Release | Enabled by default? | CAST Report Generator for Dashboards required? | Additional configuration required? | Output format | Available reports |
|---|---|---|---|---|---|---|
| Security Reports |
See section below.| ≥ 2.7 |  |  | | Available reports include:
|
|---|
| ≤ 2.6 | | | See section below. | Same format as the associated CAST Report Generator templates. | ||||
|---|---|---|---|---|---|---|---|---|
| Industry Compliance Reports | ≥ 2.7 | | | | Available reports include:
| |||
| ≤ 2.6 | | | See section below | Same format as the associated CAST Report Generator templates. | ||||
Miscellaneous Reports | All releases |
|
|
| Inline in the browser Can be downloaded in Excel format. | Available reports include:
|
Custom |
|---|
Reports | ≥ 2.7 | Not available. | ||||
|---|---|---|---|---|---|---|
| ≤ 2.6 | | | See section below. | Same format as the associated CAST Report Generator templates. | This category enables you to define your own custom reports via CAST Report Generator templates. | |
Security and Industry Compliance Reports
...
Configuration process
| Anchor | ||||
|---|---|---|---|---|
|
≥ 2.7
When using ≥ 2.7 no additional configuration is required as all reports are generated by the dashboard in PDF format.
| Info |
|---|
Templates (in .json format) are stored in the Dashboard installation files in the "config/templates" folder within the installed "data" location:
|
≤ 2.6
These reports are based on templates provided with CAST Report Generator and therefore CAST Report Generator for Dashboards (v. ≥ 1.9.0) must be present on the server running Apache Tomcat hosting your Security Dashboard in order for the reports to function. In addition the report.properties file in your deployed Dashboard must be modfiedmodified. See Report Generation configuration and CAST Report Generator - CAST Report Generator for Dashboards for more detailed instructions about the configuration process.
...
Choose a report type from the Security Reports or Industry Compliance Reports category and click the Generate Report button:
The report will be generated and auto downloaded to the default "downloads" folder used by your browser. Reports are generated using the same format as the associated CAST Report Generator templates. The report file name should contain the:
- application name
- snapshot version
- report type
For example: MEUDON-Computed on 201903061327-OWASP-2017-Top10 - Summary.docx MEUDON_NEW-Snapshot-2022-07-07T12-02-59-ISO-5055 Compliance Report.pdf (MEUDON is an Application name).
Behaviour in ≥ 2.7 releases
A new tab will be opened in your browser (allowing you to continue using Security Dashboard while the report is being generated):
The report will be generated in PDF format and auto downloaded to the default "downloads" folder used by your browser:
If the generation fails, a message is displayed:
Behaviour in ≤ 2.6 releases
The report will be generated and auto downloaded to the default "downloads" folder used by your browser. Reports are generated using the same format as the associated CAST Report Generator templates. A notification message is displayed when the report is generated:
...
If the report fails to generate, a notification is also displayed with the error message. Please refer this page about error messages handling: Report Service - 1.9.0.
This example shows that CAST Report Generator for Dashboards has not been configured:
...
Drill down to violation source code is also possible for some reports:
Custom Reports
| Info |
|---|
In ≥ 2.7, the option to generate Custom Reports using CAST Report Generator for Dashboards has been removed. |
This category enables you to define your own custom reports via CAST Report Generator templates. The category is disabled by default (i.e. it does not contain any report templates). The templates you want to generate must be present on the server hosting Apache Tomcat in the "Templates" sub folder of your CAST Report Generator for Dashboards deployment location.
| Anchor | ||||
|---|---|---|---|---|
|
...