|Summary: this page describes the CAST Report Generator for Dashboards release.|
CAST Report Generator is now provided as an cross-platform ZIP file alongside the traditional Microsoft Windows GUI "installable" release. In other words this release can run on both Microsoft Windows and Linux operating systems and can be simply unzipped to the install location (no installer is provided). The tool has two main uses:
You can obtain the Report Generator for Dashboards from CAST Extend:
A ZIP file will be downloaded. Extract the ZIP and deploy the files as described below in Installation process.
You can obtain the CAST Report Generator for Dashboards from the CAST Product Center - this requires a CAST login. Download the latest release, unpack the ZIP, and you will find another ZIP called ReportGeneratorCLIforAllOS.zip alongside the traditional GUI based ReportGeneratorSetup.exe:
Extract the ZIP called ReportGeneratorCLIforAllOS.zip and deploy the files as described below in Installation process.
To install and use the CAST Report Generator for Dashboards, the following is required:
CAST Report Generator for Dashboards requires the .NET Core runtime/SDK as follows:
|Report Generator release||Minimum .NET Core||Download||Notes|
|≥ 1.14.0||3.1.x SDK||https://dotnet.microsoft.com/download/dotnet-core/3.1||A change to the SDK rather than the runtime to match the requirements for Report Generator GUI.|
|1.13.x||3.0.x runtime||https://dotnet.microsoft.com/download/dotnet-core/3.0||Future releases of CAST Report Generator will require .NET Core 3.1.x due to the end-of-life of .NET Core 3.0.x scheduled for 3rd March 2020, therefore CAST recommends installing .NET Core 3.1.x to avoid the need to re-install .NET Core in the future.|
|1.9.0 - 1.12.0||2.2.x runtime||https://dotnet.microsoft.com/download/dotnet-core/2.2||-|
This runtime/SDK is available for both Microsoft Windows and for Linux operating systems depending on the Operating System used to host Apache Tomcat:
.NET Core can be downloaded as an installer - choose the .NET Core Installer runtime/SDK that matches your Windows environment:
Package manager instructions are provided for many different Linux distributions - choose the Package Manager Instructions option:
Then select the relevant Linux distribution to view the installation instructions:
CAST Report Generator for Dashboards only requires that .NET Core runtime is present on the operating system. Therefore any operating system that supports the installation of .NET Core can be used for the CAST Report Generator for Dashboards. CAST has tested Microsoft Windows and CentOS (Linux).
The user that Apache Tomcat is running as must have read/write access to the following locations:
In Linux environments, typically the "rw-" permission is sufficient.
Installing CAST Report Generator for Dashboards consists only of unzipping the downloaded ZIP file to a location on the target server, for example:
If you need to use the tool to generate Standard Compliance reports in the CAST Engineering or Security Dashboards, a further configuration process is required:
Edit the following file with a text editor:
WAR 1.x CATALINA_HOME\webapps\<deployed_war>\WEB-INF\report.properties WAR ≥ 2.x CATALINA_HOME\webapps\<deployed_war>\WEB-INF\classses\application.properties ZIP ≥ 2.x <unpacked_zip>\application.properties
Find the following options and modify as explained below:
# Set the Report Generator path # If this variable is not set then the document generation is considered as disabled. # The path is probably something such as (Linux/Windows): #report.reportGenerator=dotnet /opt/report-generator/CastReporting.Console.Core.dll #report.reportGenerator=dotnet D:\\data\\CAST\\ReportGeneratorforDashboards\\CastReporting.Console.Core.dll # Set the directory of reports #report.directory=/tmp/reports #report.directory=D:\\temp\\reports # Set the current Web Service URL. The current REST API called back by the Report Generator. report.webServiceURL=http://localhost:8888/CAST-RESTAPI/rest
Add a new line pointing to the location of the
Add a new line pointing to the temporary folder where the reports will be generated on the server hosting Apache Tomcat. You can also uncomment and modify an example line. For example:
Modify the existing line to point to the RestAPI in your CAST Engineering Dashboard or CAST-RESTAPI-integrated.war deployment. This is used by CAST Report Generator for Dashboards. For example:
# Set the Report Generator path # If this variable is not set then the document generation is considered as disabled. # The path is probably something such as (Linux/Windows): #report.reportGenerator=dotnet /opt/report-generator/CastReporting.Console.Core.dll #report.reportGenerator=dotnet c:\\ReportGenerator\\CastReporting.Console.Core.dll report.reportGenerator=dotnet c:\\ReportGeneratorforDashboards\\CastReporting.Console.Core.dll # Set the directory of reports #report.directory=/tmp/reports #report.directory=c:\\temp\\reports report.directory=c:\\temp\\reports # Set the current Web Service URL. The current REST API called back by the Report Generator. report.webServiceURL=http://localhost:8888/CAST-RESTAPI/rest
Restart the web application to ensure the changes are taken into account.
As mentioned previously, the primary goal of this release is to provide reporting capabilities for the CAST Dashboards (Engineering and Security) - However, it is also possible to use CAST Report Generator for Dashboards yourself via its CLI. The CLI instructions are identical to those provided for the standard CAST Report Generator GUI - see here for more instructions.
You must run the CAST Report Generator for Dashboards in a specific way when used in CLI mode. The
CastReporting.Console.Core.dll is provided with the tool:
dotnet %path_to_CastReporting.Console.Core.dll% -webservice %webservice% -username %username% -password %password% -application %application% -domain %domain% -template %template% -file %file%
dotnet "D:\data\CAST\ReportGeneratorCore\CastReporting.Console.Core.dll" -webservice "http://<server>:<port>/CAST-RESTAPI/rest/" -username cio -password cast -application "Jurassic Park" -domain "AED" -template "Executive-summary.docx" -file "D:\temp\Core_Report.docx"
|Available in v. ≥ 1.11.0.|
If you have enabled SAML authentication mode for your CAST Dashboard/RestAPI deployment, you will need to use an API Key instead of a password. To do, so you will need to modify the command line as follows:
dotnet "D:\data\CAST\ReportGeneratorCore\CastReporting.Console.Core.dll" -webservice "http://<server>:<port>/CAST-RESTAPI/rest/" -username cio -password myapikey -apikey true -application "Jurassic Park" -domain "AED" -template "Executive-summary.docx" -file "D:\temp\Core_Report.docx"
The CAST Report Generator for Dashboards saves a log of all interactions in the folder into the Logs folder (located in the folder in to which you have unzipped the CAST Report Generator for Dashboards). One log file per day is generated:
For example ReportGenerator_20190328.log.
One of the following codes will be returned on completion of the CLI:
|0||Report successfully generated|
|1||Bad arguments given to the Report Generator|
|2||Web service cannot be accessed or is badly configured|