Project Summary Tab

Code Insight 2020 R3

The Summary tab for the project allows you to add and edit users who can work in Code Insight, view scan settings and status, generate reports, and manage projects. The page contains the following fields:

Project Summary Tab

Category

Column/Field

Description

Project Details

These field describe the project attributes. You can edit these details using the Manage Project | Edit Project and Manage Project | Edit Project Users options available on this Summary tab.

Note:For inventory-only projects migrated from Code Insight 2020 R2 or earlier, a legacy attribute, Project Type, will also display. However, for migrated standard projects, this attribute is no longer required and therefore does not display. See also Legacy Projects.

Name

The name and ID of the selected project.

Owner

The hyperlinked name of the person who owns the project. Click the name to open your default email program to send an email to the Project Owner.

Legal Contact

The hyperlinked name of the default legal contact assigned to tasks created to review legal issues in the project inventory. Click the name to open your default email program to send an email to the contact.

For details on changing the default legal contact, see Updating Inventory Review and Remediation Settings for a Project. If no changes are made to the initial default contact (the Project Owner) or if the automated legal-review process is disabled, this value shows the Project Owner name.

Security Contact

The hyperlinked name of the default security contact assigned to tasks created to review security issues in the project inventory. Click the name to open your default email program to send an email to the contact.

For details on changing the default security contact, see Updating Inventory Review and Remediation Settings for a Project. If no changes are made to the initial default contact (the Project Owner) or if the automated security-review process is disabled, this value shows the Project Owner name.

Developer Contact

The hyperlinked name of the default development contact assigned to remediation tasks created to take action on code-related issues in the project inventory. Click the name to open your default email program to send an email to the contact.

Tor details on changing the default development contact, see Updating Inventory Review and Remediation Settings for a Project. If no changes are made to the initial default contact (the Project Owner) or if the automated remediation process is disabled, this value shows the Project Owner name.

Description

A description of the project, if provided in the project definition, appears in this field.

Project Visibility

The visibility of the project:

•

Public—A project visible to all users in the system. Users assigned to roles for the project can perform various maintenance functions based on their permissions.

•

Private—A project visible to and accessible by only those users assigned to roles for the project.

Project Risk

The project vulnerability risk value (Low, Medium, or High).

Project Hierarchy

Links to the projects that have been defined as parent and child projects of the current project. These links provide a means to easily navigate to projects directly related to the current project. (Relationships between projects are established by the creation of project hierarchies, as described in Identifying Child Projects for a Project.)

When you click a Project Hierarchy link, a dialog is displayed listing the direct links to the parent or child projects.

Click a link on the dialog to open the given child or parent project on its Project Inventory tab. From here you can navigate the project as needed.

Project Status

The current status of the project that can be manually updated through the Manage Project | Edit Project menu option available on this tab. Available status types include:

•

Not Started—Indicates that the project scan results are not available for manual analysis. This value automatically defaults when the initial project scan has not been run or when the initial scan fails. However, you can manually change this status.

•

Analysis in Progress—Indicates that the project scan results are available for manual analysis, or a manual analysis is underway. This value is automatically set when the initial project scan is complete. (For a project import, however, the status of the target project is retained.) You can manually change this status.

•

Analysis Completed—Indicates that manual analysis is finished; and the published inventory is ready for legal, security, or software-engineering review. (You must manually set this value.)

•

Project Complete—Indicates that the project analysis and review processes are complete, and notices content for all OSS and third-party software is finalized. (You must manually set this value.)

For more information, see Editing the Project Definition and General Settings and Edit Project: General Tab.

The name of the profile associated with this project.

Scan Settings

The following fields show scan configuration details. You can edit these details on the Scan Settings tab accessed using the Manage Project | Edit Project option available on this tab.

Scan Profile

The name of the scan profile associated with this project. Click to view the details of the scan profile.

Scan Paths

The absolute path for each scan folder for the project. A given scan folder contains files for either:

•

A codebase scanned by the Scan Server.

•

A codebase scanned by a Code Insight scan-agent plugin on a remote Engineering system. (The results of the remote scan are sent to the project.) For more information, see Performing a Remote Scan.

Click to view the details about Scan Server or the scan-agent plugin.

Scan Status

The following fields provide information about current and historical scans for this project. For more information about scans, see About Code Insight Scans.

Scan Server Status

The server scan status for this project:

•

If you have started a server scan for this project, but the scan has been placed in queue, this field shows “Scan Scheduled”. The Scan Progress field provides a link to view the scan queue and other details (see the “Scan Progress” description below).

•

If the server scan you scheduled for this project is running, this field shows “Project being scanned”. The Scan Progress field keeps track of the number of files that have been scanned.

•

When the server scan for this project completes, this field shows “No scan scheduled” and provides link to schedule another scan. (If the Scan Server is disabled, the link is also disabled.) The Scan Progress field is not available when this status is in effect.

Scan Progress

(Available only when a server scan for the project is scheduled or is running) The progress of the scan as follows:

•

If the scan has been placed in queue, this field shows “In Scan Queue” and provides a Show Details link to open the Scan Server Status window. This window identifies the scan server, shows the project currently being scanned by the server, lists the other project scans (if any) currently waiting in queue order (up to 25 scans), and provides an email link for the owner of each project listed. You cannot sort or reorganize the queue list.

•

If the scan you scheduled is running, this field keeps track of the number of files that have been scanned against the total number of files to scan in the project.

Last Server Scan

The final status of the last server scan for the project and a statistical summary of files, disk space, and lines of code scanned. The following are available scan statuses:

•

Completed—The scan succeeded with no warnings during the scan or the analysis phase. This message appears on the screen in green.

•

Completed with warnings—The scan succeeded but the analysis phase produced warnings. For more information, check scanEngineDetail log for the Scan Server.

•

Failed—The scan failed. This message appears on the screen in red. For more information, see Scan Failure Reasons and Troubleshooting Measures.

Past Server Scans

Click the hyperlinked term here to view a history of the server scans performed for the project. If a server scan has not yet been performed for the project, the list will be empty.

Last Remote Scan

Statistics for remote scans:

•

The total number of scanned codebase files across all scan agents associated with the project.

•

The total number of inventory items created across all scan agents associated with the project.

•

The combined size of all agent-scanned codebases.

For information about remote scans, see Performing a Remote Scan.

Note:If the project is a newly migrated inventory-only project from Code Insight 2020 R2 or earlier, only the statistics for the scan agent that last performed a scan (on the previous Code Insight version) are shown.

Reports

These fields provide access to reports. If the report has been generated, the field shows the report generation timestamp and provides links to view or download the report. If the report has not been generated, select the report from the Select Report dropdown and click Generate Report. The standard Code Insight reports are described below. If custom reports have been created, they are also available on the Select Report dropdown. If a custom report requires that you select a second report for comparison purposes, a Select Project or Change button is displayed, enabling to select or change projects for the report.

Project Report

Provides status information about and access to the Project Report. This report summarizes the inventory, vulnerabilities, remaining scan evidence, and review and remediation tasks for the current project.

Audit Report

Provides status information about and access to the Audit Report. This report provides one means to distribute your research and findings to others in your organization. Only published inventory items appear in Audit reports.

Notices Report

Provides status information about and access to the Notices Report. This report is a compilation of the license (notices) content for all the open source/third-party components contained in the product.

Actions

The following buttons enable to perform functions on your project.

Start Scan

Click to start a server scan—the initial scan or a rescan—on the project codebase.

If the Scan Server is disabled, this button is disabled.

If you are performing a rescan, an incremental scan (that is, a scan on only changed codebase files) is performed by default. To force a full codebase rescan, click the drop-down arrow to the right of this button and select Full Rescan. (This option is enabled only if a successful initial scan has been run on the project codebase.)

For more information about scans and rescans, see Scanning the Codebase (Server Scans) and Performing a Rescan of Your Codebase (Server Scans Only).

Generate Report

Click to generate a Project, Audit, Notices, or custom report in the background.

Upload Project Codebase

Click to upload a codebase on which you will perform a server scan for the selected project. To upload multiple codebases, repeat the upload process by clicking this button for each codebase. You can also use this option to overwrite the current codebase with a more recent version.

If the current project is not associated with a Scan Server or if the Scan Server is disabled, this button is disabled.

Note:Alternatively, you can synchronize the project with one or more remote Source Control Management (SCM) codebase repositories (see Configuring Source Code Management). You can also both upload codebase files and synchronize with SCM repositories to provide the complete project codebase on which to run the server scan.

Manage Project

A dropdown menu that allows you to edit project settings, assign user roles for the project, export and import project data, delete a project, or change the project owner.

Project Summary Tab

Code Insight 2020 R3 User Guide

September 2020