Set a field value using g_form in a UI…

Client-sideintermediateTested on Xanadu

Chrome Extension

Sourdough: ServiceNow Monitoring and Analytics

A Chrome extension for ServiceNow Admins and Developers with essential tools, analytics, graphs and monitoring features.

Instance HealthGraphs & ChartsAPI HealthDeveloper ToolsQuick SearchInstance Switcher

Add to Chrome

Free to install. Pro $5/month after a 14-day no-card trial.
Pro requires the ServiceNow admin role. Upgrade inside the extension.

Overview

Tasks

CMDB

API

Metrics

Monitor

Internals

Instance:sourdoughdev·Version:Yokohama

Instance StateONLINE

System StatusFully Operational

Session Timeout90 minutes

Logged-In Sessions2 (20 active)

Build Nameyokohama-12-18-2024_p1

IP Address10.159.128.43

Instance HealthHealth Score: 90%

🔥 5dSourdough (Chrome Plugin)Dark Mode

Update a form field value from a UI Action client script

UI Action

// UI Action configuration:
// Name: Approve Request
// Table: sc_request
// Client: true
// Form button: true
// Onclick: (this code)

function approveRequest() {
  try {
    // Get current user to set as approver
    var currentUser = g_user.getUserID();
    
    if (!currentUser) {
      g_form.addErrorMessage('Unable to determine current user');
      return false;
    }
    
    // Set multiple field values - order matters for business rules
    g_form.setValue('approval', 'approved');
    g_form.setValue('approved_by', currentUser);
    g_form.setValue('approved_date', g_form.getNow());
    g_form.setValue('state', '3'); // Approved state
    
    // Add work notes with approval info
    var workNotes = 'Request approved by ' + g_user.getDisplayName() + 
                   ' on ' + new Date().toLocaleDateString();
    g_form.setValue('work_notes', workNotes);
    
    // Save the form - triggers validation and business rules
    g_form.save();
    
    return false; // Prevent default form submission
    
  } catch (e) {
    g_form.addErrorMessage('Error processing approval: ' + e.message);
    return false;
  }
}

approveRequest();

UI Actions with client=true execute in the browser where g_form is available to manipulate form fields directly. The critical mistake developers make is calling gsftSubmit() instead of g_form.save() after setting values. The gsftSubmit() method bypasses client-side validation and can cause race conditions where your setValue() calls haven't fully propagated to the form before submission.

When to use this

When you need to set multiple related field values atomically before saving
When you want client-side validation to run on the new field values
When implementing approval workflows that update status fields and audit trails
When you need immediate visual feedback in the form after the field changes

When NOT to use this

Don't use for server-side calculations that require database queries — use a server-side UI Action instead
Don't use when you need to update records other than the current form record — use GlideAjax to call a server-side Script Include
Don't use for fields that have complex business rules — the client-side save may fail validation
Don't use on mobile interfaces where g_form behavior is inconsistent — use server-side UI Actions

Key behaviors and gotchas

State field values must be strings even though they're stored as integers: '3' not 3
The return false prevents the default UI Action submission — essential when using g_form.save()
Reference fields require sys_ids as values, not display values — use g_user.getUserID() not g_user.getName()
Date/time fields accept g_form.getNow() for server timezone or JavaScript Date objects for local timezone
Field order in setValue() calls matters when business rules have dependencies between fields
Client-side UI Actions run in the user's security context — ACLs still apply to field updates

⚠️

Never mix g_form.save() with gsftSubmit() in the same UI Action. The gsftSubmit() will execute immediately while g_form.save() is asynchronous, creating a race condition where the form submits before your field values are applied.

Free Newsletter

Enjoying this? Get one deep-dive per week.

Join 1,000+ ServiceNow pros — scripts, GlideRecord patterns, Flow Designer techniques, and career moves. Free.

Alternative Approaches

Server-side UI Action with GlideRecord

// UI Action configuration:
// Name: Approve Request  
// Table: sc_request
// Client: false
// Form button: true
// Script: (this code)

// Server-side approach - no g_form available
var gr = new GlideRecord('sc_request');
if (gr.get(current.sys_id)) {
  gr.approval = 'approved';
  gr.approved_by = gs.getUserID();
  gr.approved_date = gs.nowDateTime();
  gr.state = '3';
  gr.work_notes = 'Request approved by ' + gs.getUserDisplayName() + 
                  ' on ' + gs.nowDate();
  gr.update();
  
  // Redirect back to form to show updates
  action.setRedirectURL(current.getLink(true));
}

Use when you need server-side validation or database queries during the field update process.

Trade-offs: Requires page reload to show changes, but guarantees server-side business rule execution and data integrity.

API Methods Used

GlideForm.setValue()GlideForm.save()GlideForm.addErrorMessage()

Test Your Knowledge

Quick 3-question quiz — see how your ServiceNow skills stack up.

Question 1 of 3Performance

A list view on a table with millions of records is slow. Best fix?

Select an answer to continue

Set a field value using g_form in a UI Action