SBOM Observer Docs logoSBOM Observer Docs

Custom Fields

Configure custom fields to customize the data model and user interface


Properties

Properties are key → value fields that can be used to extend both the SBOM data models (CycloneDX and SPDX) and SBOM Observer's internal Data Model with custom data. Properties are found both in the index and annotations for components, suppliers and advisories. Properties can be standardized or custom to an organization (or namespace).

Custom Fields

Custom fields allow you to provide structure, including custom labels, to properties that are commonly used in an organization (or namespace). Custom fields can also be used to provide descriptive labels to existing standardized properties.

Custom fields are available for both components and suppliers.

How Custom Fields work

(configure at Settings → Data Model.)

When you create a Custom Field you define:

  1. Field Name: A user-friendly label that appears in the UI (e.g. "Contract Number")
  2. Property Key: A property key used to store the values of the field (ex. internal:suppliers:contract:number)

Custom fields will get their own section in the UI (including forms), separate from other properties.

screenshot