Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home Orlando Now Platform Capabilities Now Platform capabilities Service Portal Service Portal widgets Widget developer guide Widget diagnostics

    Widget diagnostics

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Widget diagnostics

    Resolve Service Portal page issues by identifying widget customization levels and checking widget code directly from a portal page.

    If a portal page isn't working as expected, it may be because of a bug in widget code. To diagnose the page, try diagnosing the widgets on the page.

    Diagnosing widgets involves:
    • Identifying widget customization levels
    • Checking the code that is used in each widget

    Identifying customization levels

    Customization levels describe how widgets have been modified or developed. Identifying the customization level of a widget can help you know which part of the widget code is most important to check. There are four levels of widget customization.
    Customization level Description
    Base system Base system widget with no modifications, including widgets for which you have set instance options.
    Cloned Widget that you cloned from a base system widget.
    New Widget that you created.
    Customized Base system widget that you configured in any of the following ways:
    • Modified the widget code directly
    • Modified widget option schema
    • Modified widget dependencies, ng-templates, or Angular Providers

    To identify the customization levels of widgets on a portal page, open the widget context menu and select Show Widget Customizations. Widgets are color-coded as follows:

    Identifying customization levels
    • Green – base system widget
    • Yellow – cloned widget
    • Blue – new widget
    • Red – customized widget

    Checking the widget code

    After you've identified the customization levels of widgets on a portal page, check the code in each widget.

    To view the widget code from the portal page, click the information icon (Information icon) on a widget.

    Widget diagnostics window
    From the widget diagnostics window, you can check the widget code in several ways:
    • View a widget record from a portal page

      View and identify potentially problematic code in the widget record without navigating away from the portal page.

    • View related records

      View and identify potentially problematic code in the widget dependencies, Angular Providers, and ng-templates that are being used by the widget.

    • Compare changes to related records

      Compare an Angular Provider or ng-template against its previous version so that you check if your most recent code changes are causing issues on a portal page.

    • Compare changes to a customized widget

      Compare your most recent update of a customized widget against the previous version to check if your recent changes are causing issues on a portal page.

    • Compare a customized widget against the base system

      Identify customizations to a base system widget so that you can revert your customized widgets and resolve issues on a portal page.

    Recommendations for diagnosing widgets

    Of the four customization levels, the highest priority issue is customized widgets. These widgets aren't supported in system upgrades. If you're experiencing page issues during an upgrade, it may be because you have a customized widget on your portal page.

    To resolve page issues that may be caused by customized widgets, identify which parts of the widget code have been customized. Then revert the code to the original configuration. For more information on identifying these code differences, see Compare a customized widget against the base system.

    Tip: Even if a customized widget is not causing page issues now, you may want to revert to the original widget to prevent issues during upgrades later.

    If you're still experiencing page issues after reverting customized widgets, check your new and cloned widgets next.

    With a new widget, it's likely that your most recent code changes are causing issues on your portal page. To identify your most recent changes so that you can debug your code, follow the steps in Compare changes to related records.

    If you cloned a widget prior to a system upgrade, it's likely that the cloned widget didn't receive the same updated code as the base system widget. In this case, it's recommended that you clone the widget again and add your customizations to the clone.

    A base system widget is least likely to cause page issues. If you've already checked other widgets and are still experiencing page issues, remove base system widgets from the page and add them again without any widget options set. You can also try adding base system widgets to another page instead.

    Limitations

    There are several known limitations using widget diagnostics from a portal page:
    • Although you can view and compare widget code, you can't fix or revert code directly. Navigate away from the portal to change the code.
    • If you navigate to another portal page while using widget diagnostics, the system disables the tool.
    • Because the tool uses color to categorize widgets, it may not be accessible for visually impaired users.
    • The widget dependencies that are listed on the portal page reflect only the first-level dependencies. Any dependency that is nested deeper than the first level is not included. To further troubleshoot the widget, check the nested dependencies in the widget record.
    • There is no way for the system to track a Widget Dependency after you've deleted it.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Widget diagnostics

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Widget diagnostics

      Resolve Service Portal page issues by identifying widget customization levels and checking widget code directly from a portal page.

      If a portal page isn't working as expected, it may be because of a bug in widget code. To diagnose the page, try diagnosing the widgets on the page.

      Diagnosing widgets involves:
      • Identifying widget customization levels
      • Checking the code that is used in each widget

      Identifying customization levels

      Customization levels describe how widgets have been modified or developed. Identifying the customization level of a widget can help you know which part of the widget code is most important to check. There are four levels of widget customization.
      Customization level Description
      Base system Base system widget with no modifications, including widgets for which you have set instance options.
      Cloned Widget that you cloned from a base system widget.
      New Widget that you created.
      Customized Base system widget that you configured in any of the following ways:
      • Modified the widget code directly
      • Modified widget option schema
      • Modified widget dependencies, ng-templates, or Angular Providers

      To identify the customization levels of widgets on a portal page, open the widget context menu and select Show Widget Customizations. Widgets are color-coded as follows:

      Identifying customization levels
      • Green – base system widget
      • Yellow – cloned widget
      • Blue – new widget
      • Red – customized widget

      Checking the widget code

      After you've identified the customization levels of widgets on a portal page, check the code in each widget.

      To view the widget code from the portal page, click the information icon (Information icon) on a widget.

      Widget diagnostics window
      From the widget diagnostics window, you can check the widget code in several ways:
      • View a widget record from a portal page

        View and identify potentially problematic code in the widget record without navigating away from the portal page.

      • View related records

        View and identify potentially problematic code in the widget dependencies, Angular Providers, and ng-templates that are being used by the widget.

      • Compare changes to related records

        Compare an Angular Provider or ng-template against its previous version so that you check if your most recent code changes are causing issues on a portal page.

      • Compare changes to a customized widget

        Compare your most recent update of a customized widget against the previous version to check if your recent changes are causing issues on a portal page.

      • Compare a customized widget against the base system

        Identify customizations to a base system widget so that you can revert your customized widgets and resolve issues on a portal page.

      Recommendations for diagnosing widgets

      Of the four customization levels, the highest priority issue is customized widgets. These widgets aren't supported in system upgrades. If you're experiencing page issues during an upgrade, it may be because you have a customized widget on your portal page.

      To resolve page issues that may be caused by customized widgets, identify which parts of the widget code have been customized. Then revert the code to the original configuration. For more information on identifying these code differences, see Compare a customized widget against the base system.

      Tip: Even if a customized widget is not causing page issues now, you may want to revert to the original widget to prevent issues during upgrades later.

      If you're still experiencing page issues after reverting customized widgets, check your new and cloned widgets next.

      With a new widget, it's likely that your most recent code changes are causing issues on your portal page. To identify your most recent changes so that you can debug your code, follow the steps in Compare changes to related records.

      If you cloned a widget prior to a system upgrade, it's likely that the cloned widget didn't receive the same updated code as the base system widget. In this case, it's recommended that you clone the widget again and add your customizations to the clone.

      A base system widget is least likely to cause page issues. If you've already checked other widgets and are still experiencing page issues, remove base system widgets from the page and add them again without any widget options set. You can also try adding base system widgets to another page instead.

      Limitations

      There are several known limitations using widget diagnostics from a portal page:
      • Although you can view and compare widget code, you can't fix or revert code directly. Navigate away from the portal to change the code.
      • If you navigate to another portal page while using widget diagnostics, the system disables the tool.
      • Because the tool uses color to categorize widgets, it may not be accessible for visually impaired users.
      • The widget dependencies that are listed on the portal page reflect only the first-level dependencies. Any dependency that is nested deeper than the first level is not included. To further troubleshoot the widget, check the nested dependencies in the widget record.
      • There is no way for the system to track a Widget Dependency after you've deleted it.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login