Skip to content

Architect track

Workspaces & UI Builder

Next Experience: configurable workspaces built from pages, variants and data resources.

4 sections · 27 entries

Workspace anatomy

How a configurable workspace fits together, from the URL down to a component.

  1. ExperienceThe app shell and URL path, e.g. /now/sow/home. Registered in sys_ux_page_registry.
  2. Page & routeEach page has a route and parameters (table, sysId) that drive it.
  3. VariantA version of a page shown by audience and condition. Duplicate a variant; never edit OOB.
  4. ComponentsLists, record forms, tabs, data visualizations, custom components.
  5. Data resourcesLook up records, GraphQL, transform (server script) and client state parameters.
  6. Events & handlersComponent events trigger data resource refreshes, client scripts or navigation.

Workspace config tables

Where Next Experience configuration actually lives. Prefix with your instance URL and add _list.do.

Open UI Builder
Experiences (workspaces and portals built in UI Builder)
Routes: which page answers which URL pathHidden gem
Page variants and their audiences / conditionsHidden gem
Page and component definitions (macroponents)
Declarative actions: workspace buttons and record actions
Workspace list definitions (which lists show in the list menu)Hidden gem
Audience applicability for workspace configurationHidden gem

Which UI should I build on?

Pick the surface by audience, not by habit.

AudienceBuild onNotes
Fulfillers and agentsConfigurable workspace (UI Builder)Strategic agent UI; Agent Workspace (legacy) and Core UI forms are maintenance only
EmployeesEmployee CenterTaxonomy, content and catalog in one portal
External customersCustomer Service portal / Service PortalBranded, unauthenticated + authenticated pages
Admins and developersCore UI (classic)Fine for config screens; avoid investing in custom Core UI for end users
Highly custom app UIUI Builder + custom components (Now Experience CLI)Pro-code only when OOB components truly cannot do it

Workspace best practices

Keep workspaces fast, upgrade-safe and easy to hand over.

  • ✦Duplicate variants. Duplicate the OOB variant, give it a higher order and an audience. Upgrades keep improving the OOB one.
  • ✦Declarative actions. Use declarative actions (UX form actions, list actions) instead of UI actions with workspace flags.
  • ✦Limit fields. Look up records data resources: request only the fields the page shows.
  • ✦Shape on the server. Use a transform data resource to shape data server-side rather than heavy client scripts.Hidden gem
  • ✦Client state. Use client state parameters for page-level state; avoid global variables in client scripts.
  • ✦Audiences. Drive differences by audience (roles) rather than scripted show/hide.
  • ✦Forms still matter. Workspace forms reuse form views, UI policies and client scripts: keep those clean.
  • ✦Test as users. Impersonate each audience; variants and actions resolve differently per role.

Snippets are provided as-is under the MIT licence, without warranty. Test in a sub-production instance first. ServiceNow is a trademark of ServiceNow, Inc.; this page is independent and not affiliated with or endorsed by ServiceNow.