Skip to content
Jillian Daguil edited this page May 16, 2017 · 33 revisions

aboutcode-logo

AboutCode Manager allows you take the scan results from the ScanCode Toolkit and create a component-level software inventory. The conclusions (Concluded License, Concluded Owner, etc.) you make when creating your component can then be exported to a JSON or SQLite file. In addition, Components created in AboutCode Manager can be exported to DejaCode

Views

Directory Tree

An interactive directory tree is always present on the left side of the application. The tree is expandable and collapsible. This allows the user to navigate the codebase structure. If a directory is selected, only that directory and its sub-files and folders will be shown in the view. Similarly, if a single file is selected, only information for that selected file will be shown.

aboutcode-manager-codebase-view

Table View

In the table view, the available clues detected by ScanCode Toolkit are shown in a tabular format. A user can see provenance clues such as license and copyright information detected by ScanCode Toolkit. A user can also see the file information (such as file type, file size, sha1, etc) and package information (package type, primary language of package) that was detected. The columns can be sorted as well as shown or hidden based on what the user’s preferences. Searching for specific clues (license names, copyrights, etc.) is also available in this view.

aboutcode-manager-table-view

Conclusions View

The node view is where a user can create components from packages or files in their codebase. Selecting the nodes of the tree will expand or collapse the code structure. The numbers next to the file name are intended to help the user navigate to directories with the most clues. The first number is the number of files contained in that directory. The second number is the number of detected clues from ScanCode Toolkit (for example, detected license and detected copyright). These numbers can help a user navigate to directories that have a large amount of scancode clues that were detected in proportion to files.

aboutcode-manager-node-view

Creating Components

A Component is a set of software packages or files that share a name, version, owner, license and copyright. A conclusion in the AboutCode Manager refers to documentation of your conclusion about the owner, copyright, and license for some set of software files at a Component level. To create a component, select the file name. A form appears where you can fill in concluded information.

aboutcode-manager-create-component

The following fields are available when creating a component:

  • Status - Used to document status of component creation (Analyzed - A component has been created, Needs Attention - A component is flagged for further review, Original Code - A component is from your organization)
  • Component - Primary component (usually a file, directory or library name)
  • Version - Component Version Number
  • License - This is the license for the Component
  • Owner - This is the owner of the Component
  • Copyright - The Copyright notice that applies to the Component under the License.
  • Notes - Comments that provide additional insight into the findings.

Node colors

  • Blue - The node is blue when no status has been set for the file or directory
  • Green - The node is green when a component is created.
  • Red - The node is red when the Status is set to Needs Attention
  • Purple - The node is purple when the Status is set to Original Code

It’s important to note that if you create a component at a directory level, the files underneath that directory are considered analyzed at that level. Our experience with hundreds of software audit projects is that you normally want to conclude and track provenance for software at the Component level.

Navigation

Panning

Use the mouse to pan. Hold down click and move mouse

Zooming

Use the scroll wheel to zoom. On Mac use two fingers to zoom.