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 New York Now Platform Capabilities Now Platform capabilities Service Portal Service Portal widgets Widget developer guide Widget API reference

    Widget API reference

    • 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 API reference

    Service Portal includes client and server side APIs to use in widget client and server scripts.

    Service Portal client-side APIs

    These are Service Portal APIs that you can use in a widget client controller.

    See the API reference for detailed class and method information.

    Class Description
    spAriaUtil Show messages on a screen reader.
    spContextManager Make data from a Service Portal widget available to other applications and services in a Service Portal page. For example, pass widget data to Agent Chat when it opens in a Service Portal page.
    spUtil Utility methods to perform common functions in a Service Portal widget client script.
    spModal Show alerts, prompts, and confirmation dialogs in Service Portal widgets. The SPModal class is available in Service Portal client scripts.
    Note: g_form as a global object cannot be used in a widget client controller or in a UI script.

    Service Portal server-side APIs

    These are Service Portal APIs that you can use in a widget server script.

    Class Description
    GlideSPScriptable Interact with data and perform record operations in Service Portal widgets.
    GlideSPSearchAnalytics Generate search analytics from custom Service Portal search widgets.
    spScriptedFacet Define facet items, filters, or mapped queries for a facets object.
    spScriptedFacetService Generate a multi choice or single choice facets object for an advanced search source.

    Widget properties

    Global variable and functions available in widget client and server scripts.

    Server script global objects

    Property Description
    input An object containing client-side properties set under c.data. The value is undefined until the client controller calls c.server.update().
    data An object containing properties set during server-side execution.
    options An object containing the schema option properties.

    Client script global functions

    Property Description
    this.server.get([Object]) Calls the server and sends custom input. Returns Promise.
    this.server.update() Calls the server and posts this.data to the server script. Returns Promise.
    this.server.refresh() Calls the server and automatically replaces the current options and data from the server response. Returns Promise.

    A promise represents the eventual result of an asynchronous operation. For more information on promises, see https://promisesaplus.com/ or AngularJS documentation.

    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 API reference

      • 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 API reference

      Service Portal includes client and server side APIs to use in widget client and server scripts.

      Service Portal client-side APIs

      These are Service Portal APIs that you can use in a widget client controller.

      See the API reference for detailed class and method information.

      Class Description
      spAriaUtil Show messages on a screen reader.
      spContextManager Make data from a Service Portal widget available to other applications and services in a Service Portal page. For example, pass widget data to Agent Chat when it opens in a Service Portal page.
      spUtil Utility methods to perform common functions in a Service Portal widget client script.
      spModal Show alerts, prompts, and confirmation dialogs in Service Portal widgets. The SPModal class is available in Service Portal client scripts.
      Note: g_form as a global object cannot be used in a widget client controller or in a UI script.

      Service Portal server-side APIs

      These are Service Portal APIs that you can use in a widget server script.

      Class Description
      GlideSPScriptable Interact with data and perform record operations in Service Portal widgets.
      GlideSPSearchAnalytics Generate search analytics from custom Service Portal search widgets.
      spScriptedFacet Define facet items, filters, or mapped queries for a facets object.
      spScriptedFacetService Generate a multi choice or single choice facets object for an advanced search source.

      Widget properties

      Global variable and functions available in widget client and server scripts.

      Server script global objects

      Property Description
      input An object containing client-side properties set under c.data. The value is undefined until the client controller calls c.server.update().
      data An object containing properties set during server-side execution.
      options An object containing the schema option properties.

      Client script global functions

      Property Description
      this.server.get([Object]) Calls the server and sends custom input. Returns Promise.
      this.server.update() Calls the server and posts this.data to the server script. Returns Promise.
      this.server.refresh() Calls the server and automatically replaces the current options and data from the server response. Returns Promise.

      A promise represents the eventual result of an asynchronous operation. For more information on promises, see https://promisesaplus.com/ or AngularJS documentation.

      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