User Reference

This chapter collects the current command names, shortcuts, status fields, exchange formats, common diagnostics, and terminology. Earlier chapters explain the workflows and their safeguards in context.

File

CommandAvailability and effect
NewStarts an untitled project after protecting dirty work.
OpenSelects and transactionally opens one Automata Lab JSON project.
SaveWrites the current persistable project to its association or download fallback.
Save AsRequests one new JSON destination and associates it when supported.
CloseCloses the client project without deleting local or hosted data.
Validate State MachineReports complete model validation for the open project.
Pull Model from ServerReplaces the client project with the current valid hosted document.
Push Model to ServerCompare-and-set hosts the current complete valid project.
Import from CSVImports one selected collection as an atomic project command.
Export to CSVExports one selected collection without changing the project.
Connect to ServerConnects to the configured server URL.
Disconnect from ServerCloses the client connection while preserving a live built-in worker.
Test ServerRuns handshake, liveness, and readiness checks.
Page SetupEdits paper, orientation, margins, and included report sections.
PrintComposes the current project revision and opens the browser print dialog.
SettingsOpens Application Settings for global browser preferences.

CSV submenus offer Model Metadata, States, Events, Actions, State Actions, Transition Table, Solver Observation Sequence, and Simulator Event Sequence. A selected Solver or Simulator sequence is required for those sequence exports.

Edit

CommandEffect
CutUses the native edit operation in the active editable context.
CopyUses the native edit operation or copies a supported focused row.
PasteUses the native edit operation in the active editable context.
UndoReverses the newest application document command.
RedoReapplies the newest undone application document command.

Text-control undo can remain local while a field is being edited. After a valid edit commits, application Undo treats the accepted change as one document command.

View

CommandEffect
Editor, Chart, Solver, SimulatorSelects the corresponding main workspace.
Expand All, Collapse AllExpands or collapses the Editor branch in the Model tree.
ClearDeletes retained in-memory Console entries only.
ConsoleShows or hides the Console region.
Expand Chart StatesToggles the open project's persisted Chart expansion setting.
Theme → Light, DarkSelects and persists the application theme.

Help

CommandEffect
DocumentationOpens the documentation home page in a new browser context.
About Automata LabShows application identity, a GitHub repository link, licences, and release notes.

The About heading places the application icon beside the name and version, with the description below. Select GitHub - Automata Lab beneath the description to open the project repository in a separate browser tab or window. The link is keyboard accessible.

Licences opens by default. Release Notes shows the shipped history in a scrollable text box, with lines wrapped at 79 characters and 79-hyphen release separators. The desktop text box fits 80 monospace characters without horizontal scrolling, and switching tabs preserves the dialog height.

Toolbar Commands

The toolbar mirrors frequent menu commands and uses the same enablement rules.

GroupCommands
Project filesNew, Open, Save, Save As
Server revisionPull Model from Server, Push Model to Server
HistoryUndo, Redo
WorkspaceEditor, Chart, Solver, Simulator
Chart displayExpand Chart States
AppearanceTheme

At narrow widths, trailing commands move into the accessible More menu without changing their behavior. Arrow keys move among enabled toolbar controls after the toolbar receives focus.

Application Colors is available through File → Settings → Appearance, with independent Title Bar Color and Application Buttons (both Blue by default), plus Console Message Buttons (Gray by default). Match Console Message Color defaults checked and uses the shared darker Green message, Blue warning, and Red error palettes. See Application Settings for choices and excluded controls.

Keyboard Shortcuts

Application shortcuts

ShortcutCommand
Ctrl+NNew
Ctrl+OOpen
Ctrl+SSave
Ctrl+PPrint
Ctrl+XCut in the active editable context
Ctrl+CCopy in the active context or focused supported row
Ctrl+VPaste in the active editable context
Ctrl+ZUndo
Ctrl+YRedo
Alt or F10Enter the menu bar

Use the equivalent Command-key editing shortcuts on macOS where the browser and operating system provide them. A text control may consume a shortcut for native editing before the application command layer sees it.

Common composite controls

ContextKeys
MenusArrow keys, Enter or Space, Escape
ToolbarArrow keys among enabled controls
Model treeUp/Down, Left/Right, Home/End, type-ahead, Enter or Space
Tabs and listsArrow keys; Enter or Space where activation is available
Grids and ConsoleArrow keys, Home/End, native selection and scrolling keys
SplittersArrow keys to resize within announced limits
DialogsTab/Shift+Tab, Enter where accepted, Escape to cancel

Chart shortcuts

ShortcutChart effect
Enter or SpaceEdits a focused state, draft, semantic transition, or terminal connection.
Shift+EnterQuick-connects eligible Chart items; selecting the primary state again creates a self-transition.
Delete or BackspaceImmediately deletes the Chart selection through the shared command planner.
Arrow keysMoves selected items or a focused draft endpoint; pans when no item consumes the key.
Shift+ArrowUses the larger movement step.
Alt+Up/DownResizes selected expanded states; Shift adds the larger step.
Plus or EqualsZooms in.
MinusZooms out.
Fit Chart buttonFits the editable Chart; Home has no fitting action.

Palette State, Initial Indicator, Terminal Indicator, and Transition controls are drag-only. Click, Enter, and Space do not place an item; complete semantic creation remains available in Editor and dialogs. Each glyph is a smooth 32-by-32 SVG with an equally sized icon-only drag image.

A successful Open or Server Pull fits the diagram once on its first editable Chart visit. Automatic Layout also fits its result. Ordinary edits, Palette drops, and navigation away from and back to Chart preserve the working viewport; a new empty file starts at 100 percent.

Status-Bar Fields

FieldMeaning
Initial StateCurrent semantic initial state, or N/A when unset or no project is open.
StatesDeclared state count.
EventsDeclared event count.
Declared ActionsReusable action count.
Entry ActionsOrdered entry-assignment count, including duplicates.
Exit ActionsOrdered exit-assignment count, including duplicates.
TransitionsSemantic transition-table row count.
ServerConnected, Connecting, or Disconnected with text and symbol cues.
Chart Elements SelectedActive-Chart selection count; omitted when zero or another page is active.
Chart export statusSuccessful filename or browser download-location limitation while Chart is active.
Simulator StateCurrent state of the active Simulator session.
Session StaleIndicates that the session remains pinned to an older hosted revision.

Durable failures, warnings, operation outcomes, and remedies belong in Console. The status bar scrolls horizontally when its fields do not fit the available width.

File and CSV Formats

An Automata Lab JSON file is UTF-8, has file_id: "automata-lab-state-machine", accepts file versions 1.0.0, 1.1.0, 1.2.0, 1.3.0, and 1.4.0, and requires settings, state_machine, chart, solver, and simulator. Save always writes 1.4.0 with explicit state terminal flags, deterministic two-space JSON and a trailing newline. See Files and Data Exchange for migration, CSV flag rules and strict-reader behavior.

Canonical CSV columns are:

CollectionHeader
Model Metadataname,description,version,initial_state
Statesname,description,terminal_state
Eventsname,description
Actionsname,description
State Actionsstate,action,schedule
Transition Tablestate,event,next_state
Solver Observation Sequencename,type
Simulator Event Sequencename

CSV input is UTF-8, accepts quoted fields and embedded newlines, matches required headers without case or surrounding whitespace, and ignores unknown columns. Export uses canonical column order, RFC 4180 escaping, CRLF records, and one final CRLF. An invalid applicable row rejects the entire import; Model Metadata only applies its first non-empty data row and warns when extra records are ignored.

Common Diagnostic Codes

CodeMeaning or next action
SHELL_READYApplication startup completed.
VALIDATION_PASSEDThe current model passed complete validation.
STATE_DEFINITIONS_MISSINGAdd at least one state before strict operations.
INITIAL_STATE_REQUIREDChoose an initial state before strict operations.
JSON_MALFORMEDCorrect JSON syntax before Open.
DUPLICATE_JSON_MEMBERKeep one occurrence of each JSON object member.
FILE_ID_INVALIDUse the exact Automata Lab file identity.
FILE_VERSION_UNSUPPORTEDOpen with a release supporting that file version or convert explicitly.
FILE_TOO_LARGE or CSV_FILE_TOO_LARGEReduce input below 5 MiB.
FILE_OPENEDOpen transaction committed successfully.
FILE_SAVEDCanonical JSON write or download completed.
FILE_BACKUP_SKIPPEDCurrent Save succeeded without the optional sibling backup.
CSV_IMPORT_COMPLETEDThe complete selected collection import committed.
CSV_HEADER_MISSINGAdd every required canonical header.
CSV_REFERENCE_INVALIDDeclare the referenced model elements or correct the names.
DIAGNOSTICS_TRUNCATEDMore diagnostics exist than the bounded Console publication shows.
CHART_ROUTING_FALLBACKA relation remains visible without a proved normal route; inspect Chart geometry.
CHART_IMAGE_EXPORTEDImage save or download completed.
NO_OBSERVATIONSNo samples constrained the one-state candidate; add observations before relying on it.
SOLVER_CANDIDATE_READYA reviewable candidate was produced.
SOLVER_CANDIDATE_STALESolve again against the current document and observations.
SOLVER_CANCELLEDThe requested solve stopped without project mutation.
SERVER_CONNECTEDServer handshake and connection completed.
HOSTED_MODEL_CONFLICTHosted revision changed; Pull and reconcile before another Push.
HOSTED_MODEL_PUSHEDThe complete client project became the hosted head.
SIMULATION_SESSION_STALEClose the old session and start a new one to use the latest hosted model. Reset keeps the pinned revision.
UNKNOWN_EVENTEvent was consumed without state change or transition actions; Run continues.
NO_TRANSITIONDeclared event had no transition from the current state; Run continues.
PREFERENCE_CORRUPTInvalid stored preferences were replaced with safe defaults.
PRINT_FAILEDBrowser handoff or report composition failed; project state is unchanged.

Console supplies the authoritative message and remedy for the actual occurrence. Codes are stable identifiers, not a substitute for the associated context.

Glossary

TermMeaning
ActionInert reusable name reported during state entry or exit; never executable code.
Authoring draftEditable project. Save and Open permit missing states or initialization, while other integrity failures remain blocking.
Canonical documentStrict deterministic file 1.4.0 with explicit state terminal flags.
Chart draftVisual transition with coordinates, optional state/indicator attachments and event memory; no runtime effect until configured or restored.
Complete modelValid model containing at least one state and a declared initial state.
Entry actionAction reported after entering a destination state or on the first execution after Reset.
EventInput symbol consumed by the deterministic transition function.
Exit actionAction reported before leaving a source state, including a self-transition.
Hosted revisionImmutable canonical project snapshot identified by server revision.
Initial indicatorSole UML filled dot whose optional visual attachment follows initial-state rules.
Initial stateSemantic state selected when a Simulator session starts or resets.
ObservationTyped partial evidence supplied to the Solver.
Partial transition tableDeterministic mapping in which some state-and-event pairs may be undefined.
Pinned sessionSimulator session that continues using the hosted revision on which it started.
Revision conflictCompare-and-set rejection because the hosted baseline changed unexpectedly.
Solver candidateImmutable inferred model available for review before an explicit Apply.
Stale candidateCandidate whose source document or observation revision changed.
Stale sessionPinned session whose semantic revision differs from the current hosted head.
StateNamed runtime condition with ordered entry and exit action lists.
Terminal indicatorUML final notation synchronized with connected states' terminal flags.
Terminal stateState that stops enabled execution after its entry actions complete.
TransitionDeterministic destination selected by one source-state and event pair.

Previous: Limits, Privacy, and Security

Next: Developer Guide