Viewing and Updating Notes and Guidance

Code Insight 2021 R1

The Notes & Guidance tab can provide notes about the automated and manual analysis performed on the codebase as it relates to the current inventory item. The tab can also include guidance on how to remediate issues associated with your product’s use of the OSS or third-party software identified by the inventory item.

To view notes and guidance, do the following:

1. Open the Project Inventory tab for the desired project (see Displaying Project Inventory).
2. Select an inventory item from list.
3. Select the Notes & Guidance tab.
4. Review or update content in the following fields as needed. All information is editable except for the information in the Detection Notes field:
Detection Notes—Information generated during the scan to explain the means by which OSS or third-party software was detected in the codebase. This information is not editable. For more details, see Viewing and Updating Detection and Auditing Notes in the Analysis Workbench.
Audit Notes—Information recorded about the analysis of the codebase associated with this software. For example, these notes might indicate that the inventory item needed to be manually created.
Usage Guidance—Any information about why and how your product is using the software and any requirements for using the software.
Remediation Notes—A description of items to be addressed or actions to be taken before the use of this software in your product is acceptable from a legal or security standpoint.
5. Click Save in any field in which you have made changes.
6. When you have finished with this tab, navigate to another tab for the inventory item, or select another inventory item.