Protection Settings Editor User Flows
This document captures the intended user workflows for the protection settings editor. It is a product/reference guide for future implementation and hardening work.
Core Model
The editor supports two related surfaces:
- SLD edit-panel flow: fast per-device setup while drawing or reviewing the one-line.
- Protection settings workspace flow: deeper coordination review, TCC curves, catalog details, overrides, and audit-style editing.
Both surfaces must use the same underlying persistence and validation rules. A setting should never look saved unless the server can prove it is valid for the mounted catalog, SKU, and rating at that moment.
1. First-Time Device Setup
Trigger: the user selects a breaker, fuse, relay, or switch on the SLD.
Flow:
- Open the protection device in the edit panel.
- Show basic device fields first: device type, rated current, voltage, interrupting rating, and poles.
- User opens the protection settings section.
- System detects the device family:
- LV breaker
- thermal-magnetic breaker
- fuse
- HV breaker and relay
- switch or other non-OCPD device
- User selects a catalog model or chooses a generic/manual path.
- For LV breakers, user selects breaker frame, compatible trip unit or thermal-magnetic package, and SKU/rating when available.
- Editor shows only settings valid for the mounted model.
- User changes settings.
- Save status is visible: Saving, Saved, Could not save, or Model changed.
Required states:
- No catalog selected: show setup prompt.
- Catalog selected but missing SKU/rating: explain that rated current is required.
- Incompatible trip unit: block selection or explain why it cannot be mounted.
- Stale catalog/model during save: reject the save and ask the user to reload or reselect.
2. Thermal-Magnetic Breaker Flow
Trigger: the selected device is a thermal-magnetic LV breaker or mounted thermal-magnetic trip package.
Flow:
- Show breaker frame/SKU and rated current
In. - Show valid thermal dial options.
- Show valid magnetic pickup options.
- Show manual override fields only when supported.
- User picks a thermal dial, for example
0.8 x In. - User picks magnetic pickup, for example
6 x In. - UI shows computed values:
- Thermal pickup:
80 A - Magnetic pickup:
600 A
- TCC preview updates immediately.
- Server persists only values matching mounted catalog detents/options.
Failure and recovery:
- User enters
6.3 x In: block or reject with the required increment/options. - Breaker rating changes from
100 Ato125 A: revalidate saved settings against the new rating. - Saved value no longer exists in catalog: show an orphan warning and let the user choose a valid replacement.
3. Electronic Trip Unit Flow
Trigger: the selected LV breaker uses an electronic trip unit.
Flow:
- Show settings grouped by protection function:
- Frame and sensor
- Long time
- Short time
- Instantaneous
- Ground fault
- ZSI and maintenance mode
- User edits pickup and delay settings.
- Disabled functions collapse or hide dependent fields.
- TCC preview updates by function.
- Server validates catalog ranges/options before persistence.
UX requirements:
- If Ground Fault is off, hide or disable GF settings while preserving previous values.
- If Instantaneous is off, preserve old INST values but do not plot the active INST curve.
- Show pickup as entered value and calculated amps wherever possible.
4. Fuse Flow
Trigger: the selected device is a fuse.
Flow:
- Show fuse catalog/model selector.
- User selects fuse class, type, and ampere rating.
- If no catalog model exists, user can still choose fuse class and amp rating manually.
- TCC uses catalog curve data when available.
- If no curve exists, show a clear curve-unavailable state.
- Save updates the fuse settings layer, not generic protection-device fields.
Important rule:
Fuse-specific fields are split across persistence layers. fuseClass belongs under device_components plus fuse_settings, not the generic protection_devices path.
5. Relay And HV Breaker Flow
Trigger: the selected device is an HV breaker with protective relay settings.
Flow:
- Show two related blocks:
- Breaker mechanical/electrical ratings
- Protective relay settings
- User selects relay model.
- User configures overcurrent elements:
- Phase pickup
- Ground pickup
- Curve standard/type
- Time dial
- Instantaneous
- Directional or reclose settings when supported
- TCC preview shows relay curves.
- Breaker clearing time is shown as part of total clearing context.
UX requirements:
- Make it clear which settings belong to the relay versus the breaker.
- Do not present relay settings as breaker nameplate data.
6. TCC Review Flow
Trigger: the user opens the full protection settings workspace from the SLD, selected device, or project sidebar.
Flow:
- Left side shows protection device list or hierarchy.
- Middle area shows selected device identity and settings.
- Right side shows sticky TCC preview.
- User changes a setting.
- TCC updates and labels curve provenance:
- Catalog/manufacturer
- Digitized reference
- Generated from settings
- Overridden
- User compares upstream and downstream devices.
- User saves or accepts changes.
- Missing, stale, or generated curve data remains visible.
Useful actions:
- Open selected device on SLD.
- Show upstream/downstream devices.
- Reset setting to catalog default.
- View source/catalog evidence.
- Override curve.
- Replace or dismiss orphaned setting after correction.
7. Catalog Change Or Re-Mount Flow
Trigger: user changes breaker frame, trip unit, fuse model, SKU, or mounted protection component.
Flow:
- System checks existing saved settings against the new mounted model.
- If compatible, keep valid settings and recompute effective amps.
- If invalid, mark settings as orphaned.
- Show old value and valid replacement choices.
- User confirms replacement or resets to catalog default.
- TCC refreshes after both settings and component queries settle.
Rule:
Do not silently discard settings unless the user explicitly confirms replacement or reset.
8. Manual Or Generic Device Flow
Trigger: user chooses a manual/generic model because a catalog entry is unavailable.
Flow:
- Expose minimal required settings:
- Rated current
- Voltage rating
- Interrupting rating
- Device type
- Pickup/delay values when relevant
- Label curves as generated/manual.
- User can later attach a catalog model.
- System attempts to map manual settings to catalog options and flags mismatches.
9. Error And Stale-State Flow
Every save should have a visible recovery path.
Cases:
- Save failed: keep edited value locally and show retry.
- Server rejected value: show exact validation reason.
- Model changed during editing: block save and reload current model/settings.
- Query refresh returns older data briefly: suppress false stale warnings while refresh is in flight.
- Catalog deleted or inactive: keep mounted component readable, but require replacement before editing.
Recommended Editor Shape
SLD edit panel:
- Basic Protection Device
- Catalog / Model
- Settings
- Effective Pickups / Ratings
- Sizing Status
- Mini TCC / Open Full Protection Review
Full protection settings page:
- Device tree
- Selected device identity
- Function settings
- TCC chart
- Curve/source details
- Validation/audit panel
Product Rule
The protection settings editor must not rely on browser-only validation. Any setting save path must validate against the currently mounted component model, catalog, SKU, rating, and available setting controls on the server before persistence.