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.

CodeSonar® 9.2p0 CONFIDENTIAL CodeSecure Inc
General

GUI Reference: Metric Report Creation

Allows users to specify metrics for a new metric report, or open a saved metric report.

For general information about metric reports, see GUI Reference: General Information About Metric Reports.

Important Note: the CodeSonar Web GUI makes extensive use of JavaScript. Make sure JavaScript is enabled in your web browser.

Navigating to

The Metric Report Creation page can be reached in any of the following ways.

From Analysis: Expand the Metrics section, then select open saved report or create new report.
From Metric Report: Expand the Edit Report section (if necessary), then select open saved report or create new report.
By URL: http://hub_location/metrics_report/analysis_id.html

Page Properties

Output formats CSV, JSON, XML (metrics.xsd)
Visibility Filter Applied none
RBAC Permissions Needed
Page AccessANALYSIS_READ
Page Contents/FunctionalityANALYSIS_WARNING_EXISTS
NAMEDSEARCH_EXISTS
NAMEDSEARCH_READ
For more information, see Searching: Permissions.

Contents and Usage

The following annotated screenshot shows the various parts of a Metric Report Creation page

annotated screenshot: Metric Report Creation page standard header breadcrumbs heading Open Saved Report controls Open Saved Report controls analysis-granularity metric values analysis-granularity metric values Create New Report controls Create New Report controls standard footer

Standard Header It is worth noting that the simple search tool provides options for searching metrics at various scopes. Use the simple search tool with one of these settings if you want to specify a component search for your new metric report: see below for details.

For information on other header elements, see GUI Reference: Standard Header.
Breadcrumbs Home > [Other_ProjectTree_Ancestors >] Proj_Name > Analysis_Name > Metrics
where
  • Home links to the GUI Home page
  • Together with the Home link (corresponding to the root project tree), Other_ProjectTree_Ancestors represents the project tree ancestors of the analyzed project as a >-separated sequence of project tree names. Each name links to the corresponding Project Tree page.
  • Project_Name is the name of the analyzed project, and links to the corresponding Project page.
  • Analysis_Name is the name of the focal analysis, and links to the corresponding Analysis page.
Page Heading Proj_Name : Analysis_Name : Metrics
Open Saved Report controls See Open a Saved Metric Report for full details.
Create New Report controls See Create a New Metric Report for full details.
Analysis-Granularity Metric Table A table of all the analysis-granularity metric values computed for the focal analysis. Click show to expand the table; hide to hide the table contents.

Screenshot fragment: table of analysis metrics

Standard Footer See GUI Reference: Standard Footer.

Open a Saved Metric Report

The Open Saved Report section provides functionality for opening any previously saved metric report for which you have NAMEDSEARCH_EXISTS permission (except for reports that have been subsequently deleted).

Annotated Screenshot Fragment: Open Saved Report section, with expansions

To open a saved Metric Report:

  1. Expand the Open Saved Report section, if it is not already expanded.
  2. Select the report to open from the pull-down list.
  3. Click Open.

The report will be displayed in a Metric Report page. The scope of the displayed report will always be based on the focal analysis.

Create a New Metric Report

The Create New Report section provides functionality for specifying the metrics included and table limit for a new metric report. When expanded, it looks (something) like the example below.

Annotated Screenshot Fragment: Create New Report section, with expansions

Specifying Metrics and Table Limit for a New Report

To specify metrics and table limit for a new metric report whose scope is based on the focal analysis:

  1. Expand the Create New Report section, if it is not already expanded.
  2. Select the metric classes to be displayed in the report from the list or lists provided.
  3. Select a table limit for the report from the pull-down menu.
  4. Click Create.

Your new report will be displayed in a Metric Report page. Initially:

You can use the functionality on the Metric Report page to change the metrics displayed or component search, if necessary.

Specifying a Component Search for a New Report

To specify the component search for a new metric report, use the simple search tool:

  1. Select an appropriate domain/scope setting: the domain should be metrics.
  2. Enter a search string in the text field, using the metric search language. If you want to obtain metric values for every component in your selected scope that has the appropriate granularity, leave the text field empty.
  3. Click Search.

Your new report will be displayed in a Metric Report page. Initially there are no metrics included: use the Edit Report functionality on that page to specify metrics to display. You can also use the simple search tool on that page to modify the component search, if necessary.

Specifying Both Component Search and Metrics for a New Report

The Metric Report Creation page does not support specifying both component search and included metrics in a single operation. To specify both elements, either:

Navigating from

view a metric report page Specify a new metric report using the Create New Report section.
 

To report problems with this documentation, please visit https://support.codesecure.com/.