Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A ZIP file will be downloaded. Extract the ZIP and deploy the files as described below in Installation process.

1.9.0

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.

Limitations

...

To install and use the CAST Report Generator for Dashboards, the following is required:

.NET / .NET Core

CAST Report Generator for Dashboards requires the the .NET / .NET Core runtime/SDK as follows:

Report Generator releaseMinimum .NET / .NET Core releaseDownloadNotes
≥ 1≥ 1.24.x.NET Core 6.0 SDKhttps://dotnet.microsoft.com/en-us/download/dotnet/6.0-
1.14.0x.NET Core 3.1.x SDKhttps://dotnet.microsoft.com/download/dotnet-core/3.1A change to the SDK rather than the runtime to match the requirements for Report Generator GUI.
1.13.x.NET Core 3.0.x runtimehttps://dotnet.microsoft.com/download/dotnet-core/3.0Future 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 x - 1.12.0x.NET Core 2.2.x runtimehttps://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:

...

  • need to use the tool to generate Standard Compliance reports in the CAST Engineering or Security Dashboards, you should deploy the tool on the Apache Tomcat server which hosts your dashboards and then complete Step 2 below.
  • simply want to use the tool via CLI to generate reports (see below) you can deploy the tool on any server providing it has network access to a CAST RestAPI interface (i.e. a dashboard). There is nothing further to do in this case.

...

Code Block
languagetext
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

JAR ≥ 2.5
%PROGRAMDATA%\CAST\Dashboards\<dashboard>\application.properties

Find the following options and modify as explained below:

...

report.reportGenerator=dotnet

Add a new line pointing to the location of the CastReporting.Console.Core.dll (delivered with CAST Report Generator - CAST Report Generator for Dashboards) on the server hosting Apache Tomcat/the deployed ZIP file. You can also uncomment and modify an example line. For example:

Code Block
languagetext
report.reportGenerator=dotnet D:\\data\\CAST\\ReportGeneratorforDashboards\\CastReporting.Console.Core.dll

Note
Note that the path to CastReporting.Console.Core.dll when using Microsoft Windows must always use double back slashes (\\) or single forward slashes (/) - the single back slash (\) is not valid.


report.directory=

Add a new line pointing to the temporary folder where the reports will be generated on the server hosting Apache Tomcat/the deployed ZIP file. You can also uncomment and modify an example line. For example:

Code Block
languagetext
report.directory=D:\\temp\\reports

Note

Note that:

  • the path to the temporary folder when using Microsoft Windows, must always use double back slashes (\\) or single forward slashes (/) - the single back slash (\) is not valid.
  • The user that Apache Tomcat is running as must have read/write access to this location. In Linux environments, typically the "rw-" permission is sufficient.


report.webServiceURL=

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:

Code Block
languagetext
WAR 1.x / ≥ 2.x
report.webServiceURL=http://<server>:<port>/<dashboard>/rest

ZIP ≥ 2.x
report.webServiceURL=http://<server>:<port>/rest


Enable and configure security.apikey (optional for SAML/LDAP authentication mode)

If you are using the Dashboards embedded in AIP Console (integrated RestAPI) or standalone CAST Dashboards AND you have LDAP / SAML authentication enabled in AIP Console/standalone CAST Dashboards, you must enable and configure the security.apikey option with a random string of characters. Using this option allows the CAST Report Generator for Dashboards to authenticate correctly. To do so see the Configuration section in RestAPI authentication using an API key.

Restart the application

Restart the web application to ensure the changes are taken into account.

...

Info
Available in v. ≥ 1.11.0.

If you have enabled SAML authentication mode for your CAST Dashboard/RestAPI deploymentyou are using the Dashboards embedded in AIP Console (integrated RestAPI) or standalone CAST Dashboards AND you have LDAP / SAML authentication enabled in AIP Console/standalone CAST Dashboards, you will need to use an API Key instead of a password. To do , so you will need to modify so see the Configuration section in RestAPI authentication using an API key. Then modify the command line as follows:

...