GUI Reference

• Accessing GUI Pages
• GUI Page Components
• Page Types
• Page Type Properties
• Java and JavaScript

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

Accessing GUI Pages

Most users will access the GUI pages through a standard web browser.

• The home page for a hub is located at
  http://host:port/
  or
  https://host:port/
  where host:port is the hub location.
• The CodeSonar build/analysis reports the URL for the analysis results:
  • As command line output, for command line builds.
  • On the final wizard screen, for Windows build wizard builds.
• Each GUI page type has its own URL or URL scheme. These URLs are listed in the table below and included in the detailed documentation section for each page type.

You can also use the codesonar get command to download an individual GUI page from the command line:

where:

http://host:port/path/to/filename
http://host:port/path/to/filename?query_string
https://host:port/path/to/filename
https://host:port/path/to/filename?query_string

GUI Page Components

The pages in the CodeSonar GUI conform to a standard layout, as shown below.

The Standard Header

The following annotated screenshot fragment shows the different parts of the standard header.

link to home page	Click the CodeSonar logo to navigate to the hub Home page.
simple search tool	To search for warnings: Select a search scope from the pull-down menu. Enter search terms in the text box. Terms may be plain text or conditions constructed using the appropriate CodeSonar search language. Click Search. See Simple Search for more details about the simple search tool. See the CodeSonar search language documentation for more information on the search languages. Note in particular that you may get unexpected results if you search for a string without realizing that it has a special interpretation in the applicable search language. The special cases are described in the notes on 'word' searches.
Advanced Search link	Click to navigate to the Advanced Search page.
quick links and settings
	manual link	Link to the title page of this manual.
	Settings link	Link to the GUI Settings page.
	light/dark mode selector	This controls the color scheme for the Web GUI display. There are two options: Light (dark text on light background) and Dark (light text on dark background). The default color theme for the hub is specified on the Content tab of the Settings page.
	language selector	This controls the (human) language in which warning report annotations are rendered. GUI links to warning class documentation will navigate to documentation in the appropriate language (where available). There are currently two available languages: English (en) Japanese (ja) The default language for the hub is specified on the Content tab of the Settings page.
	Sign In or Sign Out	Appearance depends on whether or not a user is currently signed in. When no user is currently signed in, there is a link to the GUI Sign In page. Otherwise, there is an icon labeled with the name of the signed-in user. Click to pop up a Sign Out link, then click the link to sign out.
file output links	If file output is available for the current page, one link for each available output format. Depending on your browser configuration, selecting a link will have one of the following results: The output file will open directly in the browser. The browser will ask whether you want to choose an application to open the file or to save the file to disk.
Visibility Filter selector	Allows you to specify which elements the CodeSonar GUI will display. The visibility filter domain is one of {Warnings, Files, Procedures, Code, Metrics, Analyses, Projects, Warning Categories, Users}, depending on the current context. The page type properties table below shows the visibility filter applied for each page type. The options available in any Visible Elements selector correspond to the names of those saved searches in the Elements domain for which you hold NAMEDSEARCH_EXISTS. Your settings in each selector are preserved through all your CodeSonar GUI navigation, and applied on the relevant GUI page types, until you change the settings. Default visibility settings are managed on a per-user basis. To remove items from a selector, go to the Saved Searches page and delete the corresponding named searches. To view the search conditions associated with a named search, go to the Saved Searches page and look at the search definition. To add new items to a selector, carry out a search in the appropriate domain, with the appropriate conditions, and save a named search from the search results page. CodeSonar ships with the following visibility filters. The all visibility filter in each domain will always be available to all users; the others are governed by NAMEDSEARCH_EXISTS settings. domain name description Warnings all Show all instances of all warnings. (Exception: analysis comparisons and other searches involving set operators always return result sets with at most one instance per warning group, even when Visible Warnings is set to all.) active Show the cluster representative for all warnings except those for which at least one of the following is true: Priority is Suppressed. State is Invalid, Fixed, or Later. Finding is False Positive or Don't Care. active not clustered Show the representative instance of all warnings except those for which at least one of the following is true: Priority is Suppressed. State is Invalid, Fixed, or Later. Finding is False Positive or Don't Care. not suppressed Show the cluster representative for all warnings except those whose Priority is Suppressed. new Show the cluster representative for warnings that were first issued in the most recent analysis of the appropriate project. This is managed on a warning group basis: if a warning group G appears for the first time in analysis A of project P, then new will not display the representative instance for G unless A was the most recent analysis of P. active and new Show only the cluster representative for new warnings, and only if they are active. Files all Show all analyzed user source files. System include files (that is, files specified by a SYSTEM_INCLUDE_PATHS rule) are not included. Code all Show all code information from analyzed user source files, along with all code information from inline functions in system include files. Procedures all Show all procedures in analyzed user source files, along with all inline functions in system include files. Metrics all Show all metric values. Analyses all Show all analyses. Projects all Show all projects. Warning Categories all Show all categories. taxonomy_name Show only categories from the specified taxonomy. There is a built-in taxonomy_name filter for each taxonomy listed in Warning Categories: Standard Category Kinds. Users all Show all users. If no visibility filter applies to the page you are currently viewing, no selector will be displayed.
Highlight Legend Link	[Source Listing and Warning Report only] To view the highlight legend, click and select show highlight legend from the menu that pops up.

The Standard Footer

The following annotated screenshot fragment shows the different parts of the standard footer.

Permission Note. If you do not have G_HUB_METADATA permission, your page footer will display the CodeSecure web link only. It will not display any hub metadata, license-related notifications, or hub alert notifications.

License-related notifications, if any, are displayed immediately above the footer. There are several license notification types.

• No valid license found. The hub does not have a suitable license key. Full licensed hub functionality will not be available to any user of the hub until a suitable license key is configured.
• License heartbeat failure. The hub is having difficulty interacting with the license key correctly. For example, this can occur if there is a network failure, or if a user deletes or replaces the license key lock file (perhaps because an automated job is deleting temporary directories). If heartbeat failure persists for too long, full licensed hub functionality will become unavailable until license key access is restored. If you are not sure what is causing the problems, open the hub processes log and look for messages that include the string 'license'.
• Warning: One or more licensed resources has been [completely] exhausted. A licensed resource (other than anonymous or user session slots) has been exhausted. Full licensed hub functionality will not be available to any user of the hub until a license key with higher resource limits is configured.
• Limited Access. Full licensed hub functionality is not available to your current GUI interaction session because a licensed session limit has been exceeded: either you are in an anonymous session and all licensed anonymous session slots are occupied, or you are signed in and all licensed user session slots are occupied.
• Note: Utilization of one or more licensed resources is above 90%. This notification is provided so that hub administrators have advance warning that they may need to increase one or more licensed limits. There is no effect on full licensed hub functionality.
• Note: The CodeSonar license key expires in <time_remaining>. This notification is provided so that hub administrators have advance warning that the CodeSonar license key expiry date is approaching and a new license key may be required. There is no effect on full licensed hub functionality.
• Note: The ability to analyze projects expires in <time_remaining>. This notification is provided so that hub administrators have advance warning that the CodeSonar analysis license key expiry date is approaching and a new license key may be required. There is no effect on full licensed hub functionality.
  Most license keys do not have an analysis expiry date that is separate from the overall license key expiry date, so most users will never see this warning.

Other hub-related alerts, if any, are also displayed immediately above the footer.

• Warning: Please set the Public URL administrative setting to ensure valid URLs in emails. The SMTP Settings for the hub have been configured but not the Public URL, meaning that the hub may be sending users email messages containing invalid URLs. You will only see this message if at least one of your assigned roles has G_ADMINISTER_HTTP_SETTINGS permission: users without the ability to set the Public URL will not be asked to do so.
• Warning: The web server's process pool was exhausted... The hub ran out of processes for servicing HTTP connections. The hub will not start more slave processes than the maximum allowed by the Max Processes setting, so the alert suggests increasing this setting.
• Warning: The web server's process pool ran out of idle processes... The hub ran out of idle processes for servicing HTTP connections; some incoming requests were delayed while new processes were started to service them. The alert suggests increasing the Min Idle Processes setting to address this.
• Warning: The web server experienced an exception... There was an internal exception in the hub. Consult the hub log for more information. If necessary, contact CodeSecure support for assistance.

CodeSonar Page Types

Page Type Properties

Each page type has certain properties.

The following table summarizes these properties (other than permissions) for all page types.

• Italicized URL scheme components indicate elements that must be replaced with concrete values in order to construct a concrete base URL.
• URL components in square brackets [] are optional.

(*) Import functionality is only available on one page type, with the type depending on the hub's setting for warning group sharing.

• ON: Home page (including /projecttree/1.html )
• OFF: Project pages

Given the HTML URL for a particular page, there are two ways to obtain the URL for another supported output format:

• Open the page in your web browser using the HTML URL, right-click on the appropriate file output link, and select "copy link location" (or similar).
• Edit the URL directly to change the file extension, as shown in the following table.

  Desired output format	Replace .html file extension with
  XML	.xml
  CSV	.csv
  JSON	.json
  SARIF	.sarif
  text	.txt

Java and JavaScript

All parts of the CodeSonar GUI make heavy use of JavaScript, as does this manual. If JavaScript is not enabled by default in your browser, you will need to enable it.

Enabling JavaScript

Browser-specific help links:

• Firefox
• Microsoft Edge
• Chrome