Interface Usage Guide
This page describes the user-visible conventions in Design System 1.2. Individual modules may use different nouns, but placement and behavior remain consistent.
Theme and density
- The workbench currently offers six themes in the fixed order Navy, Gold, Burgundy, Jade, Slate, and Orange. A theme changes brand expression, not functionality or permission.
- Mode can be Light, Dark, or System.
- Stable density IDs are
dense,compact,comfortable, andspacious; the UI labels them Compact, Standard, Comfortable, and Spacious. Management defaults to Compact (dense). - Changing theme or density preserves the current page, query, and workspace.
- Appearance Settings also provides Light, Dark, System, Navy, Amber, Burgundy, and Jade. It stores presentation preferences only and falls back to the current page when browser storage is unavailable.
Navigation
- Side Shell opens modules from the left and shows names in tooltips when collapsed.
- Top Shell opens primary modules from the top and places lower-frequency destinations under More.
- Breadcrumbs show location; local tabs switch sections inside one resource.
- Global Search finds objects across modules. A list keyword searches only the current list.
Workspace Tabs
In Managed Tabs:
- opening the same matter or client focuses the existing tab;
- pinned tabs are protected from bulk close;
- unsaved work prompts before close;
- restore includes only resources that still exist and remain authorized;
- local tabs and workspace tabs are separate concepts.
List queries
- Enter a keyword and frequent conditions in Quick Query.
- Open Advanced Filter when more fields are needed.
- Review or remove conditions in Applied Summary.
- Save repeated queries as personal views or, with permission, team views.
- For complex logic, open Query Studio and verify its natural-language summary before Apply.
Resetting current conditions does not delete a Saved View. When no rows match, inspect Applied Summary before rebuilding the query.
Tables
- Sort with supported column headers.
- Use Columns to control visibility and order.
- Selected-row operations appear in a Selection Action Bar.
- Lower-frequency row operations live under More.
- Destructive actions require confirmation.
- Confirm whether Export means current page, current query, or selected rows.
- Read status text as well as color.
Common states
| State | Meaning | Recommended response |
|---|---|---|
| Loading / Skeleton | Data is being loaded | Wait or cancel |
| Empty | No data exists yet | Use the offered first action |
| Filter-empty | Current conditions match nothing | Remove or clear conditions |
| Stale | Data may have changed | Refresh before a critical action |
| Unauthorized | Access is not allowed | Return or request access |
| Error | A request failed | Retry and provide traceId to support if needed |
Frontend visibility is only an experience aid. The server remains the authorization source of truth.
Restore work and provide support evidence
A shareable list state belongs in the URL. Pinned views store path and a question-mark-prefixed queryString, but reject passwords, tokens, secrets, API paths, and external URLs:
/tickets?status=Open&priority=High&pageIndex=2&pageSize=50If an old link no longer applies, check permission, tenant features, and the server field catalog. Do not add unknown query keys merely to recreate a view; pinning does not freeze authorization or query allowlists.
When asking for support, provide enough evidence to correlate the request without copying credentials, complete payloads, or sensitive business data:
Page: /ticketsOperation: apply priority filterTime: 2026-08-10T09:30:00ZTrace ID: 00-<trace-id>-<span-id>-01Outcome: 403 / stable error code- Record the Trace ID and time before refreshing.
- For filter issues, name the applied fields without exposing sensitive values.
- For visual issues, include theme, mode, density, shell, viewport, and reduced-motion state.
- For concurrency conflicts, preserve the server version and action order instead of retrying blindly.
- Support should correlate server logs, traces, and restricted audit envelopes for details.