GUI: Metric 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.

GUI Reference: Metric Report

Displays the results of a metric search.

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

Metric report availability is independent of the language or languages involved, but the report contents will depend on the metric values available. In particular:

Procedure-scoped metrics are only available for analyzed C/C++, C#, and Java code.
For C# and Java, only the line-count-related built-in metrics are computed.

For the results of searches in other domains, see Search Results.

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

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

From Analysis:	Expand the Metrics section, then select one of the report links.
From Advanced Search:	Execute an advanced search in the Metrics tab.
From the Simple Search Tool:	Execute a search with a domain/scope setting that specifies the metrics domain.
From Metric Report Creation:	Use the Open Saved Report or Create New Report functionality.

From Analysis:

Expand the Metrics section, then select one of the report links.

From Advanced Search:

Execute an advanced search in the Metrics tab.

From the Simple Search Tool:

Execute a search with a domain/scope setting that specifies the metrics domain.

From Metric Report Creation:

Use the Open Saved Report or Create New Report functionality.

Page Access

ANALYSIS_READ
PROJECT_READ

Page Contents/Functionality

NAMEDSEARCH_WRITE

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

It is worth noting that the simple search tool is initially populated with the component search specification for the report.

The search domain is always "metrics".
It is not unusual for the text field to be empty, meaning that no constraints are imposed on code components beyond those provided by the search scope (as specified by the domain/scope setting).

For information on other header elements, see GUI Reference: Standard Header.

Breadcrumbs

Home > [Other_ProjectTree_Ancestors >] Proj_Name > Analysis_Name > Metric Report
Home > Metric Report
Depending on whether or not the search was carried out in the context of a focal analysis, 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 analysis to which the search was restricted (if any), and links to the corresponding Analysis page.

Page Heading

Proj_Name : Analysis_Name : Metric Report
Metric Report
Depending on whether or not the search was carried out in the context of a focal analysis.

Save Report controls

See Save a Report for full details.

Edit Report controls

See Edit a Report for full details.

Analysis-Granularity Metric Table

If the metric search was carried out in the context of a focal analysis, the Metric Report always includes a table of all the analysis-granularity metric values computed for that analysis (both built-in and user-defined). Click show to expand the table; hide to hide the table contents.

Screenshot fragment: table of analysis metrics

Report Contents

One table for each metric class (name-granularity pair) specified for the report.

annotated Screenshot fragment: metric report table

Each table has the following properties.

A heading specifying the metric class description and granularity.
The maximum number of rows depends on the Table Limit (which you can adjust using the Edit Report controls). If there is only one table in the report, the Table Limit is not applied.

One row describes one present component at the specified granularity.

Metric Granularity	Table Row Links To
procedure	Source Listing, scrolled to procedure definition
file	Source Listing
compilation unit	Source Listing for the compilation unit root instance.

Columns depend on the metric granularity.

Metric Granularity	Default Columns	Other Available Columns
procedure	Procedure File (Procedure File . File) Value (the value of the metric)	File Path (Procedure File . File Path) Directory (Procedure File . Directory) Line Number (Procedure Line) Language (Procedure File . Language)
file	File Value (the value of the metric)	File Path Directory Compilation Unit Path Compilation Unit Language
compilation unit	Compilation Unit ( root instance . File) Value (the value of the metric)	Properties of the compilation unit root instance: File Path Directory Compilation Unit Path Compilation Unit Language

By default, the table is sorted in descending order by Value.

A shortcut menu, with three options.

add metrics	Scrolls the page to display the Edit Report controls, expanding the controls if necessary.
view entire table	Opens a new Metric Report containing only the selected table. The Table Limit is not applied; instead the table has the standard table pagination controls. There is also no shortcut menu in this case. To return to the previous report, use your browser's Back button.
compare with other metrics	Opens a file search results or procedure results page (depending on the metric granularity), where the table of results has one row for each in-scope element at the specified granularity, and one column for each metric in the report that has that granularity.

If there is only one table in the report, it is always displayed in "view entire table " mode.

Standard Footer

See GUI Reference: Standard Footer.

See Searching: Saved Searches: Permissions for details of the permissions required to save a named search.

The Save Report section looks (something) like the example below. If necessary, click to expand it.

Annotated Screenshot Fragment: Save Report section, with expansions

To save the search, enter a name in the text box and click Save.

If you want to replace an existing search with the same name, select overwrite.

The Edit Report section provides functionality for changing the metrics included and table limit for the report. Note in particular that the Edit Report section has no effect on the sets of procedures, files, and compilation units for which values are displayed: these sets depend on the component search.

The Edit Report section looks (something) like the example below. If necessary, click to expand it.

Annotated Screenshot Fragment: Save Report section, with expansions

view the source listing (or part thereof) associated with a metric value	Click the relevant table line.
view a metric report creation page	Click create new report in the Edit Report section.

view the source listing (or part thereof) associated with a metric value

Click the relevant table line.

view a metric report creation page

Click create new report in the Edit Report section.

GUI Reference: Metric Report

Navigating to

Page Properties

Contents and Usage

Save a Report

Edit a Report

Navigating from