---
sourceDocument: Brazil API Reference
sourceDocumentLink: https://www.servicenow.com/docs/r/api-reference

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil API Reference

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# UI scripts

# UI scripts {#ariaid-title1}

Release version: Brazil  
Updated September 10, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
UI scripts provide a way to package client-side JavaScript into a reusable form, similar
to how script includes store server-side JavaScript. Administrators can create UI scripts and run
them from client scripts and other client-side script objects and from HTML code.  
Note:  
UI scripts aren't supported on mobile or Next Experience.

## Create a UI script {#ariaid-title2}

Create a UI script to define reusable client-side JavaScript code.

### Before you begin

Role required: admin

### Procedure

1. Navigate to System UIUI Scripts.
2. Select New.
3. On the form, fill in the fields.  
   {#t_CreateAUIScript__table_zsc_z4z_sr__entry__2}

   | Field | Description |
   |-|-|
   | API Name | The API name of the UI script, including the scope and script name (for example, x_custom_app.HelloWorld). |
   | Application | Application that contains the UI script. |
   | UI Type | Target user interface to which the UI script applies. |
   | Active | Indicator of whether the UI script is active. Only active UI scripts can run. |
   | Global | An option to makes the script available on any form in the system. You can call global UI scripts from any client script or UI policy you write. Note: Use caution when creating global UI scripts because they can impact performance. You can't create a global UI script in a scoped application. |
   | Description | Summary of the purpose of the script. |
   | Script | Client-side script to run when called from other scripts. |
   [Table 1. UI scripts]

   {#t_CreateAUIScript__table_zsc_z4z_sr}
4. Select Submit.

## General guidelines for running UI scripts {#ariaid-title3}

Follow these general guidelines when running UI scripts.

### Run a UI script from a form

To run a UI script on a form, [Create a formatter and add it to a form](https://www.servicenow.com/docs/access?context=t_CreateAFormatter&version=brazil&pubname=brazil-platform-administration&ft:locale=en-US). In the associated [UI macro](https://www.servicenow.com/docs/cDweBrBGAcWdgh90UCgDJQ#c_UIMacros "UI macros are discrete scripted components administrators can add to the user interface."), include a `g:requires` tag and specify the name= parameter as the name of the UI script followed by the .jsdbx
extension. Add the formatter on the form view.

This code ensures that the definitions and results of the UI script are immediately
available in the browser.  

    <?xml version="1.0" encoding="utf-8" ?>  
    <j:jelly trim="false" xmlns:j="jelly:core" xmlns:g="glide" xmlns:j2="null" xmlns:g2="null">  
        <g2:evaluate var="jvar_stamp">  
            var now_GR = new GlideRecord('sys_ui_script');  
            gr.orderByDesc('sys_updated_on');  
            gr.query();  
            gr.next();  
            gr.getValue('sys_updated_on');  
        </g2:evaluate>  
        <g:requires name="<UI SCRIPT NAME>.jsdbx" params="cache=$[jvar_stamp]"/>  
    </j:jelly>

### Call a UI script in HTML {#r_RunUIScripts__section_o5w_npl_d2b}

To run a UI script from HTML code, use the `<script>` tag and specify the
`src=` argument as the API name of the UI script followed by the .jsdbx
extension. For example, include the UI script named CoolClock with this
code:  

    <script language="javascript" src="CoolClock.jsdbx"/>

### Call a UI script from client-side code {#r_RunUIScripts__section_bs1_rpl_d2b}

Access UI scripts from within client-side code using the g_ui_scripts
global object. For more information, see [GlideUIScripts - Client](https://www.servicenow.com/docs/gkzXjjdwcP2QQ7F8zzaoAA#GUIScriptsAPI "The GlideUIScripts API provides methods to access UI scripts from within client-side code.").  
Note:  
This class does not support UI scripts with the Global field set to true.

*[\>]: and then