- Documentation
- /
- Area
- /
- 01 — Quick Reference
01 — Quick Reference
Menu map
| Group | Models |
|---|---|
| Audit Register | Entity · AuditReport · Recommendation · StatusHistory |
| Responses & Actions | ManagementResponse · ImplementationAction · Milestone |
| Evidence & Validation | EvidenceRequirement · EvidenceSubmission · ValidationTest · EvidenceValidation |
| Assurance & Closure | Exception · Risk · AssuranceDecision · ClosureRequest · ClosureApproval |
Every model (16) — one line each
| Model | It records | Key foreign keys |
|---|---|---|
| Entity | An audited organisation | — |
| AuditReport | A tabled audit report | — |
| Recommendation | The recommendation being tracked | AuditReport, Entity, (self: supersedes) |
| ManagementResponse | The entity's response position | Recommendation |
| ImplementationAction | A committed delivery action | Recommendation |
| Milestone | A checkpoint within an action | ImplementationAction |
| EvidenceRequirement | Required evidence | Recommendation, ImplementationAction |
| EvidenceSubmission | Evidence provided | Recommendation, ImplementationAction, EvidenceRequirement, (self: supersedes) |
| ValidationTest | A reusable sufficiency test | — |
| EvidenceValidation | Independent validation of evidence | Recommendation, ImplementationAction, EvidenceSubmission, ValidationTest |
| Exception | A gap/deficiency (maybe blocking) | Recommendation, ImplementationAction, EvidenceValidation |
| Risk | Risk from a recommendation/exception | Recommendation, Exception |
| AssuranceDecision | An authorised decision | Recommendation, Exception |
| ClosureRequest | A request to close | Recommendation |
| ClosureApproval | The closure outcome | ClosureRequest |
| StatusHistory | A recommendation state transition | Recommendation |
Status vocabularies
- Recommendation status: DRAFT → ISSUED → RESPONSE_DUE → RESPONSE_RECEIVED → IMPLEMENTATION_IN_PROGRESS → EVIDENCE_PENDING → VALIDATION_PENDING → (EXCEPTION_OPEN ⇄) READY_FOR_CLOSURE → CLOSED · plus SUPERSEDED, WITHDRAWN
- Priority: LOW · MEDIUM · HIGH · CRITICAL
- Response position: ACCEPT · PARTIAL_ACCEPT · DO_NOT_ACCEPT · UNDER_REVIEW
- Action status: NOT_STARTED · IN_PROGRESS · BLOCKED · COMPLETED · CANCELLED
- Assurance status: NOT_ASSESSED · PENDING · SUFFICIENT · PARTIALLY_SUFFICIENT · INSUFFICIENT · NOT_APPLICABLE
- Evidence status: DRAFT · SUBMITTED · RETURNED · ACCEPTED · SUPERSEDED
- Validation outcome: NOT_TESTED · SUFFICIENT · PARTIALLY_SUFFICIENT · INSUFFICIENT · NOT_APPLICABLE
- Exception status: OPEN · ACKNOWLEDGED · TREATMENT_IN_PROGRESS · RESOLVED · CLOSED · ACCEPTED
- Closure outcome: APPROVED · REJECTED · DEFERRED
Demo data set (35 rows)
| Model | Rows | Model | Rows | |
|---|---|---|---|---|
| Entity | 2 | EvidenceSubmission | 3 | |
| AuditReport | 1 | ValidationTest | 2 | |
| Recommendation | 2 | EvidenceValidation | 3 | |
| ManagementResponse | 2 | Exception | 1 | |
| ImplementationAction | 3 | Risk | 1 | |
| Milestone | 2 | AssuranceDecision | 1 | |
| EvidenceRequirement | 3 | ClosureRequest | 1 | |
| ClosureApproval | 1 | |||
| StatusHistory | 7 |
Reseed from empty: python apps/area/scripts/seed_data.py (skips if data already present).
Local run
python server/run.py area # http://localhost:5072