Connector Editor Shell
The connector editor (/analyst/connectors/{id}/edit) is a full-height workspace with its own top
bar, a left rail of vertical tabs, and a main content area. This page covers the shell — the
frame around the work. The per-endpoint panel is documented in
Endpoint editor; the Bulk panel in
Phases & execution order.
The shell occupies the full viewport below the global top bar.
Top bar
A 12px-taller bar (48px) than the global chrome, containing, left to right:
Connector identity
- Connector name (truncated if long).
- Version badge (
v…).
Undo / change label / Redo
A grouped control in the centre-left:
| Element | What it does |
|---|---|
| Undo (curved-back arrow) | Steps back one change. Disabled when there is nothing to undo. Its tooltip names the change it would undo. |
| Change label (history icon + text) | Shows the label of the current point in the change history (or "Session start"). When you have unpublished changes it turns amber and appends a change count (· N). Click it to open the change-history picker (see below). |
| Redo (curved-forward arrow) | Steps forward one change. Disabled when there is nothing to redo. Its tooltip names the change it would redo. |
Change-history picker
Clicking the change label opens a popover titled Change history:
- A scrollable list of every change point this session, newest at the top.
- The current point is highlighted blue; points you have undone past are shown with an amber dot; future (redoable) points have a grey dot. Each row shows the change label and a relative time.
- Click any entry to jump directly to that point (a combined undo/redo).
- Discard all (top-right, shown only when there are unpublished changes) reverts every unpublished change at once.
Right controls
| Control | Icon | What it does |
|---|---|---|
| Search endpoints | magnifier | Opens the Cmd+K endpoint search overlay (see below). Tooltip shows the ⌘K shortcut. |
| Version history | branch | Opens the version history page for this connector. |
| Publish | green button | Opens the publish diff dialog (see below). Shows a spinner and is disabled while publishing. |
Progress bar / phase tabs (second row)
Directly under the top bar, the editor shows one of two things:
- No execution phases defined: a thin two-tone progress bar — green for the tested proportion, blue for the rest. Hovering shows "X / Y endpoints tested (Z%)".
- Phases defined: a horizontal, scrollable row of phase tabs, one per phase, each showing the phase name and its endpoint count. Clicking a phase tab switches to the endpoint (home) view and scrolls that phase into focus in the left index. A "tested/total tested" counter with a green dot sits at the right end.
Left rail tabs
A narrow (64px) vertical rail down the left side. The top group are the main editor tabs; a divider separates the Endpoint home button from the rest. Each has a hover tooltip describing it.
| Tab | Icon | What it shows |
|---|---|---|
| Endpoint | globe | The default explorer view (home). Clicking any other active tab again also returns here. |
| Config | sliders | The connector-level config panel (see below). |
| Bulk | layers | The Bulk panel for enabling/disabling endpoints and managing execution order. |
| Auth | shield | The authentication configuration panel. |
| Test | flask | Test-credential slots. See Testing Connectors. |
| Notes | document | Connector- and endpoint-level analyst notes. |
The bottom of the rail is pinned with utility links:
| Item | Icon | What it does |
|---|---|---|
| Messages | speech bubble | Toggles the messaging panel; shows an unread badge when there are unread messages. |
| Ask KM | question bubble | Opens the Ask KM support form, pre-loaded with a debug snapshot of your current editing session. |
| Updates | newspaper | Links to /analyst/release-notes. |
| Docs | book | Opens the external documentation site (docs.traceslab.com) in a new tab. |
Endpoint (home) view
The default view is a two-panel layout:
- Left: a navigator. When the connector has execution phases this is the phase index (phases → stages → endpoints, with tested checkmarks and quick enable/disable toggles); otherwise it is the endpoint tree navigator grouped by path. Selecting an endpoint loads it on the right.
- Right: the endpoint editor panel for the selected endpoint.
The divider between the two panels is draggable.
Config tab
The connector configuration panel, organized into sections:
- Identity — the connector name (read-only here) with its version badge, and a Status selector (Production / Testing / Disabled). While a connector is Generating, the status shows a spinner badge and cannot be changed.
- Endpoints — the Platform Base URL (click the pencil to edit inline; accepts a real URL or
a
{{template}}; validated on save) and, if present, the API Documentation link with a Scrape samples button beside it. - Default Headers — key/value rows sent with every request (in addition to auth headers). Add a new header with the name/value inputs and the green +, remove with the trash icon. A note warns that header changes are included when you next publish.
Banners
The editor shows non-blocking banners at the top of the work area when relevant:
- Concurrent-edit banner — a red bar reading "Name(s) is/are also editing this connector. Changes may conflict." It appears only when other analysts are editing the same connector, and disappears when they leave. It does not block you.
- Data-sync warnings — an amber bar if saved data could not be loaded from the server (your changes may overwrite server data; offers Retry), or a red bar if a save failed.
Unpublished changes themselves are surfaced through the amber change label in the top bar (with its count) rather than a separate banner.
Cmd+K endpoint search
Press ⌘K (or click the magnifier) to open a centered search overlay over a dimmed backdrop:
- A single search box. Typing scores endpoints across path, method, friendly name, description, category, analyst notes, and query-param names, and lists the top matches (up to 20) with the matched text highlighted.
- Each result shows the method badge, the path, the friendly name, and the matched snippet/category.
- ↑ / ↓ move the selection, Enter opens the highlighted endpoint, Esc closes the overlay. You can also click a result. Clicking the backdrop closes it.
Publish flow
Clicking Publish opens the Publish changes dialog:
- A header showing the version bump (
v{current}→v{new}) and the total change count. The new version number is computed from the kinds of changes you made. - A scrollable, colour-coded summary of the changes grouped by type — endpoints enabled/disabled, endpoints edited, new endpoints, auth/header changes, dependency mappings, notes, pagination, execution-order changes. Added items are green, removed red, changed amber.
- An optional Commit message field.
- Cancel dismisses; Publish v{new} confirms (shows "Publishing…" with a spinner).
Publishing creates a new connector version (a new record) for forensic integrity and supersedes the previous one. Endpoint IDs and test-data references are remapped during publish. See Versioning.
Dependency-order violation modal
If you trigger an AI reorder (from the Bulk panel) that would break a configured dependency, a full-screen blocking modal appears before the reorder is applied. It cannot be dismissed without choosing an option. It is documented in detail under Phases & execution order.
Ask KM
The Ask KM rail item (question-bubble icon) is a low-friction support channel for when you get stuck — for example, "I don't know what variable type to use for this value in the response."
Clicking it captures a debug snapshot of your current editing session — the connector and its
endpoint configuration, any unsaved changes, your in-session change history, dependency mappings,
pagination config, and sample/test data — and opens the Ask KM form at /analyst/new-query:
- A free-text box to describe what you're stuck on (no detail too small).
- A severity picker: 1 — General (a question, no rush), 2 — Blocking-ish (slowing you down), 3 — Urgent (you're stuck or something's broken).
- The captured snapshot shown in an interactive JSON tree. Click any value to flag it for the reviewer — handy for pointing at the exact field you mean. Flagging is optional.
Submitting files the query for review. Status changes are sent back to you via the notifications bell, and the reviewer follows up through Messages.
Admins triage incoming queries at /analyst/queries (also linked from the settings menu): a
searchable, sortable list with a detail panel that shows the description, severity, submitter, the
flagged values, and the full snapshot, plus a status control (Open → In progress → Resolved).