CAST Components
Page tree

Versions Compared

Old Version 45

changes.mady.by.user James Hurrell

Saved on

compared with

New Version 46

changes.mady.by.user James Hurrell

Saved on

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

...

  • 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.

...

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

...

.propreties file

Edit the following file with a text editor:

Code Block
languagetext
WAR 1.x
CATALINA_HOME\webapps\<dashboard<deployed_war>\WEB-INF\report.properties

WAR ≥ 2.x
CATALINA_HOME\webapps\CAST-RESTAPI-integrated<deployed_war>\WEB-INF\reportclassses\application.properties

ZIP ≥ 2.x
<unpacked_zip>\application.properties

Find the following options and modify as explained below:

Code Block
languagetext
# 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 cD:\\data\ReportGenerator\CAST\\ReportGeneratorforDashboards\\CastReporting.Console.Core.dll

# Set the directory of reports
#report.directory=/tmp/reports
#report.directory=cD:\\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

...

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. You can also uncomment and modify an example line. For example:

Code Block
languagetext
report.reportGenerator=dotnet c:\\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. You can also uncomment and modify an example line. For example:

Code Block
languagetext
report.directory=c:\\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


For example:

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

Restart Apache Tomcat (or the specific dashboard web application via Tomcat Manager) 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 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:

...