This article is a supplement to the ServiceNow documentation. For full documentation please refer ServiceNow official website
Checkout our NEW Video Channel you can like and subscribe too!


UI action: All the buttons in the SeviceNow UI are ui action. When we are clicking on button then some scripts gets executed.This scripts can be configured in UI action and is highly customizable.

UI Actions includes

  • Form Buttons
  • Form Context menu items (right-click the header)
  • Form links (Related Links in a Form)
  • List buttons
  • List context menu items (right-click a record)
  • List choices (at the bottom of a list)
  • List links (Related Links at the bottom of a list)
  • UI action is an actionable item.

Steps to create UI Actions

  1. System UI >UI Actions uia1.PNG
  2. Click on new to create UI action uia2.PNG
  3. UI action for client side uia3.PNG
  4. Server side ui action uia4.PNG
  5. We can apply the condition also uia5.PNG

Based on our choice we can make UI action for client side scripting or server side scripting.To change a UI action to run client-side script, we first need to check the client field check box.

The onClick field runs the client code contained inside it when the UI action is selected. So we call a function in this field and define the function in the main script field.

For the code in the onClick field, we only need to call the following function:


Then, in the script field, we can define the function and contain the code we want to run inside it:

function onClick() {
// Write script here to run when an UI Action is selected



This method of calling a function that resides in the script field is used by ServiceNow UI actions that is provided with the out-of-the-box platform.

Now we have seen how to use client-side scripts in UI actions, we can look at taking this a step further and using client- and server-side script in the same UI action.

This can be achieved by first calling client-side script in the UI action, which calls the UI action in the code, and therefore runs the server-side script.

First, we need to take a look at the line of code that calls the UI action from the client-side code:

gsftSubmit(null, g_form.getFormElement(), '<ui_action_name>');

The preceding line of code calls the UI action, but this time, it will run it on the server side.

Here Action name field of the UI action is the same as the name referenced in the script.

The first argument of gsftSubmit is for a control, but seeing as we don’t want to use this, we just pass null.

This second argument is to get the form. in this case, we just want to get the current HTML form.

The third argument is the action name, so this needs to be our UI action action name.

Next, let’s look at the server side of the script:

if(typeof window == 'undefined')

function serverSideCode() {
//Run the server side UI Action code


The first part of this code is an if statement to check that we are running on the server side and not the client side anymore. This little piece of code also ensures that we do not receive browser errors. If the if statement evaluates to true, we then call a function to run our server-side code.

We can use the preceding example and call the onClick function in our script field
function onClick() {
// Write script here to run when an UI Action is selected
gsftSubmit(null, g_form.getFormElement(), 'incident_ui_action');


if(typeof window == 'undefined')

function serverSideCode() {
//Run the server side code



Reopen Incident uiaction281120193.PNG uiaction281120194.PNG uiaction281120195.PNG

//Client-side 'onclick' function
function ReOpenedIncident(){
	g_form.addErrorMessage("please write some comments in the Additional comments section");
	return false; //Abort submission
//Call the UI Action and skip the 'onclick' function	
	gsftSubmit(null, g_form.getFormElement(), 'ReOpened_Incident');//MUST call the 'Action name' set in this UI Action

//Code that runs without 'onclick'
//Ensure call to server-side function with no browser errors
if(typeof window == 'undefined')

//Server-side function
function withoutOnclick(){'true';
	current.state = 2;

Example If change is in scheduled state and current user has change manager role then user can reschedule the change time.

uiaction281120191.PNG uiaction281120192.PNG

Example Shows a google map link on a location table if the location has a street and city listed as shown below gmap070520201.PNG


  • UI Action: Open Google Map
  • Table: Location
  • Action Name: open_google_map
  • Onclick: openGoogleMap()
  • Condition: (!current.street.nil() && !   (!current.latitude.nil() && !current.longitude.nil())
  • Script: ``` //Pop open google maps window of location specified //URL should follow this format… Pennsylvania Ave SE, Washington, District of Columbia, 20003

function openGoogleMap() { //alert(‘fdf’); //Retrieve the ‘Location’ record var sysId = typeof rowSysId == ‘undefined’ ? gel(‘sys_uniqueValue’).value : rowSysId; var gr = new GlideRecord(‘cmn_location’); gr.get(sysId);

//Create and display the Map URL var mapURL = “”; //Try location and city if(gr.street &&{ mapURL = mapURL + gr.street + ‘,’ + + ‘,’ + gr.state + ‘,’ + + ‘,’ +; } //Else try latitude and longitude else if(gr.latitude && gr.longitude){ mapURL = mapURL + gr.latitude + ‘,’ + gr.longitude; } //Strip ‘#’ symbols to avoid encoding errors mapURL = mapURL.replace(/#/g, “”); //alert(‘mapURL’+mapURL);; } ``` gmap070520203.PNG gmap070520204.PNG