Unofficial sn_aiux Documentation

Community documentation for sn_aiux — ServiceNow's AI Experience Framework (marketed as AIEX, schema prefix sys_aix_*), the Lit + Tailwind + DaisyUI portal framework that ships on Zurich Patch 9 and underpins Slate.

ServiceNow has not published architecture docs, an API reference, or a migration guide for the framework. This repository is the map we wish they had shipped: what the tables are, how a widget is put together, how routing works, how existing Service Portal widgets are bridged in, and how widgets participate in AI conversations.

This is unofficial. It is offered in good faith and is not endorsed, reviewed, or maintained by ServiceNow. Everything here is observed behavior on Zurich P9, not contract. When official docs arrive, prefer them for anything that conflicts.

Read it: the rendered version lives at relay.semaphorepartners.com/aiux-docs. This repo is the source of truth; the site is published from it.

Background: the investigation that started this is written up in AIEX & Slate: everything Knowledge26 didn't tell you.

Contents

• Introduction — what sn_aiux is, the AIUX / AIEX / Slate naming, compatibility, caveats
• Getting started
  • Installing — the three store apps, verifying the install, roles
  • Your first widget — port the OOB Cool Clock in twenty lines of Lit
• Widgets
  • Component — AIUXWidgetElement, instance members, lifecycle, services, contexts, directives
  • Lit — the Lit surface that ships in the bundle
  • Daisy — the <aiux-*> components and the aiux- prefixed utility classes
  • Server script — data / options / input, the $aiux scriptable, the GlideSPScriptable sidecar
  • Service Portal bridge — <aiux-angular-element> and the migration story
  • AI integration — best_for, client_tools, aiContext, $aiux.getWidget
  • Worked example: Impersonation widget — a full native port with AI tools
• Building with the SDK
  • Overview — author / build / run time, your files as records, project layout, Builder vs SDK import paths
  • Widgets & decorators — @name, @bestFor, @server, @discoverable as columns; the four things that make a file a widget
  • Pages, loaders & SSR — file routing, static async loader(ctx), rendering in a Glide isolate, isServer, the app shell
  • Dev loop — pnpm dev, the widget sandbox, build output, the five eslint plugins, deploying
• Experiences
  • Overview — sys_aix_experience, the /aiux/<suffix>/<page> URL pattern, the config endpoint, the sp_portal sidecar
  • Pages & routing — sys_aix_page, path patterns, the 404 Breakout page
  • App shells & themes — sys_aix_app_shell, sys_aix_theme, menus, page CSS
  • URL rewrites — sys_aix_url_rewrite_rule and legacy deep links
• Reference
  • Architecture diagrams — mounting hierarchy, data model, page-load sequence, widget interaction model
  • Tables — the 29 sys_aix_* tables grouped by purpose
  • Intellisense dump — the full API surface the Builder's autocomplete knows about
  • API reference — generated from the package's public API manifests: every public element, property, event, function, type, and class, one page per package
  • The @servicenow/aiux package — the public npm package: export map, component packages, type definitions and API manifests to build a reference from
  • Bundle anatomy — what's on the wire under /sncapps/aix/assets/ and where it comes from
  • Sample: /api/now/aix/config/builder response

Contributing

Corrections, new pages, and notes on behavior changes in newer patches are all welcome. Open an issue for something wrong, or send a pull request for something you have verified on an instance. See CONTRIBUTING.md for the ground rules, including what not to commit (ServiceNow source recovered from source maps, instance names, sys_ids of non-OOB records).

Publishing

Pages in docs/ are published to the Ghost site from this repo. ghost/manifest.yaml maps each page to its Ghost slug and navigation order; see ghost/README.md.

License

Documentation is licensed under CC BY 4.0. Code samples in the documentation may be used under the same terms. ServiceNow, Service Portal, Now Assist, and Slate are trademarks of ServiceNow, Inc.; this project is not affiliated with ServiceNow.

---

Maintained by Semaphore Partners. In the spirit of the original community Service Portal docs.