UI scripts

---
title: UI scripts
description: 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.Create a UI script to define reusable client-side JavaScript code.Follow these general guidelines when running UI scripts.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/api-reference/scripts/c\_UIScripts.html
release: brazil
product: Scripts
classification: scripts
topic_type: concept
last_updated: "2026-09-10"
reading_time_minutes: 2
breadcrumb: [Write client-side scripts, Scripting, API implementation, API implementation and reference]
---

# UI scripts

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.

**Parent Topic:**[Writing client-side scripts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/scripts/client-side-scripting-overview.md)

## Create a UI script

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

### Before you begin

Role required: admin

### Procedure

1.  Navigate to **System UI** > **UI Scripts**.

2.  Select **New**.

3.  On the form, fill in the fields.

<table id="table_zsc_z4z_sr"><thead><tr><th>

Field

</th><th>

Description

</th></tr></thead><tbody><tr><td>

API Name

</td><td>

The API name of the UI script, including the scope and script name \(for example, x\_custom\_app.HelloWorld\).

</td></tr><tr><td>

Application

</td><td>

Application that contains the UI script.

</td></tr><tr><td>

UI Type

</td><td>

Target user interface to which the UI script applies.

</td></tr><tr><td>

Active

</td><td>

Indicator of whether the UI script is active. Only active UI scripts can run.

</td></tr><tr><td>

Global

</td><td>

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.

</td></tr><tr><td>

Description

</td><td>

Summary of the purpose of the script.

</td></tr><tr><td>

Script

</td><td>

Client-side script to run when called from other scripts.

</td></tr></tbody>
</table>4.  Select **Submit**.


## General guidelines for running UI scripts

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://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/platform-administration/t_CreateAFormatter.md). In the associated [UI macro](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/scripts/c_UIMacros.md), 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
<?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

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:

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

### Call a UI script from client-side code

Access UI scripts from within client-side code using the g\_ui\_scripts global object. For more information, see [GlideUIScripts - Client](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/api-reference/GUIScriptsAPI.md).

**Note:** This class does not support UI scripts with the **Global** field set to true.