GUI Reference: Analysis

• Navigating To
• Page Properties
• Contents and Usage
• Navigating From
• Dry Runs
• Related Tasks
• Other Related Links

Navigating To

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

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

http://hub_location/analysis/analysis_id.html

http://hub_location/analysis/analysis_id-files.html

http://hub_location/analysis/analysis_id-procedures.html

Page Properties

See Tab Properties entries for individual tabs:

• Analysis: Warnings Tab Properties
• Analysis: Files Tab Properties
• Analysis: Procedures Tab Properties

Contents and Usage

The following annotated screenshot shows the various parts of an Analysis page.

Changing the Analysis or Analysis Description Text

Follow these steps to change the Analysis or Analysis Description. This requires ANALYSIS_READ and ANALYSIS_WRITE permission for the analysis.

1. Expand the Analysis Details.
2. Click edit next to the entry you want to change. An editing form will open, as in the example below.

   

   The text field will contain the text of the current entry, if any.
3. Enter your new text (or edit the existing text).
4. Click Save to save your changes, or Cancel to cancel the changes and close the editing form.
5. If your change was successful, the page will now display your new description.

Terminating the Analysis

If the analysis is still running you can terminate it, leaving the analysis in Stalled state. This requires ANALYSIS_TERMINATE permission for the analysis.

1. Expand the Analysis Details.
2. In the Machines field, click kill this analysis. If there is no kill this analysis link, the analysis has already finished (or has already been terminated).
   A confirmation dialog will open, as shown below.

   

3. Click Kill to terminate the analysis, or Cancel to cancel analysis termination and close the confirmation dialog.

Removing the Analysis

Follow these steps to remove all information related to the analysis from the hub database. This requires ANALYSIS_READ, ANALYSIS_DELETE, and ANALYSIS_TERMINATE permission for the analysis.

1. Expand the Analysis Details.
2. In the Analysis field, click remove this analysis. A confirmation dialog will open, as shown below.

   

3. Click Remove to remove the analysis, or Cancel to cancel analysis removal and close the confirmation dialog.

Removing an analysis will also remove its logs, but will not remove the project analysis directory.

Removing the Analysis Logs

Follow these steps to remove all logs for the analysis from the hub database. All other analysis information will remain intact. You may wish to do this if you are trying to reduce the size of the hub database and do not anticipate any future need for any information in the logs from this analysis. If an analysis is still running when you remove its logs, any further log information that is submitted to the hub by that analysis will be ignored. This requires ANALYSIS_READ and ANALYSIS_DELETE permission for the analysis.

1. Expand the Analysis Details.
2. In the Logs field, click remove logs. A confirmation dialog will open, as shown below.

   

3. Click Remove to remove the logs, or Cancel to cancel removal and close the confirmation dialog.

Removing the Project Analysis Directory

Follow these steps to remove the project analysis directory (pfilesname.prj_files/) from the analysis machine. Analysis information stored on the hub will remain intact. You may wish to do this if you are trying to make space available on the analysis machine and do not anticipate any future need for any information from the project analysis directory. In particular, do not remove the project analysis directory if you want to preserve access to any of the following.

• Source listings for this analysis (these are stored in the project analysis directory rather than on the hub).
• Procedure-granularity metrics for this analysis (these are also stored in the project analysis directory).
• The CodeSonar internal representation (IR) analyzed by this analysis (for example, because you want to inspect it using the CodeSonar API).

Removing the project analysis directory requires ANALYSIS_READ, ANALYSIS_DELETE and ANALYSIS_TERMINATE permission for the analysis.

1. Expand the Analysis Details.
2. In the .prj_files field, click remove .prj_files. A confirmation dialog will open, as shown below.

   

3. Click Remove to remove the .prj_files directory and all its contents, or Cancel to cancel removal and close the confirmation dialog.

The analysis launch daemon must be running in order to delete the project analysis directory. If that launch daemon is currently offline, the deletion will be delayed until it is online again.

Dry Runs

For dry runs:

• The basic analysis information is available, except for those parts that relate to the analysis phase (such as the analysis log).
• The 'analysis' can be removed, like any other.
• There will be an analysis message that begins "This analysis was a dry run. A full analysis would utilize an additional <num> lines from the license."

  The value of <num> reflects the additional cost that would be incurred if the project (as of the time of the dry run) were analyzed "now", where "now" is the time at which the Analysis page for the dry run was served by the hub. Since different versions of the project may subsequently be analyzed on the hub, <num> can decrease over time.

• The Warnings tab is empty.

File Explorer

The File Explorer allows you to restrict the contents of any Analysis page tab to a single source file or directory tree. This restriction is applied in addition to any constraints arising from the current visibility filter selection.

In its collapsed state, the File Explorer is indicated by a shaded bar at the left of the page.

Using the File Explorer

Click on a file or directory name to select it. The tab contents will update automatically, and your selection will be highlighted in the File Explorer panel.

• Clicking a file name selects that file; clicking a directory name selects all files in that directory and (recursively) all files in any of its subdirectories.
• The selection will continue to apply if you change to a different tab.

In the following annotated screenshot, the user has clicked on include.

• All files in the directory tree under include are selected.
• The Warnings tab shows only warnings that
  • are in one of the three selected files, and
  • are permitted by the Visible Warnings setting.
• The Files tab will list the subset of {myinclude.h, bestlib.c, bestlib.h} permitted by the Visible Files setting.
• The Procedures tab will list only procedures that
  • are defined in one of the three selected files, and
  • are permitted by the Visible Procedures setting.

Expanding, Resizing, and Collapsing

Modifying User-Assigned Analysis Properties

You can add, remove, or edit the user-assigned properties associated with the analysis.

Add a User-Assigned Analysis Property

Follow these steps to associate a new user-assigned analysis property with the analysis.

1. Expand the Properties.
2. Click add new property. A form will open, as shown below.

   

3. Enter the Property Key. This must contain at least one non-space character, and not match any field-name from the analysis search language or project search language.

   The Property Key is the "name" of the property. For example, you might have a property with key "commit" to store the information about which Git commit corresponds to the analysis.

   The set of all property keys on the hub is visible to all users, but the set of property keys and values for a specific analysis is only visible to users with ANALYSIS_READ permission for that analysis.

4. Enter the Property Value. This can be any string.
   For example, suppose you have a property with key "commit" as described in the previous step. Then the value might be the commit hash, or a GitHub URL, or some other string that conveys the commit information in a useful way.
5. Click Save to add the property, or Cancel to cancel the changes and close the form.
6. If your change was successful, the Properties section will now include an entry showing the key and value for your new property.

Remove a User-Assigned Analysis Property

Follow these steps to remove one of the user-assigned analysis properties.

1. Expand the Properties.
2. Click delete next to the property you want to delete. A confirmation dialog will open.
3. Click Remove to remove the property (key and value), or Cancel to cancel removal and close the confirmation dialog.

Edit a User-Assigned Analysis Property

Follow these steps to change the value of one of the user-assigned analysis properties (see note).

1. Expand the Properties.
2. Click edit next to the property whose value you want to change. An editing form will open, as in the example below. The text field will contain the current value, if any.

   

3. Enter your new value (or edit the existing value).
4. Click Save to save your changes, or Cancel to cancel the changes and close the form.
5. If your change was successful, the Properties section will show the updated property value.

Note: If you want to adjust the key associated with a property you will need to add a new property with the new key and appropriate value, then remove the property with the old key.

Selecting Analyses For Comparison

The compare with previous analysis and compare with next analysis links provide direct shortcuts to analysis comparison results. If you want to compare the results of this analysis with some other analysis or analyses, you can construct a comparison query as follows.

1. Expand the Compare section, if it is not already expanded.
2. Click Select analyses.

   CodeSonar will display the Project page for the project analyzed by this analysis, augmented with functionality for selecting analyses for comparison.

   

3. Select an analysis to add to the comparison query.
   • If you want to add an analysis of the current project:
     1. Click the corresponding row in the displayed table.
   • If you want to include one or more analyses for other projects:
     1. Click the click here link.

        CodeSonar will display the hub Home page, augmented with functionality for selecting analyses for comparison.

        

     2. Navigate to the Project page for the project you are interested in, then select an analysis by clicking its entry in the displayed table.
4. CodeSonar will return to the starting Analysis page. The Compare section will display an updated list of the analyses selected for comparison.

   

   • If you have finished selecting analyses for comparison, click Compare. CodeSonar will compute and display the comparison results.
   • If you want to remove an analysis from the selection, click the × next to that analysis.
   • If you want to add more analyses to the comparison query, click Select additional analyses and repeat from step 3.

Navigating From

Related Tasks

• View the results of an analysis
• View a warning report
• View statistics for an analysis
• List all analyses for a project
• View the log of an analysis run
• Remove an analysis
• Show new warnings
• Sanity check an analysis run
• Get line counts and parse errors for a project without analyzing it
• We also provide some sample scripts for command line access to various Analysis page functionality.
  • Change the name of an analysis
  • Delete an analysis
  • Download warnings from an analysis

Other Related Links

• HTTP API Documentation (opens in a new tab) HTTP API Documentation
• Main GUI Reference