Project

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

Project

A project groups the historical and current CodeSonar analyses of a single software project, and also stores summary information.

Projects are securable resources.

The various PROJECT_* permissions control access to project information. For a given role R and project P, role R may have one or more of these permissions directly assigned to P, resource-inherited from a project tree that directly or transitively contains P, or any combination of these.
Each role also has, through direct assignment and resource inheritance, a (possibly empty) set of ANALYSIS_* permissions for each project. These role-permissions are resource-inherited by all analyses of the project.

Properties
Creating/Deleting
Accessing Project Information

The project has two main roles.

It provides a mechanism for grouping all the CodeSonar analyses of a single software project.
Every time you build and analyze a CodeSonar project, you specify a project name. When the analysis results are sent to your specified hub, the name is used to relate them to any past analyses of the project. This has several advantages:
- It is easy to trace the history of analyses for a single project, and to see which is the most recent.
- CodeSonar can identify cases where the "same" warning, or a closely related one, occurs in multiple analyses of the same project.
It serves as a location for storing summary information about these analyses. The information stored for each project is described below.

Properties

This section describes each of the properties of a project. The full list of properties is (in alphabetical order):

Ancestors
Created
Name

Last Analysis
Parent Project Tree
Project Description

Project ID
Project Path
Project-wide Auto-deletion?

Name
( Search Language Field Name, if any)

Description

Name
( project)

The name of the project. Users can change the project name, provided that this does not cause a conflict.

Project ID
( pid)

A unique ID for the project. The main place that users see the Project ID is in the URL for the Project page.

Project Description
( pdesc)

A user-specified string containing a project description.

Project-wide Auto-deletion?
( autodelete)

"True" if project-wide auto-deletion settings are currently enabled for this project; "false" if they are currently disabled (and so the hub-wide auto-deletion settings apply).

Created
( created)

The date and time at which the first user command related to the project was run (usually, this will be the first build/analysis of the project).

Last Analysis

The most recent analysis performed on the project.
The GUI and project search language provide direct access to several Last Analysis properties.

(last_address)	Analysis Launch Daemon . Address
(last_adesc)	Analysis Description
(last_analysis)	Analysis
(last_dryrun)	Dry Run?
(last_filecount)	File Count
(last_finished)	Finished
(last_install)	Analysis Launch Daemon . Installation
(last_machine)	Analysis Launch Daemon . Machine
(last_prjfiles)	Analysis Directory
(last_protected)	Protected?
(last_started)	Started
(last_user)	Analysis Launch Daemon . System User
(last_warningcount)	Warning Count

Parent Project Tree

The project tree that directly contains the project.
The GUI and project search language provide direct access to several Parent Project Tree properties.

(parent)	PTree Name
(parent_id)	PTree ID

Project Path
ptree_path

Derived from the project's Ancestors and Name: the full path from the hub's root project tree to the project.
The Project Path for a project P is always displayed and specified as a /-separated sequence of the form ptreepath/ proj_name, where:

ptreepath is P . Parent Project Tree . PTree Path.
proj_name is P . Name.

For example, suppose we have a project P that is named N, and whose parent project tree T is named Tname.

If T is the root project tree, the Project Path for P is /N.
If T is a child of the root project tree, the Project Path for P is /Tname/N.
If T is a child of a project tree named Sname that is itself a child of the root project tree, the Project Path for P is /Sname/Tname/N.

Ancestors
ancestor

Derived through the project's Parent Project Tree: the full path through the project tree inheritance hierarchy from the hub's root project tree to the parent project tree.

For a project P, P.Ancestors is equal to P. Parent Project Tree. PTree Path.

For example, suppose we have a project P whose parent project tree T is named Tname.

If T is the root project tree, the Ancestors string for P is /.
If T is a child of the root project tree, the Ancestors string for P is /Tname.
If T is a child of a project tree named Sname that is itself a child of the root project tree, the Ancestors string for P is /Sname/Tname.

Creating and Deleting Projects

Projects can be created and deleted as shown in the following table.

Project Operation	Permissions Required	Method
Add a new project as a child of project tree T	PTREE_ADD_CHILD T	You can add a new project as a child of project tree T... ..by performing a CodeSonar build/analysis, specifying a project name that isn't already present on the hub[ ] and specifying T as the parent project by specifying the Project Path: Command line: -project option. Windows Build Wizard: Project* field on screen 1. Eclipse Plug-in: Project field in the project properties dialog. CodeSonar will create the project automatically. ... from the Project Tree page for T, in the Create Project section. ... if T is the root project tree: from the GUI Home page, in the Create Project section.
Change the name or description of project P	PROJECT_WRITE P	You can change the name and description for a project from its Project page.
Delete project P	PROJECT_DELETE P ANALYSIS_DELETE A for all analyses A of P	Suppose P is a project whose parent project tree is T. Then you can delete T ... ... from the Project page for P, in the Project Details section. ... from the Project Tree page for T, using the Remove Projects functionality. ... if T is the root project tree, or you do not have PTREE_READ T: from the the Home page, using the Remove Projects functionality.
Change the parent project tree of project P from T to U	PROJECT_WRITE P PTREE_ADD_CHILD U	Suppose P is a project whose parent project tree is T. Then you can change the parent project tree for P... ... from the Project page for P, in the Project Details section. ... from the Project Tree page for T, using the Move Projects button. ... if T is the root project tree, or you do not have PTREE_READ T: from the the Home page, using the Move Projects button.

[ *] For the sake of this operation, a project name is considered to be "present on the hub" if there is at least one project P on the hub such that P has that name and the user has PROJECT_EXISTS for P.

Accessing Project Information

Project information is available in the CodeSonar GUI as follows.

Project	Full information about a single project.
Project Search Results	A table with one line for each project that matches the search conditions.
Project Role-Permissions	View and modify role-permissions for a single project.
Home	A table that includes one row for every project that is a child of the root project tree.
Project Tree	A table that includes one row for every project that is a child of the current project tree.

To report problems with this documentation, please visit https://support.codesecure.com/.