Install the supported applications for Software Bill of Materials

  • Release version: Xanadu
  • Updated January 14, 2025
  • 3 minutes to read
  • Download and activate the required applications for the Software Bill of Materials (SBOM) application prior to uploading files.

    Before you begin

    Roles required: admin for download, installation, and activation of all applications and role assignments in your instance.

    About this task

    Procedure

    1. Download the required SBOM applications from the ServiceNow Store into your ServiceNow instance.

      These applications enable you to upload and import SBOM files into your instance. You can view BOM entity and component data in the SBOM Workspace if you have SBOM Core installed.

      You can view BOM entity, component data, and data visualizations in the SBOM Workspace if you have SBOM Response installed.

      • Data Model for SBOM
      • SBOM Core
      For more information about downloading and activating applications, see the following:
    2. Optional: If you want to view your SBOM data in the SBOM Workspace, view imported third-party vulnerability intelligence, assess your risk exposure, and remediate vulnerabilities with the Application Vulnerability Response and Vulnerability Response workflows, download the following applications:
      • Vulnerability Response and its dependencies
      • Vulnerability Response Integration with NVD
      • SBOM Response

      For more information about these and other supported SBOM applications, see Exploring Software Bill of Materials.

    3. After you have downloaded the applications, navigate to All > System Applications > All Available Applications > All.
    4. Locate the SBOM applications that you downloaded and select Install to activate them along with their dependencies.

      A message is displayed after an application is successfully activated. Activate the applications in the following order:

      • Vulnerability Response and its dependencies
      • Vulnerability Response Integration with NVD
      • Data Model for SBOM
      • SBOM Core
      • SBOM Response, which includes the OSV.dev and Deps.dev integrations and supports the Policy as Code Engine (PaCE) interface in the SBOM Workspace.

      See Configuring the Deps.dev, OSV.dev, and PaCE integrations for Software Bill of Materials for more information about configuring these integration applications after you have installed SBOM Response.

    5. Optional: Activate integrations by navigating to All > System Applications > All Available Applications > All and selecting Install.

      For more information about these integrations and the capabilities they provide, see Exploring Software Bill of Materials.

      A message is displayed after an application is successfully activated.

    6. Assign the following roles to users.
      • sn_sbom_dm.app_create
      • sn_sbom_dm.app_read
      • sn_sbom_dm.app_write
      • sn_sbom_core.sbom_ingest
      • sn_sbom_core.admin
      • sn_sbom_resp.sbom_analyst
      • sn_sbom_resp.manage_avi_rule
      • sn_sbom_response.managelicense
      • sn_sbom_response.licenseresolver
    7. Optional: Assign users to the App-Sec Manager group if you are creating application vulnerable items for vulnerabilities in your imported SBOM data.

      Users assigned to the App-Sec Manager group prioritize and manage application vulnerable items. Users in this group inherit many of the roles required for reading and editing records and configuring the applications supported by the Application Vulnerability Response application and its remediation workflows.

    8. Optional: Deactivate the Reopen AVITs if detected (sn_sbom_resp.reopen_avits_if_detected) system property if you don't want Closed AVITs to transition back to the Open state automatically.

      A Closed application vulnerable item (AVIT) for a component with an associated vulnerability is re-opened (set to Open) automatically and visible in the SBOM Workspace if the following conditions exist:

      • The AVIT with the associated vulnerability is detected again by a third-party integration's vulnerability scans or the component with the vulnerability is part of a subsequent SBOM upload.
      • You have not deactivated the Reopen AVITs if detected (sn_sbom_resp.reopen_avits_if_detected) system property. This system property is activated by default.
      • The substate of the Closed AVIT is not one of the following: Mitigation Control in Place, Not Affected, or False Positive. AVITs with these substates are not reopened by the system property.

    What to do next

    Upload your SBOM files. See Upload Software Bill of Materials files manually and Uploading Software Bill of Materials files using a REST API for more information.