GUI: Home Page

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.

CodeSonar^® 9.2p0

CONFIDENTIAL

CodeSecure Inc

General

GUI Reference: Home; Project Tree

The Home page is the home page for the CodeSonar Web GUI.

A Project Tree page displays information about a project tree on the hub.

Both page types include the following.

Information about the project tree (for the Home page, this is the hub's root project tree).
Functionality for operating on the project tree:
- changing its name, description, or parent project tree,
- deleting it,
- creating a new, empty project or project tree as a child of the project tree.
A table of the projects and project trees that are children of the project tree, with:
- links to pages with further information for each,
- functionality for deleting one or more, and
- functionality for moving one or more to a different parent project tree.

The main differences between the Home page and Project Tree pages are that the Home page is available to all users (with contents and functionality depending on user permissions), and its table of projects and project trees has a broader set of contents.

Navigating to
Page Properties
Home vs Project Tree Page
Contents and Usage
Project Tree Outline
Navigating from
Related Tasks
Other Related Links

Navigating to

Home and Project Tree pages can be reached in any of the following ways.

Home	From any page	Click the CodeSonar logo in the GUI page header.
Home	By URL	http://hub_location/index.html
Project Tree	From Home or Project Tree	Several navigation options: Click an entry in the project tree outline. Click a project tree entry in the table. Click a project tree name in the breadcrumbs.
	From Project or Analysis	Click a project tree name in the breadcrumbs.
	By URL	http://hub_location/projecttree/ptree_id.html

Page Properties

Output formats

CSV, JSON, XML (home.xsd)

Visibility Filter Applied

Visible Projects

RBAC Permissions Needed

Home:

Page Contents/Functionality	ANALYSIS_EXISTS PROJECT_DELETE PROJECT_EXISTS PROJECT_WRITE PTREE_ADD_CHILD PTREE_DELETE PTREE_EXISTS PTREE_READ PTREE_WRITE

Project Tree:

Page Access	PTREE_READ
Page Contents/Functionality	PROJECT_DELETE PROJECT_EXISTS PROJECT_WRITE PTREE_ADD_CHILD PTREE_DELETE PTREE_EXISTS PTREE_WRITE

Home vs Project Tree Page

The Home page and Project Tree pages have very similar contents and functionality, so are documented together. The differences between the two are summarized in the following table.

	Home	Project Tree page for Project Tree T
URL	http://hub_location/index.html	http://hub_location/projecttree/ptree_id.html Where ptree_id is the PTree ID for T.
Available To	All users.	Users with PTREE_READ permission for T.
Subject Project Tree	The hub's root project tree.	T
Table Contents	Projects and project trees for which: the user has PROJECT_EXISTS or PTREE_EXISTS permission, respectively, and either: the parent project tree is the root project tree, or the parent project tree is some tree for which the user does not have PTREE_EXISTS permission.	Projects and project trees whose parent project tree is T, and for which the user has PROJECT_EXISTS or PTREE_EXISTS permission, respectively.

For example, consider a hub with several project trees and two users. User A has a broad set of permissions that include PTREE_EXISTS permissions for all project trees and PROJECT_EXISTS permissions for all projects. User B has far more restrictive permissions: they only have PTREE_EXISTS permission for one of the project trees, and PROJECT_EXISTS permission for one project from a different project tree. Both users can access the Home page (because all users can always access the Home page), but the displayed items are different. User A can access all Project Tree pages; User B can only access the Project Tree page for one project tree. These differences are summarized in the following table.

User	Elements with EXISTS permission (PTREE_EXISTS/PROJECT_EXISTS)	Contents of Home Page table (when Visible Projects is set to 'all')	Accessible Project Tree pages
A		My Team Team X Project Q	(Home) root My Team Team X My Subteam Other Subteam Subteam Y Subteam Z
B		Other Subteam Project P	(Home) Other Subteam

Contents and Usage

The following annotated screenshot shows the various parts of the Home and Project Tree pages.

Annotated Screenshot: Home Page

Standard Header

See GUI Reference: Standard Header.

Breadcrumbs

Home; Project Tree for root project tree	Home
Project Tree for other project trees	Home > [Other_ProjectTree_Ancestors >] PTree_Name where Home links to the GUI Home page Together with the Home link (corresponding to the root project tree), Other_ProjectTree_Ancestors represents the ancestors of the project tree. Each name links to the corresponding Project Tree page. PTree_Name is the project tree name.

Page Heading

Home	Projects
Project Tree (including root project tree)	PTree_Name : Projects where *PTree_Name* is the project tree name

Summary Information Options and Create Functionality

Three sections with further information about the project trees: Project Tree Details, Charts and Tables, Reports.
Two sections for creating new hub elements: Create Project and Create Project Tree.

All are hidden by default.

Project Tree Details

Click for general information about the project tree.

screenshot fragment: show logs expansion

Project Tree	The project tree name. To change the name, click edit and enter a new name. For detailed instructions, see Task: Change a Project Tree Name or Description. To remove this project tree from the hub, click remove this project then confirm when prompted. Note that this will remove all project trees and projects in the subtree under this project tree, and all analyses of those projects. For detailed instructions, see Task: Delete A Single Project Tree. To view or modify the role-permissions for the project tree, click permissions or to navigate to the Project Tree Role-Permissions page. The root project tree cannot be renamed or deleted, so does not offer edit or remove this launchd group links on this line.
Parent Path	The project tree's ancestors, as a /-separated sequence of project tree names with a leading / representing the root project tree. To move the project tree to a different location in the hub's project tree hierarchy, click edit and enter the path to the parent project tree that you wish to move to. For detailed instructions, see Task: Move a Single Project Tree to a Different Parent Project Tree The root project tree has no parent and cannot be moved, so the Home page (and Project Tree page for the root project tree) does not include this element.
Description	To change the description, click edit and enter a new description. For detailed instructions, see Task: Change a Project Tree Name or Description.
Created

(Not available on Home page for users without PTREE_READ permission for the root project tree.)

Charts and Tables

Click to expand the Charts and Tables section.

screenshot fragment: show logs expansion

The section contains links to various summary information about the projects on the hub:

summary charts and tables for the hub
the hub-level undefined functions report
the open a saved chart dialog
the chart wizard

Reports

Click to expand the Reports section.

screenshot fragment: show Reports expansion

See GUI Reference: Management Reports for full details.

Create Project

Use this link to create a new, empty CodeSonar project as a child of the current project tree. For detailed instructions, see Task: Create a New, Empty Project.
(Not available on Home page for users without PTREE_READ permission for the root project tree.)

Create Project Tree

Use this link to create a new, empty CodeSonar project tree as a child of the current project tree. For detailed instructions, see Task: Create a New, Empty Project Tree.
This is the only location that provides functionality for creating a new project tree.
(Not available on Home page for users without PTREE_READ permission for the root project tree.)

Table of Projects and Project Trees

A table describing the projects and project trees that are children of the current project tree.
On the Home page, the table also includes projects and project trees whose parent project tree is some tree for which the user does not have PTREE_EXISTS permission.

The table has the standard pagination controls.
Click on any line in the table to navigate to a page with more information about the project.
- Each project tree entry links to the corresponding Project Tree page.
- With the default hub configuration, each project entry links to the Analysis page for the most recent analysis of the corresponding project.
- The hub can also be configured so that each project entry links instead to the Project page for the corresponding project.

The available table columns are as follows. Columns displayed by default are marked with an asterisk (*).

	Column Label	Column Data
	Column Label	Project Entry	Project Tree Entry
Entry Type	none
Project / Project Tree Information	Name *	Project.Name	Project Tree.PTree Name
	ID	Project.Project ID	Project Tree.PTree ID
	Description	Project.Project Description	Project Tree.PTree Description
	Parent Name	Project.Parent Project Tree.PTree Name	Project Tree.Parent Project Tree.PTree Name
	Parent ID	Project.Parent Project Tree.PTree ID	Project Tree.Parent Project Tree.PTree ID
	Path	Project.Project Path	Project Tree.PTree Path
	Created	Project.Created	Project Tree.Created
	Custom Auto-Deletion Rules	Project.Project-Wide Auto-Deletion?	-
Analysis Information for Last Analysis of Project (shown for projects only)	Last Analysis ID	Analysis ID	-
	Last Analysis	Analysis	-
	Last Analysis Description	Analysis Description	-
	Last Analysis Protected from Auto-deletion	Protected?	-
	Started *	Started	-
	Linking Started	Linking Started	-
	Finished	Finished	-
	Modified	Modified	-
	State *	State	-
	Username	Analysis Launch Daemon . System User	-
	Hub User	Analysis Launch Daemon . Hub User	-
	Machine	Analysis Launch Daemon . Machine	-
	Address	Analysis Launch Daemon . Address	-
	Install	Analysis Launch Daemon . Installation	-
	Warning Count	Warning Count	-
	File Count	File Count	-
	Dry Run	Dry Run?	-
	.prj_files Location	Analysis Directory . prj_files Location	-
	Every built-in and user-defined analysis-granularity metric class present in at least one analysis that has taken place on the hub (subject to ANALYSIS_READ permission), each labeled with the metric class description. Lines With Code (LCode) is displayed by default.		-
	Every user-assigned property that is associated with at least one analysis that has taken place on the hub (subject to ANALYSIS_READ permission), each labeled with the property key. If a property value contains a URL, the URL is displayed as a hyperlink. By default, no user-assigned properties are displayed.		-
Role-Permissions	* ("Permissions Link")	Click to navigate to the corresponding Project Role-Permissions page.	Click to navigate to the corresponding Project Tree Role-Permissions page.

Note on warning counts and metric values: If the analysis is still in progress, values in warning count and metric columns reflect the current values. Metric values will be finalized once the analysis reaches the Topologically Sorting Procedures state, warning counts will be finalized once the analysis is Finished.

Annotation Import/Export Links

An Export link is always available on the Home page. If warning group sharing is ON, an Import link is also available. See Importing and Exporting Annotations for full details.

Remove Projects button

Click to delete one or more of the projects or project trees in the table from the hub. See Task: Delete Multiple Projects or Project Trees (or both) for detailed instructions.

Move Projects button

Click to move one or more of the projects or project trees to a different parent project tree. See Task: Move Multiple Projects or Project Trees (or both) for detailed instructions.

Standard Footer

See GUI Reference: Standard Footer.

Project Tree Outline

The Project Tree Outline provides an overview of the hub's project tree hierarchy for orientation and navigation.

In its collapsed state, the Project Tree Outline is indicated by a shaded bar at the left of the Home page and all Project Tree pages. It is expanded by default if it has contents other than the root project tree.

screenshot fragment: clicking shaded bar to expand Project Tree Explorer.

The outline includes all project trees on the hub for which the user has PTREE_EXISTS permission, along with all ancestors of such trees (regardless of the ancestor permissions). The trees and subtrees are always ordered so that the project tree path to the current project tree is at the top of the display, and the current project tree is highlighted.

Click any project tree name to navigate to the corresponding Project Tree page.
Click [+] next to a project tree name to expand the subtree under that tree; click [-] to collapse the subtree again.
Click >>>more at the bottom of a subtree listing to display the remainder of that subtree.

Expanding, Resizing, and Collapsing

expanding	To expand the Project Tree Outline from its collapsed state, click the shaded bar.
resizing	To resize, drag on the right edge of the Project Tree Outline.
collapsing	To collapse it from its expanded state, drag the right edge to narrow the Project Tree Outline until the shaded bar reappears.

Example

For example, consider a hub with several project trees and two users. User A has a broad set of permissions that include PTREE_EXISTS permissions for all project trees, while User B has far more restrictive permissions and only has PTREE_EXISTS permission for one of the project trees. The two users are presented with different Project Tree Outline contents, as shown in the following table.

User	Elements with EXISTS permission (PTREE_EXISTS/PROJECT_EXISTS)	Project Tree Outline Contents (fully expanded)
A		The user has PTREE_EXISTS permissions for all project trees, so the entire hierarchy is displayed.
B		The user has PTREE_EXISTS permission for the project tree named "Other Subteam", so that project tree and all its ancestors are displayed. The user has no other PTREE_EXISTS permissions, so no other project trees are included.

User

Elements with EXISTS permission
(PTREE_EXISTS/PROJECT_EXISTS)

Project Tree Outline Contents
(fully expanded)

project tree hierarchy where user has all EXISTS permissions

corresponding project tree outline contents where user has all EXISTS permissions

The user has PTREE_EXISTS permissions for all project trees, so the entire hierarchy is displayed.

project tree hierarchy where user only has EXISTS permissions on two leaves

corresponding project tree outline contents where user only has EXISTS permissions on two leaves

The user has PTREE_EXISTS permission for the project tree named "Other Subteam", so that project tree and all its ancestors are displayed. The user has no other PTREE_EXISTS permissions, so no other project trees are included.

Navigating from

view more information about a project	Locate the desired project in the table and click anywhere in that line. With the default hub configuration, this will navigate to the Analysis page for the most recent analysis of the project. The hub can also be configured so that this navigates to the Project page for the project.
view more information about a project tree	Locate the desired project tree in the table and click anywhere in that line.
view a summary table or chart for the hub	Expand the Charts and Tables section, then select the desired chart or table link.
view the undefined functions report for the hub	Expand the Charts and Tables section, then select table link next to undefined functions.