Creating and Managing Custom Fields for Inventory

The standard fields used to describe OSS and third-party inventory or to define projects in Code Insight might not provide all the detail that your site requires to manage these entities. For example, to process and finalize a Bill of Materials for your product, you might want to know whether a thorough inbound review of a given inventory item has been completed or what encryption algorithms are used for a given inventory item.

To address this need for additional detail, Code Insight enables the System Administrator to create and manage custom fields that are available for all projects or for all inventory across the projects in your Code Insight system. Project Analysts and Reviewers can then update the values for these fields for any inventory item. They can also filter inventory on custom field values at the project and global levels.

Depending on its configuration, a custom field for inventory can be made available in both the Code Insight Web user interface (that is, on the Project Inventory tab and in the Analysis Workbench) and the Code Insight REST API. Alternatively, the field can be configured to be visible in the REST API only.

Currently, a maximum of five custom inventory fields can be created.

note

Once a custom field is created, it cannot be deleted. However, it can be disabled and re-enabled as needed.

The following describes how to create and manage custom fields for inventory:

• Success Messages When Creating or Updating Custom Fields

• Creating a Custom Field for Inventory

• Attributes Used to Define a Custom Field for Inventory

• Editing a Custom Field for Inventory

• Disabling or Re-enabling a Custom Field for Inventory

• Availability of a Custom Field for Inventory