01 — Quick Reference

Group Models
Reference Data SiteRef · AssetRef
Work WorkRequirement · WorkPackage · WorkOrder
Package Planning LabourRequirement · MaterialRequirement · ToolRequirement · AccessRequirement
Execution & Verification ExecutionRecord · VerificationRecord · ReturnToService
Integration ExternalRecordLink

Every model (14) — one line each

Model It records Key foreign keys
SiteRef A site/facility —
AssetRef An asset (class, criticality) SiteRef
WorkRequirement The need for work (source, priority, status) SiteRef, AssetRef
WorkPackage The plannable unit of work (planning + readiness state) WorkRequirement
LabourRequirement Trade/skill, headcount, hours for a package WorkPackage
MaterialRequirement A material a package needs (fulfilment status) WorkPackage
ToolRequirement A tool/kit a package needs WorkPackage
AccessRequirement Access/isolation/permit/scaffold/crane/area WorkPackage
WorkOrder Authority to execute (LOCAL or EXTERNAL_ERP) WorkPackage
ExecutionRecord What was done (timings, failure/repair codes) WorkOrder
VerificationRecord A check with a PASS/FAIL/CONDITIONAL outcome WorkOrder
ReturnToService The return-to-service decision WorkOrder
ExternalRecordLink A local↔external-system record mapping — (string refs)

Status vocabularies

  • Requirement source: DEFECT · INSPECTION · CONDITION · PLANNED · BREAKDOWN · PROJECT · MANUAL · EXTERNAL
  • Requirement priority: ROUTINE · PLANNED · URGENT · EMERGENCY
  • Requirement status: NEW → TRIAGED → APPROVED / REJECTED → PACKAGED · CANCELLED
  • Package planning status: DRAFT → PLANNING → READY → (BLOCKED) → RELEASED → IN_EXECUTION → TECHNICAL_COMPLETE → VERIFIED → CLOSED · CANCELLED
  • Package readiness state: NOT_ASSESSED · NOT_READY · PARTIAL · READY
  • Material fulfilment: REQUIRED · REQUESTED · RESERVED · ORDERED · RECEIVED · STAGED · READY · SHORT
  • Work-order authority: LOCAL · EXTERNAL_ERP
  • Work-order operational status: CREATED → RELEASED → STARTED → (PAUSED) → TECHNICAL_COMPLETE → VERIFIED → CLOSED · CANCELLED
  • Verification outcome: PASS · FAIL · CONDITIONAL
  • Return-to-service decision: APPROVED · REJECTED · CONDITIONAL

Cross-app canonical_ref conventions

mwem is part of the Work & Supply network, so records carry stable canonical_ref identifiers that are shared with the sibling apps (never reused, never a database FK — cross-app references are strings). Common prefixes:

Prefix Example Owned/used by
site: site:demo-01 amia (asset master) → mwem, msam, scrm
asset: asset:p-101 amia → mwem
material: material:brg-6208 msam ← mwem MaterialRequirement
workreq: / workpkg: / workorder: workpkg:wp-1001 mwem (exposed to network)
permit: permit:pmt-1001 cwia ← mwem AccessRequirement external_canonical_ref

The golden thread: mwem MaterialRequirement for material:brg-6208 on workpkg:wp-1001 is SHORT → emits work.material_required → msam MaterialDemand → material.procurement_required → psam PurchaseRequirement; the package also appears as scope in a scrm campaign.

Local run

python server/run.py mwem          # http://localhost:5082

Seed / regenerate

python -m codegen.cli seed mwem            # load apps/mwem/schema/mwem_seed.yaml
python -m codegen.cli seed mwem --reset    # wipe + reload the sample data
python -m codegen.cli all mwem             # regenerate models/controllers/menu/config
python scripts/build_diagram_viewer.py mwem  # rebuild the interactive diagram viewer