Debug UI customizations for a Service Catalog page

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 2 minutes de lecture

    • Perform the health check of a Service Catalog page. The UI Page Customization Diagnostics window displays the UI macros applicable for the Service Catalog page and their corresponding states. For issues on a Service Catalog page due to customized UI macros, you can identify the source of broken functionality.

    Avant de commencer

    Role required: admin or catalog_admin.

    Watch this seven-minute video to learn more about UI customization debugging, variable action logger, variable watcher, and the Item Diagnostic report.

    Procédure

    1. Navigate to All > Service Catalog > Catalog Administration > Debug UI Customization.
      The UI Page Customization Diagnostics window is enabled.
    2. Navigate to a Service Catalog page that you want to debug.
    3. Review the information in the UI Page Customization Diagnostics window at the bottom of the page.
      To maximize the UI Page Customization Diagnostics window, click Icon to maximize the window. The following information is displayed:
      • Name of the current Service Catalog page.
      • State of the Service Catalog page.
      • All UI macros applicable for the Service Catalog page.
      • State of each UI macro. For details on possible states, click the Help icon (Help icon).
      • Number of occurrences of each UI macro in the Service Catalog page.
      Tableau 1. Possible states for a UI macro and a Service Catalog page
      State Color indicator Description
      Unchanged Green Created by ServiceNow and one of the following scenarios is applicable:
      • It has never been customized by the customer.
      • It has been customized by the customer and then reverted to the latest ServiceNow upgrade.
      Skipped Red Created by ServiceNow and then customized by the customer, and hence skipped the latest ServiceNow upgrade. The customer should resolve a skipped update after an upgrade.
      Customized Orange Created by ServiceNow, and then customized by the customer after the latest ServiceNow upgrade. The customer can revert a customization to implement the latest ServiceNow upgrade.
      New Blue Created by the customer. The top element of the UI macro should have the following attribute:
      data-sn-macro-sys-id="${jvar_macro_sys_id}"
      Remarque :
      The top element can be a div, span, or table.
      Remarque :
      • When you click the Service Catalog page name or the UI macro name, the corresponding UI page or the macro page is displayed.
      • When you point to a macro in the UI Page Customization Diagnostics window, the corresponding UI elements are displayed with a pink border.
      • The state-based color indication is applicable only for UI macros that have a visible UI.
      Figure 1. UI Page Customization Diagnostics window
      Screenshot for the UI Page Customization Diagnostics window
    4. To minimize the UI Page Customization Diagnostics window, click Icon to minimize the window.