dohertj2/ScadaBridge
1
0
Fork 0
Code Issues 15 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(components): reference docs for ScriptAnalysis, KpiHistory and DelmiaNotifier (ScadaBridge#72)

Browse Source 
Claude-Session: https://claude.ai/code/session_01GT67AEHd2Acv1YPwGfXEoV
This commit is contained in:
Joseph Doherty
2026-11-09 15:02:49 -05:00
parent baf89b3df7
commit 69a2017000
6 changed files with 363 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/components/README.md
+5 -4
View File
@@ -5,9 +5,7 @@ code in `src/` actually works — with real code examples. These complement the
[design specs](../requirements/) in `docs/requirements/`: the specs say what a
component should do and why; these docs say how the code does it.
Reference docs exist for 24 of the 27 components (plus the shared TreeView, listed below).
ScriptAnalysis (#25), KpiHistory (#26), and DelmiaNotifier (#27) are pending — tracked in
[../plans/2026-07-08-deferred-work-register.md](../plans/2026-07-08-deferred-work-register.md).
Reference docs exist for all 27 components (plus the shared TreeView, listed below).
| # | Component | Description |
|---|-----------|-------------|
@@ -35,7 +33,10 @@ ScriptAnalysis (#25), KpiHistory (#26), and DelmiaNotifier (#27) are pending —
| 22 | [Site Call Audit](SiteCallAudit.md) | The central `SiteCallAuditActor`, the `SiteCalls` mirror table, telemetry ingest, and the parked-call Retry/Discard relay. |
| 23 | [Audit Log](AuditLog.md) | The append-only audit store: site SQLite hot-path, gRPC telemetry, central ingest and reconciliation, redaction, retention, and KPIs. |
| 24 | [Transport](Transport.md) | Encrypted bundle export and import, dependency resolution, conflict detection, and `BundleImportId`-correlated audit. |
| 25 | [Tree View](TreeView.md) | The reusable Blazor tree component — parameters, selection modes, and usage in the Central UI. |
| 25 | [Script Analysis](ScriptAnalysis.md) | The script trust model and validator, the diagnostics-only compile gate, the blocking-wait advisory, and the static flow-shape predictor. |
| 26 | [KPI History](KpiHistory.md) | The central `KpiHistoryRecorderActor` singleton: KPI sampling, hourly rollups and backfill, and retention purge. |
| 27 | [Delmia Notifier](DelmiaNotifier.md) | The `WWNotifier` console client DELMIA shells out to, its YES/NO contract, and pre-execution-only failover. |
| 28 | [Tree View](TreeView.md) | The reusable Blazor tree component — parameters, selection modes, and usage in the Central UI. |
## Related Documentation