Typical CodeSonar Tasks

• Hub and Web GUI
• Warnings
• Analysis Runs
• Projects
• Project Trees
• Charts
• Files
• Management Reports

Most of these tasks take place in the CodeSonar Web GUI. To open the web GUI:

• Identify the location hostname:port of your CodeSonar hub.
• Start up a web browser.
• Enter http://hostname:port in the browser address bar, and press enter.

The GUI Home Page will open in the browser.

Warnings

• Find warnings that match specific criteria
• Sort a warning table
• Show full file paths in a warning table
• Refine a search
• View a warning report
• Save a named search
• Show new warnings
• Show warnings that first emerged after a specified analysis
• Show all warnings on the hub
• Assign all warnings in a directory to one user
• Show outstanding warnings belonging to a specific user
• See how results have changed after upgrading CodeSonar
• See also:
  • View the results of an analysis
  • Scripting tasks

Analysis Runs

• View the results of an analysis
• View statistics for an analysis
• List all analyses for a project
• View the log of an analysis run
• Sanity check an analysis run
• Resolve "Building Over..." Status
• Remove an analysis
• Branch an incremental analysis
• Relocate analysis files
• Distribute analysis work over specific machines
• Set up and perform a remote-managed analysis
• See also:
  • Scripting tasks

Projects

• View all information about a project
• Change a project name or description
• Create a new, empty project
• Delete a single project
• Delete multiple projects or project trees (or both)
• Get line counts and parse errors for a project without analyzing it
• Grant select users access to a project
• Move a single project to a different parent project tree
• Move multiple projects or project trees (or both) to a different parent project tree
• See also:
  • Scripting tasks

Project Trees

• View all information about a project tree
• Change a project tree name or description
• Delete a single project tree
• Delete multiple projects or project trees (or both)
• Move a single project tree to a different parent project tree
• Move multiple projects or project trees (or both) to a different parent project tree

Charts

• Chart active warnings by project and class [stacked bar chart]
• Chart a project's warnings by directory [pie chart]
• Chart the change in a project's warning counts over time [line chart]
• Chart the line counts for analyzed files [column chart]

Files

• List all source files for an analysis
• List all source files on the hub

Hub and Web GUI

Access Control

• Activate or deactivate a user account
• Grant select users access to a project
• Modify a role's permissions
• Modify a user's roles (and therefore their permissions)

Scripting

• Download warnings from an analysis...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file
  • see also codesonar dump_warnings.py: Download Specified Warnings
• Change the name of an analysis...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file
• Change the name of a project...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file
• Delete an analysis...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file
• Delete a project...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file
• Find the most recent analysis of a named project...
  • ...with a shell script
  • ...with a Python script
  • ...with a Windows batch (.bat) file

Other Hub Tasks

• Access the Web GUI remotely
• Add a new user account for yourself
• Add a new user account for another user
• Back up and restore a hub database...
  • ... with unencrypted communication between the hub and the backup server
  • ... with TLS communication between the hub and the backup server
• Change a hub's port
• Configure an OpenID Connect (OIDC) hub authentication service
  • ...Keycloak
• Configure a single sign-on (SSO SAML) hub authentication service
  • ...Azure AD
  • ...Keycloak
  • ...Okta
• Configure 'Windows Login' hub authentication
• Copy a hub
• Lock down a hub
• Make a hub listen on all interfaces
• See active hub users
• Set up automated annotation mirroring
• ssh tunnel to a hub
• Start the hub service as the local system
• Use a local character encoding
• Use CodeSonar with a reverse proxy

Management Reports

• Create a new management report template
• Edit an existing management report template
• Generate a management report