Task: Generate a Management Report

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

This section provides a general method for generating management reports to display information from the CodeSonar hub.

See Management Reports: Permissions for details of the permissions that apply to management reports and report templates.

The general process for generating a management report is as follows.

Determine your answers to the following questions.

What report template do you want to use?
What is the scope of the information that you want to include?
What report format do you require?

Depending on the scope you determined in step 1, navigate to the appropriate GUI page.

for a report about...	navigate to...
a single analysis A	the Analysis page for A
(analyses of) a single project P	the Project page for P
(analyses of) multiple projects	the hub Home page

Expand the Reports section of the page.

Select the name of the report template that you determined in step 1 from the Report Template menu.

If your required template name is not available in the menu, the template is not (currently) available for the scope associated with the current GUI page type.

If you have accidentally navigated to a GUI other than the one you intended, navigate to the correct page and try again.
If you want to make the template available for your current scope, edit the template to change its scope settings, then try again.

(Home page only) If your selected template is available for both "Latest Analyses" and "All Analyses" scopes, the Reports section will expand to include a Report Scope menu.

Select all projects, all analyses to include all analyses on the hub.
Select all projects, most recent analyses to include only the most recent analysis of each project on the hub.

Depending on the report format that you determined in step 1, there may be additional formatting options.

XML: no additional options.
HTML: click show html options to display the formatting options, then use the Paging menu to specify whether you want the report to be generated as a single HTML page or a sequence of pages (every Heading 1 in the report will start a new page).
PDF: click show pdf options to display the formatting options, then use the Page size menu to specify the PDF page size, and use the Orientation menu to specify page orientation.

Generate the report.

XML: click view xml report.
HTML: click view html report.
PDF: click view pdf report.

Task: Generate a Management Report

Links