The main menu consists of the following sections: Projects, Scans, Components, Licenses, Tools, Users, System Utils, and Help.
Project-scan relation: Scans performed with the Workbench are intended to be grouped by project. Projects have their respective user access groups, which allows you to select which users you want to provide access to a specific project. Access to a given project unlocks access to its corresponding scans. Alternatively, you can create scans without assigning them to projects if you decide so, but beware that you will not be able to share those scans with other users.
Projects section allows you to inspect all the projects you have access to. Clicking on a specific project will show you the list of active scans that belong to that project. For the projects that are created by you, you also have the ability to edit the corresponding meta-data, manage which users have access to it (and the corresponding scans) and manage the list of whitelisting rules linked to them.
Scans section provides with you the possibility to create new scans or edit, archive or delete existing scans. Note that the list of scans that you have access to is divided in active and archived scans. Scans are created active by default. Archiving scans gives you the ability to delete the uploaded files (to free up memory space) while preserving all made identifications. Opening archived scans shows you a report including file identifications. Deleting an active or archived scan will remove all information related to the audit, including identifications.
The status of each scan is displayed in the list in the form Process(STATUS). Values for STATUS are QUEUED, STARTING, RUNNING and FAILED. The status for a scan where no process is running and where the last running process succeeded will be “Idle”.
| Process | Description |
|---|---|
| Del | Deleting scan |
| DepCl | Cleaning up after dependency analysis |
| Dep | Performing dependency analysis |
| Arch | Archive file extraction |
| Notice | Notice file creation |
| Scan | Performing FossID scan |
| Clean | Cleaning up after FossID scan |
| Import | Importing report |
Components section shows you a list with all the software components that have been previously created. From this interface, you can edit or delete existing components, or create new ones, provided that you have the corresponding permission (see Permissions Overview).
Licenses section shows you a list with all the software licenses in your Workbench instance. Newly installed Workbench instances come preloaded with all SPDX defined licenses, and they all use SDPX identifiers (for easy post processing of scan data). From this interface, you can edit or delete existing licenses, or create new ones, provided that you have the corresponding permission (see Permissions Overview).
Tools section provides access to interfaces for Quick View, Snippet Search and VulnSnippet Finder.
Users section provides access to interfaces for Users and Roles management. This is used to create and modify user accounts and to set up and assign roles. A role is defined by a set of permissions.
System Utils section provides access to various interfaces to configure and maintain the Workbench instance. Most of these require specific permissions such as SYSTEM_ACCESS or EDIT_FOSSID_CONFIGURATION.
Help section provides access to the FossID documentation and API test.