Analysis Workbench

The Analysis Workbench is a facility that lets you examine the evidence in a project’s scanned codebase in your project and interact with the inventory resulting from the scan.

The Analysis Workbench has the following fields.

Note:For files scanned by a Code Insight scan-agent plugin on a remote system, only license evidence is currently reported in Code Insight. The Analysis Workbench indicates which remotely scanned files contain license evidence (a green icon is displayed next to the files under a remote scan-agent node in the Codebase Files and File Search Results pane) and lets you view this evidence on the Evidence Details pane and a file’s Evidence Summary pane.

Note:Some panes do not contain data until you choose a file in another pane.

Analysis Workbench

Column/Field

Description

Legend

A color-coded and hyperlinked guide to the files and inventory in your scanned codebase:

•

New Evidence

: Click this link to filter the search results to display only files that are new since the last scan. If only a single scan took place, all files with evidence are displayed in the Files Search Results pane.

•

Reviewed

: Click this link to display files in the File Search Results pane that have been reviewed.

•

Exact

: Click this link to display files in the File Search Results pane that are exact matches.

•

Copyrights

: Click this link to display files in the File Search Results pane that contain copyright text.

•

Email/URLS

: Click this link to display files in the File Search Results pane that contain email addresses and URLs.

•

Licenses

: Click this link to display files in the File Search Results pane that contain licenses.

•

Search Terms

: Click this link to display files in the File Search Results pane that match default search terms.

•

Source

: Click this link to display files in the File Search Results pane that match

Codebase Files pane

A tree listing the files in the project codebases. The tree can include one or more nodes, each node identifying a specific Scan Server or remote scan agent and listing the files scanned by that scanner. A given file in the list can show the following information:

•

If the file contains evidence, one or more color-coded indicators for the type of evidence. See the previous Legend description for the indicator meanings.

•

A check mark if the file has been reviewed.

To search for files and folders whose name contains a specific string, provide the string (at least three characters) in the Enter search string... field and click . The list is expanded as much as necessary to highlight the matching files. Click or to navigate to each result highlighted in the list.

To explore more information about a file and its evidence, click its hyperlinked file name. Alternatively, right-click the file name for more options (see Managing the Codebase Files for more information).

File Search Results pane

A tree listing the files resulting from a search (other than the name search used in the Codebase Files pane). The tree is organized by the nodes and directories containing the files. Drill down into the nodes and directories to view the files. A given file in the list can show the following information:

•

If the file contains evidence, one or more color-coded indicators for the type of evidence. See the previous Legend description for the indicator meanings.

•

A check mark if the file has been reviewed.

File Details tab

Click a codebase file in the Codebase Files or File Search Results pane on the left to open the Files Details tab (in the middle pane). This tab includes a expandable header that lists metadata about the selected codebase file, as well as the three sub-tabs—Evidence, Exact Matches, and Partial Matches—available to examine the file’s open-source or third-party evidence. For more information, see Examining and Managing Open-Source Evidence for a Given File.

Inventory Items (x) pane

The list of inventory items for the project. You can filter this list by published or not-published inventory or by inventory name.

Current View

The project inventory that is being displayed—inventory items filtered by codebase files to which they are associated or by inventory attributes.

Published (x)/Not Published (x)

Select the option to filter the inventory to all published or all not-published items. The x value is the number of each type.

If you filter by published or not-published items and then filter by Advanced Search criteria (or vice versa), the resulting inventory list is based on the published/not-published filter AND the Advanced Search criteria.

Clear Filter

Clears any inventory-list filters that have been applied (name, published, or not-published filters and Advanced Search filters).

Advanced Search

Click this button to perform an advanced search on the inventory (for example, by inventory review status, priority, confidence level or associated licenses, security vulnerabilities, tasks, and more). The Advanced Inventory Search Dialog is displayed.

inventory name filter

Enter a string by which to search and filter the inventory by name. As you type each character in the string, the list is automatically filtered according to the entered characters.

This current name filter is automatically copied to the Advanced Inventory Search Dialog if you perform an Advanced Inventory Search (by clicking Advanced Search). Likewise, if you enter a name filter on the Advanced Inventory Search dialog, it is copied back to this field. This behavior enables you to keep the name filter persistent. However, you can always change or remove the filter in either location.

Add New

Click to create a new inventory item. The New Inventory Item tab is opened. See Creating Inventory from the Inventory Items List for more information.

Name

The column listing the name for each inventory item in the Inventory Items list. Click the column header to sort the list alphabetically in ascending or descending order by inventory name.

To show or edit information about an inventory item, click the hyperlinked inventory name to open its Inventory Details tab (in the middle pane). See Inventory Details Tab in the Analysis Workbench for details.

#Files

The column listing the number of codebase files associated with each inventory item in the Inventory Items list. Click the column header to sort the list in ascending or descending order by the number of files associated with the items.

Publish

To publish an inventory item in the Inventory Items list, right-click the item and select Publish Inventory.

Recall

To recall a published inventory item in Inventory Items list if it does not fit the criteria for published inventory, right-click the item and select Recall Inventory. The status of the item is changed to “Not Published”.

Delete

To remove an inventory item from the Inventory Items list, right-click the item and select Delete.

Inventory Details tab

To show or edit information about an inventory item in the Inventory Items list, click the hyperlinked inventory item to open its Inventory Details tab (in the middle pane). See Inventory Details Tab in the Analysis Workbench for details.

Evidence Details

Click Evidence Details (in the middle pane header) to open the Evidence Details tab in the middle tab. From here, you can view a summary of OSS and third-party evidence found across the codebase during the last scan. You can also filter the evidence based on files selected in the Codebase Files pane; or filter the files in the Codebase Files pane by selected evidence.