Supported client script types and APIs

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Supported client script types and APIs

    This document outlines which client scripts and APIs are supported in the ServiceNow Service Portal environment as of the Yokohama release. Understanding these limitations and capabilities helps ServiceNow customers effectively implement client-side scripting that works reliably within Service Portal, ensuring compatibility and optimal user experience.

    Show full answer Show less

    Supported Client Script Types in Service Portal

    • Catalog Client Scripts: Must have the UI Type set to All or Mobile / Service Portal. Scripts marked as Desktop are unsupported because they use legacy APIs not available in Service Portal.
    • Validation Scripts: Require the UI Type to be All or Mobile / Service Portal. In new instances, various validation scripts are active by default. For upgraded instances, the Mobile and Service Portal versions must be manually activated to validate user input within the portal. UI scripts can be called from validation scripts using the guiscripts global object, provided the UI script’s Global field is false and UI Type is set appropriately.
    • UI Scripts: Must be set to UI Type All or Mobile / Service Portal. Desktop UI scripts are unsupported due to reliance on legacy APIs.
    • UI Actions: All server-side UI Actions are supported; however, setRedirectURL() calls are ignored because redirection is handled differently in Service Portal. UI Actions marked as Client are ignored in forms within Service Portal.
    • UI Policies: Supported, but declarative UI Policies are recommended. Avoid scripting unless necessary for complex conditions.
    • UI Macros and Formatters: Not supported, as they rely on Jelly, which is incompatible with Service Portal.

    Supported Client-Side APIs

    Service Portal supports a subset of client-side APIs usable in onLoad, onChange, and onSubmit scripts. These APIs enable interactions with form fields, messages, and related lists.

    • gform: A comprehensive API to manipulate form fields (e.g., get/set values, show/hide fields and messages, manage options, validate input). Note that using variables.varname notation and global gform in widget client controllers or UI scripts is unsupported.
    • glist: Supports list operations like adding/removing items, resetting, and setting queries.
    • gservicecatalog: Provides a method to check if the current form is an order guide.
    • GlideAjax: Facilitates asynchronous server calls for data retrieval. Synchronous calls like getXMLWait() are not supported in Service Portal; asynchronous methods must be used instead. GlideAjax cannot be used within widget client controllers.
    • GlideRecord: Enables querying and manipulating records with asynchronous support.
    • i18NV3: Supports internationalization by retrieving localized messages asynchronously.

    Practical Implications for ServiceNow Customers

    When developing or migrating client scripts to Service Portal, always set the UI Type to All or Mobile / Service Portal and verify that only supported client-side APIs are used. Avoid legacy Desktop scripts and synchronous GlideAjax calls. Use declarative UI Policies whenever possible to reduce scripting complexity. Be aware that some platform features like UI Macros and Formatters are unavailable, so plan alternative implementations accordingly.

    Some client scripts are not supported in Service Portal. Others must have a UI type set to All or Mobile / Service Portal. If using a client script in the Service Portal, only client-side APIs supported in a mobile environment can be used.

    Client script support in Service Portal

    Client script Description
    Catalog client scripts

    Service Portal requires that the UI Type field be set to All or Mobile / Service Portal. Client Scripts marked as Desktop rely on legacy APIs that are not supported in Service Portal. Before flagging a script as Mobile / Service Portal or All, make sure you are only using supported client-side APIs.
    Validation scripts

    Service Portal requires that the UI Type field be set to All or Mobile / Service Portal. Client Scripts marked as Desktop rely on legacy APIs that are not supported in Service Portal. Before flagging a script as Mobile / Service Portal or All, make sure you are only using supported client-side APIs.

    Validate user input in a specific field type using a validation script. In new instances, Service Portal includes XML, Script, Script (Plain), Email, and Version validation scripts by default. If upgrading from a previous release, the Mobile and Service Portal version is not active by default. You must activate the Mobile and Service Portal version of the validation script to validate user input in the Service Portal. See Activate Service Portal validation scripts.

    Note:
    To call a UI script within a Validation script, use the g_ui_scripts global object. For more information, see GlideUIScripts. Verify that the UI script has the Global field set to false and UI Type set to Mobile / Service Portal or All.
    UI scripts

    Service Portal requires that the UI Type field be set to All or Mobile / Service Portal. Client Scripts marked as Desktop rely on legacy APIs that are not supported in Service Portal. Before flagging a script as Mobile / Service Portal or All, make sure you are only using supported client-side APIs.
    UI Actions

    All server-side UI actions are supported in Service Portal, although setRedirectURL() operations are ignored because Service Portal forms handle redirection in a different way than the platform.

    The form widget ignores any UI Actions marked as Client.
    UI Policies Supported, although you should use only declarative UI Policies. Avoid scripting unless the outcome cannot be achieved through the condition builder.
    UI Macros Not supported as UI macros use Jelly.
    Formatters Not supported as formatters use Jelly.

    Supported client-side APIs

    Supported client scripting APIs for use in onLoad, onChange, and onSubmit client scripts.

    For detailed class and method information, see the Client API reference.

    Class Available methods
    g_form
    • addDecoration(fieldName, icon, title)
    • addErrorMessage(message)
    • addInfoMessage(message)
    • addOption(fieldName, value, label, index)
    • clearOptions(fieldName)
    • getActionName()
    • getBooleanValue(fieldName)
    • getDecimalValue(fieldName)
    • getEncodedRecord()
    • getFieldNames()
    • getIntValue(fieldName)
    • getLabel(fieldName)
    • getReference(fieldName, callback)
    • getRelatedListNames()
    • getSectionNames()
    • getSysId()
    • getTableName()
    • getValue(fieldName)
    • hasField(fieldName)
    • hideAllFieldMsgs(type: "info | error")
    • hideErrorBox(fieldName)
    • hideFieldMsg(fieldName, clearAll)
    • hideRelatedList(listTableName)
    • hideRelatedLists()
    • isMandatory(fieldName)
    • isNewRecord()
    • isReadOnly(fieldName)
    • isVisible(fieldName)
    • removeDecoration(fieldName, icon, title)
    • removeOption(fieldName, value)
    • save()
    • serialize(onlyDirtyFields)
    • setFieldPlaceholder(fieldName, placeholder)
    • setLabel(fieldName, label)
    • setMandatory(fieldName, isMandatory)
    • setReadOnly(fieldName, isReadOnly)
    • setSectionDisplay(sectionName, isVisible)
    • setValue(fieldName, value, displayValue)
    • setVisible(fieldName, isVisible)
    • showErrorBox(fieldName, message, scrollForm)
    • showFieldMsg(fieldName, message, type: "info | error", scrollForm)
    • showRelatedList(relatedTableName)
    • showRelatedLists()
    • submit(submitActionName)
    Note:
    Using the variables.var_name notation with the g_form API is not supported in Service Portal. g_form as a global object cannot be used in a widget client controller or in a UI script.
    g_list
    • get(fieldName)
    • addItem(value, displayValue)
    • removeItem(value)
    • reset()
    • setQuery(queryString)
    • setDefaultOperator(operator)
    • getDefaultOperator()
    g_service_catalog

    isOrderGuide()
    GlideAjax
    • addParam (name, value)
    • getParam (name)
    • getXML(callback)
    • getXMLAnswer(callback)
    • getJSON(callback)
    • setErrorCallback(errorCallback)
    • getURL()
    • getParams()
    • execute()
    • successCalback(data, status, xhr)
    • errorCallback(xhr)
    • setScope(scope)
    Note:
    • Because the mobile platform does not allow synchronous GlideAjax calls, the getXMLWait() method in a GlideAjax call does not work in the Service Portal. Instead, use one of the asynchronous calls such as getXML(Function callback) or getXMLAnswer(Function callback).
    • GlideAjax cannot be used in a widget client controller.
    GlideRecord
    • addQuery(encodedQuery)
    • addQuery(fieldName, operator, value)
    • getEncodedQuery()
    • get(id)
    • getTableName()
    • hasNext()
    • insert(callback)
    • gotoTop()
    • next()
    • loadRow(rowObj)
    • getValue(fieldName)
    • setValue(fieldName, value)
    • isDotWalkField(fieldName)
    • addOrderBy(fieldName)
    • setDisplayFields(fieldNames)
    • query(callback)
    • setRows(rowsArray)
    • setTableName(tableName)
    • setLimit(maxInt)
    • getLimit()
    i18NV3

    getMessage(String messageKey, Function callback)