Skip to content
LQMS
ADR-0031: Released-base readability enforcement & copy-on-derive mechanics
Initializing search
nburri/lqms
LQMS
nburri/lqms
Home
Evaluate LQMS
Evaluate LQMS
LQMS Known Limits
LQMS Security Posture
Architecture
Architecture
1. Introduction and Goals
2. Architecture Constraints
3. Context and Scope
4. Solution Strategy
5. Building Block View
6. Runtime View
7. Deployment View
8. Crosscutting Concepts
9. Architecture Decisions
10. Quality Requirements
11. Risks and Technical Debt
12. Glossary
The arrival bundle format
Decisions (ADRs)
Decisions (ADRs)
ADR-0001: Content-Addressed Document Storage with PostgreSQL as Source of Truth
ADR-0002: Single Instance with Scope Hierarchy and Copy-on-Derive
ADR-0003: Fixed Life Cycle States with Configurable Review Processes
ADR-0004: Global Catalogs for Roles and Document Types with Per-Scope Activation
ADR-0005: Modular Monolith
ADR-0006: Three-Layer Search with In-Database Index and Pluggable LLM
ADR-0007: Angular Frontend with Server-Side-Only Enforcement
ADR-0008: Flyway Migrations and jOOQ Codegen from the Migrated Schema
ADR-0009: RLS Enforcement via a Session-Scoped Authorized Scope Set
ADR-0010: Self-Managed QMS via an Internal Mandator
ADR-0011: Authentication via OIDC SSO with Server-Side (BFF) Sessions
ADR-0012: Permission-Based Authorization and System Bootstrap
ADR-0013: User Identity Lifecycle
ADR-0014: Electronic Signatures (Part 11 / Annex 11-Capable)
ADR-0015: Document Effectivity, Periodic Review & Validity
ADR-0016: Data Retention, Disposal & Privacy (FADP / GDPR)
ADR-0017: Multi-Part Version Content
ADR-0018: Non-Functional Targets (Capacity, Availability, Security)
ADR-0019: Notifications & Tasks
ADR-0020: Internationalization (Content Language, Time Zones, Formatting)
ADR-0021: General Typed Document Relationships
ADR-0022: Read-Acknowledgement & Questionnaires
ADR-0023: Migration / Import — Current Released State
ADR-0024: Draft / In-Review Cancellation
ADR-0025: Disposal & Erasure Mechanics (Storage, Index, Backups)
ADR-0026: RLS Runtime Safety — Connection-Pool Scope Isolation
ADR-0027: RLS Boundary — Content-Plane vs Control-Plane
ADR-0028: Stateless Encrypted Token-State Cookie (no server-side session store)
ADR-0029: Document Content Model — Draft-Freeze, Content-Table RLS, Append-Only Audit
ADR-0030: Review & Life-Cycle Realization Model
ADR-0031: Released-base readability enforcement & copy-on-derive mechanics
ADR-0031: Released-base readability enforcement & copy-on-derive mechanics
Table of contents
Context
Options Considered
Option A — State-aware permissive RLS policy (RLS remains the backstop)
Option B — Resolve the global scope into the authorized scope set (rejected)
Option C — Application-enforced read path; global base stays out of RLS
Decision
Performance (Option A constraints)
Consequences
ADR-0032: Frontend realization — Quinoa, Angular Material, i18n & E2E
ADR-0033: CSRF control for the BFF session — SameSite + JSON content-type
ADR-0034: Notification realization — in-process domain events + system-context fan-out
ADR-0035: Fan-out contract as shipped — gate semantics, count disclosure, audit protocol
ADR-0036: Repository layer — services carry rules, repositories carry jOOQ
ADR-0037: Task scheduler — in-process tick, advisory-lock election, SQL sweep
ADR-0038: Periodic-review realization — derived due date, policy-gated confirmation
ADR-0039: Sweep & periodic-review contract as shipped — grants, guards, addressing
ADR-0040: Disposal-due surfacing — closure-anchored retention, scope-level legal hold
ADR-0041: Email channel & notification i18n — notification-as-outbox, structured messages
ADR-0042: Disposal execution — document tombstoning, single-actor hard-gated destruction
ADR-0043: Disposal blob deletion is post-commit, GC-backstopped
ADR-0044: Search FTS baseline — event-indexed, RLS-scoped search_index
ADR-0045: Image Attachments as Content Parts (Rich-Content Slice R2)
ADR-0046: Four-Eyes — Submitter Excluded from Approval
ADR-0047: Four-Eyes — Submitter-Only Exclusion
ADR-0048: Document Organization — Folder Tree per Scope
ADR-0049: Content Model Round 2 — Type Categories, Template Instantiation, Trace Relations, Completeness Rules
ADR-0050: Live Frontend — SSE State Push, CodeMirror 6, Draft Presence
ADR-0051: In-Text Document Links (doc: Scheme)
ADR-0052: Addressees & Read-Acknowledgement (REQ-TRN Realization)
ADR-0053: Addressees Per Document + Process Owner (amends ADR-0052 K-1)
ADR-0054: Process Owner Is a Role (amends ADR-0053 P-3)
ADR-0055: WYSIWYG Editing Mode over Markdown (editor step R4)
ADR-0056: Visual-Editor Chrome via Milkdown Crepe (gated adoption)
ADR-0057: Content Record Is the ProseMirror Document Tree; Markdown Becomes a Derived Projection
ADR-0058: PM_DOC Is the Only Content Format (pre-production cut; amends ADR-0057 §5)
ADR-0059: Editor Engine Switches to TipTap (spike-gated; supersedes the Milkdown/Crepe choice)
ADR-0060: Backup & Restore — Scripted Ordered Backup with Automated Restore Rehearsal
ADR-0061: CSV — Generated Validation Package per Release
ADR-0062: SBOM — CycloneDX over the Production Layers, Validated Against the Artifact
ADR-0063: User Identity Binds on Subject Only (Issuer Becomes Provenance)
ADR-0064: Per-Document Workflow Role Bindings (Author / Reviewer / Releaser), Enforced
ADR-0065: Diagrams — Excalidraw as the Manual Layer, Mermaid Stays for Text-First/UML
ADR-0066: WITHDRAW — the Author Side May Reclaim a Version from Review
ADR-0067: Review Comments — Anchored, Immutable, Resolvable
ADR-0068: Confluence/Jira QMS Import — Staged, Read-Only, Repeatable
ADR-0069: Arbitrary File Attachments — Download-Only Confinement
ADR-0070: Training Questionnaires — Versioned, Auto-Scored, Release-Gated
ADR-0071: Training Plans — Document Obligations + External Trainings & Certifications
ADR-0072: Diagrams — Self-Hosted draw.io Replaces Excalidraw
ADR-0073: Per-Scope QMS Configuration Surface
ADR-0074: PDF Export of Released Documents — Server-Side via Apache FOP over the Canonical Projection
ADR-0075: Source History Import — Continuity Without Forged Audit
ADR-0076: Periodic-review status visibility (completing MVP gap #2)
ADR-0077: Requirement Items — Keyed Blocks Inside Controlled Documents
ADR-0078: Generalized Trace Items (Traceability Model — Stage A)
ADR-0079: Risk & Risk-Control Items (Traceability Model — Stage B)
ADR-0080: Traceability Workspace — Hub, Sub-Pages, and Role-Gated Views
ADR-0081: Draft-Only Trace-Structure Changes, Server-Enforced
ADR-0082: Table-Shaped Risk Authoring over Risk Blocks
ADR-0083: The TD Dossier — a Versioned, Cross-Scope, Regulatory-Structured Deliverable
ADR-0084: Validation & Regulatory Axes (Traceability Model — Stage C)
ADR-0085: Relation-Layer Consolidation — One Trace Vocabulary, One Surface
ADR-0086: Requirement Traceability Chains — End-to-End Path View + Flat Path Export
ADR-0087: The Scope Traceability Report — One Derived Overview Artifact, Never a Controlled Document
ADR-0088: Verification Evidence Classes — Planned vs. Verified, Derived at the Read Layer
ADR-0089: Recurring Obligations — Periodic Tasks With Record Evidence, Not Calendar Series
ADR-0090: Release & Versioning Policy — Deliberate Releases, One Auditor-Facing Number
ADR-0091: Release Modes — Single-Person Record Release With a Structural Four-Eyes Floor
ADR-0092: Orphan-Blob Garbage Collection With a Quarantine Bin
ADR-0093: One Scope Context — the Toolbar Switcher Is the Only Scope Selector
ADR-0094: Calendar-Anchored Obligation Schedules (Clamped, Never Too Late)
ADR-0095: Key-Rule Governance — Free Until First Use, Then Frozen
ADR-0096: Transition Permissions — Always Visible, Deny Unless Granted
ADR-0097: A Governed Provisioning Surface — MANAGE_SCOPES
ADR-0098: Org Chart × Role System — Marriage at the Evidence Level, Never in Authorization
ADR-0099: The User Manual is an In-App Topic Reference, Not a Document
ADR-0100: LQMS Is the Living Quality Management System
ADR-0101: The Executable Validation Journey (PQ Evidence That Cannot Drift)
ADR-0102: Typed Template Variables (text | date | number — and Deliberately No Enum)
ADR-0103: npm audit Joins the Verification Gate as a Second Standing Input
ADR-0104: The Issued Dossier Is a Persisted Artifact of Record — and Clones to a New Draft
ADR-0105: Navigation Information Architecture — Group by Moment-of-Use
ADR-0106: The Client Reflection Follows Assignments, Not Only Content Reach
ADR-0107: The Audit Append Gate Follows Assignment Reach, Not Content Reach
ADR-0108: Mandator Membership — Invite-Accept, with Pre-Assigned Responsibilities
ADR-0109: Organization Founding Is Its Own Process
ADR-0110: The Audit Trail Is Not a Read Model
ADR-0111: The Imported-Person Model, and Project Portability's First Doctrines
ADR-0112: The Element-Kind Catalog — Semantics in the Model, Not Only in the Code
ADR-0113: Project Arrival Import — Records Arrive as They Are, People Arrive as They Were
ADR-0114: The Operating Model Arrives — Roles as Functions, Names as Words, People as This Instance's Decision
ADR-0115: Collaborative Draft Editing — Two Carets, One Truth, Honest Credit
ADR-0116: The System Maintenance Surface — the App Backs Itself Up, the Host Keeps One Dumb Job
ADR-0117: Role Documentation — a Link, a Finding, Per-Source Recognizers; Substitution Rejected
ADR-0118: The Offline QMS Copy — the Repo Carries the Audit Pack, Not a Second Renderer
ADR-0119: Module-Internal Package Structure — Capabilities First, Layers Second, the Root Is the Surface
ADR-0120: The Shared Kernel — the Domain-Exception Vocabulary Leaves the Authorization Module
ADR-0121: The Project Administrator Role — Per-Scope Administration With Read Access, Seeded in the Base Catalog
ADR-0122: Organization-Level Administration — the Cascade Stays, Becomes Visible, and Founds Projects
ADR-0123: Draft Save-Points — Every Save Restorable, Kept for the Life of the Version
ADR-0124: The Birth Path Completes Without Borrowing Content Clothes
ADR-0125: The Export Twin — Export Emits an Arrival Bundle
ADR-0126: Project Dissolution — the Un-Birth of an Unused Scope
ADR-0127: The Base-QMS Layers — One Library, Derived Adaptations, Local Records
ADR-0128: The GLOBAL Cascade Carries Administration, Never Content
ADR-0129: Role Identity from a GLOBAL Assignment Acts in GLOBAL Alone
ADR-0130: Break-Glass — the Project Administrator's Escalation Is a First-Class, Witnessed, Self-Expiring Act
ADR-0131: Role Substitution as Declared Adoption Edges — Emergency Cover Is Governed, Own-Name, Timed Staffing
ADR-0132: Dual-Hat Reviewer Satisfaction Is a Declared Policy Choice — the Strict Floor Stays the Default
ADR-NNNN:
</span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" > <div class="md-nav__link md-nav__container"> <a href="../../requirements/" class="md-nav__link "> <span class="md-ellipsis"> Requirements </span> </a> <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0"> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_5"> <span class="md-nav__icon md-icon"></span> Requirements </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../requirements/stakeholder_requirements/" class="md-nav__link"> <span class="md-ellipsis"> Stakeholder Requirements </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/gap-analysis/" class="md-nav__link"> <span class="md-ellipsis"> Requirements Gap Analysis </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_admin/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Administration, Permissions & Onboarding </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_api_ui/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: API & User Interface </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_audit_reporting/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Audit Trail & Regulatory Reporting </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_auth/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Authentication & Session </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_backup/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Backup & Restore </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_catalogs/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Catalogs, Roles & Users </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_data_protection/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Data Protection, Retention & Disposal </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_documents/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Documents, Versions & Storage </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_dossiers/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Technical Documentation Dossiers </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_effectivity/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Effectivity, Periodic Review & Validity </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_gspr/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Regulatory Conformity (GSPR / Essential Principles) </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_i18n/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Internationalization </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_lifecycle/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Life Cycle & Reviews </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_memberships/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Mandator Membership & Invitations </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_migration/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Migration & Import </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_nfr/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Non-Functional </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_notifications/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Notifications & Tasks </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_obligations/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Recurring Obligations </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_relationships/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Document Relationships </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_risk/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Risk Management (ISO 14971 Hazards & Controls) </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_sbom/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Software Bill of Materials & Supply-Chain Assurance </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_search/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Search </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_separation/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Scopes, Mandators & Separation </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_signatures/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Electronic Signatures </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_training/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Read-Acknowledgement & Questionnaires </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_users/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: User Identity & Lifecycle </span> </a> </li> <li class="md-nav__item"> <a href="../../requirements/req_validation/" class="md-nav__link"> <span class="md-ellipsis"> Software Requirements: Design Validation & the Validation Traceability Axis </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" > <div class="md-nav__link md-nav__container"> <a href="../../process/" class="md-nav__link "> <span class="md-ellipsis"> Process (IEC 62304) </span> </a> <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0"> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_6"> <span class="md-nav__icon md-icon"></span> Process (IEC 62304) </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../process/configuration_management_plan/" class="md-nav__link"> <span class="md-ellipsis"> Configuration Management Plan </span> </a> </li> <li class="md-nav__item"> <a href="../../process/problem_resolution/" class="md-nav__link"> <span class="md-ellipsis"> Problem Resolution Process </span> </a> </li> <li class="md-nav__item"> <a href="../../process/risk_management/" class="md-nav__link"> <span class="md-ellipsis"> Risk Management </span> </a> </li> <li class="md-nav__item"> <a href="../../process/software_development_plan/" class="md-nav__link"> <span class="md-ellipsis"> Software Development Plan </span> </a> </li> <li class="md-nav__item"> <a href="../../process/verification_plan/" class="md-nav__link"> <span class="md-ellipsis"> Verification Plan </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" > <label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0"> <span class="md-ellipsis"> Operations </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_7"> <span class="md-nav__icon md-icon"></span> Operations </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../operations/genesis-installation/" class="md-nav__link"> <span class="md-ellipsis"> Genesis: Birthing an LQMS Installation with a Base Library </span> </a> </li> <li class="md-nav__item"> <a href="../../operations/deployment/" class="md-nav__link"> <span class="md-ellipsis"> LQMS Deployment Guide </span> </a> </li> <li class="md-nav__item"> <a href="../../operations/server-deployment/" class="md-nav__link"> <span class="md-ellipsis"> LQMS Server Deployment (single Linux host, public HTTPS) </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" > <div class="md-nav__link md-nav__container"> <a href="../../traceability/" class="md-nav__link "> <span class="md-ellipsis"> Traceability </span> </a> <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0"> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_8"> <span class="md-nav__icon md-icon"></span> Traceability </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../traceability/matrix/" class="md-nav__link"> <span class="md-ellipsis"> Requirements Traceability Matrix </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" > <div class="md-nav__link md-nav__container"> <a href="../../validation/" class="md-nav__link "> <span class="md-ellipsis"> Validation (tool lane) </span> </a> <label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0"> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_9"> <span class="md-nav__icon md-icon"></span> Validation (tool lane) </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../validation/templates/ai-authorship-posture/" class="md-nav__link"> <span class="md-ellipsis"> AI-Authorship Posture — How LQMS Is Built, and Why the Validation Evidence Does Not Rest on It (TEMPLATE) </span> </a> </li> <li class="md-nav__item"> <a href="../../validation/templates/intended-use/" class="md-nav__link"> <span class="md-ellipsis"> Intended-Use Specification — LQMS as a QMS / Document-Control Tool (TEMPLATE) </span> </a> </li> <li class="md-nav__item"> <a href="../../validation/templates/tool-risk-assessment/" class="md-nav__link"> <span class="md-ellipsis"> Tool-Risk Assessment — LQMS as a QMS Tool (TEMPLATE) </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" > <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0"> <span class="md-ellipsis"> Regulatory </span> <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_10"> <span class="md-nav__icon md-icon"></span> Regulatory </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../regulatory/mdr-annex-i-skeleton/" class="md-nav__link"> <span class="md-ellipsis"> MDR Annex I — GSPR authoring skeleton (paraphrased) </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" > <div class="md-nav__link md-nav__container"> <a href="../../user-guide/" class="md-nav__link "> <span class="md-ellipsis"> User guide </span> </a> <label class="md-nav__link " for="__nav_11" id="__nav_11_label" tabindex="0"> <span class="md-nav__icon md-icon"></span> </label> </div> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_11"> <span class="md-nav__icon md-icon"></span> User guide </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../user-guide/tutorial/" class="md-nav__link"> <span class="md-ellipsis"> Tutorial — from zero to a released document </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/administration/" class="md-nav__link"> <span class="md-ellipsis"> Administering an LQMS Installation </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/diagrams/" class="md-nav__link"> <span class="md-ellipsis"> Diagrams </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/documents-lifecycle/" class="md-nav__link"> <span class="md-ellipsis"> Documents & the Lifecycle </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/exports/" class="md-nav__link"> <span class="md-ellipsis"> PDF Exports & the Audit Pack </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/obligations/" class="md-nav__link"> <span class="md-ellipsis"> Recurring Obligations </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/project-context/" class="md-nav__link"> <span class="md-ellipsis"> The Project Context & App Version </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/review-comments/" class="md-nav__link"> <span class="md-ellipsis"> Review Comments </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/activity-trail/" class="md-nav__link"> <span class="md-ellipsis"> Who did what, when — reading a project's activity </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/admin-scopes/" class="md-nav__link"> <span class="md-ellipsis"> Renaming a project, and what can never change </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/authority-view/" class="md-nav__link"> <span class="md-ellipsis"> Who holds each function here, and what may it do </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/break-glass/" class="md-nav__link"> <span class="md-ellipsis"> The permission I need is held by a role I do not hold — what now? </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/coverage-and-chains/" class="md-nav__link"> <span class="md-ellipsis"> Coverage or chains? — which requirement view answers your question </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/credentials/" class="md-nav__link"> <span class="md-ellipsis"> Your password: changing it, resetting it — and why LQMS never sees it </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/emergency-cover/" class="md-nav__link"> <span class="md-ellipsis"> Who may cover for whom here — declaring emergency cover, and reading where the glass was broken </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/key-rules/" class="md-nav__link"> <span class="md-ellipsis"> Special elements: what a project declares, and when its names freeze </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/memberships/" class="md-nav__link"> <span class="md-ellipsis"> Belonging to an organization: invitations, acceptance, and what they change </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/provisioning-birth-path/" class="md-nav__link"> <span class="md-ellipsis"> How a new organization and project are born </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/review-policies/" class="md-nav__link"> <span class="md-ellipsis"> What a review policy controls, and what an empty grant means </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/setup-wizard-lanes/" class="md-nav__link"> <span class="md-ellipsis"> The setup wizard: the lanes, and what it writes </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/staffing-and-assignments/" class="md-nav__link"> <span class="md-ellipsis"> Staffing people into roles, and the accountable holder </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/topics/technical-dossier/" class="md-nav__link"> <span class="md-ellipsis"> How do I assemble a technical dossier? </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/trace-items/" class="md-nav__link"> <span class="md-ellipsis"> Trace Items — Requirements, Risks & Risk Controls </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/trace-links/" class="md-nav__link"> <span class="md-ellipsis"> Trace Links & the Suspect Cycle </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/traceability-workspace/" class="md-nav__link"> <span class="md-ellipsis"> The Traceability Workspace </span> </a> </li> <li class="md-nav__item"> <a href="../../user-guide/training/" class="md-nav__link"> <span class="md-ellipsis"> Training & Acknowledgements </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#context" class="md-nav__link"> <span class="md-ellipsis"> Context </span> </a> </li> <li class="md-nav__item"> <a href="#options-considered" class="md-nav__link"> <span class="md-ellipsis"> Options Considered </span> </a> <nav class="md-nav" aria-label="Options Considered"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#option-a--state-aware-permissive-rls-policy-rls-remains-the-backstop" class="md-nav__link"> <span class="md-ellipsis"> Option A — State-aware permissive RLS policy (RLS remains the backstop) </span> </a> </li> <li class="md-nav__item"> <a href="#option-b--resolve-the-global-scope-into-the-authorized-scope-set-rejected" class="md-nav__link"> <span class="md-ellipsis"> Option B — Resolve the global scope into the authorized scope set (rejected) </span> </a> </li> <li class="md-nav__item"> <a href="#option-c--application-enforced-read-path-global-base-stays-out-of-rls" class="md-nav__link"> <span class="md-ellipsis"> Option C — Application-enforced read path; global base stays out of RLS </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#decision" class="md-nav__link"> <span class="md-ellipsis"> Decision </span> </a> </li> <li class="md-nav__item"> <a href="#performance-option-a-constraints" class="md-nav__link"> <span class="md-ellipsis"> Performance (Option A constraints) </span> </a> </li> <li class="md-nav__item"> <a href="#consequences" class="md-nav__link"> <span class="md-ellipsis"> Consequences </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <a href="https://github.com/nburri/lqms/edit/main/docs/decisions/adr-0031-base-readability-and-derive-mechanics.md" title="Edit this page" class="md-content__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <h1 id="adr-0031-released-base-readability-enforcement--copy-on-derive-mechanics">ADR-0031: Released-base readability enforcement & copy-on-derive mechanics<a class="headerlink" href="#adr-0031-released-base-readability-enforcement--copy-on-derive-mechanics" title="Permanent link">¶</a></h1> <ul> <li><strong>Status:</strong> accepted</li> <li><strong>Date:</strong> 2026-07-01 (accepted; drafted 2026-06-30)</li> <li><strong>Deciders:</strong> Nicolas Burri</li> <li><strong>Relates to:</strong> <a href="../adr-0002-single-instance-scope-hierarchy/">ADR-0002</a> (copy-on-derive), <a href="../adr-0027-rls-content-vs-control-plane/">ADR-0027</a> (RLS content/control plane), <a href="../adr-0029-document-content-model/">ADR-0029</a> (content model & freeze), <a href="../adr-0026-rls-connection-pool-safety/">ADR-0026</a> (RLS is the hard backstop), <a href="../adr-0021-document-relationships/">ADR-0021</a> (<code>derived-from</code> provenance)</li> </ul> <blockquote> <p><strong>History.</strong> Drafted autonomously (night-shift 2026-06-30) to tee up Phase 5, then reviewed and accepted by Nicolas on 2026-07-01: <strong>Option A</strong> chosen, with the performance constraints below folded in. The <em>what</em> was already baselined (REQ-DOC-010 copy-on-derive; REQ-SEP-010 permission-gated, released-only base readability; <code>DERIVE</code>/<code>BASE_READ</code> in the V004 catalog); this ADR fixes the <em>enforcement mechanism</em> for "released-only" base readability, which touches the top quality goal (mandator/project separation) and the RLS backstop. The one implementation sub-question — the lifecycle state a derived copy lands in — was resolved at the 2026-07-01 checkpoint: <strong>DRAFT</strong> (re-review locally).</p> </blockquote> <h2 id="context">Context<a class="headerlink" href="#context" title="Permanent link">¶</a></h2> <p>Copy-on-derive (ADR-0002) lets a project adopt a <strong>released</strong> global-base version as a full, independent copy with a <code>derived-from</code> provenance link. Two reads of global-base content are in scope (REQ-SEP-010):</p> <ol> <li><strong>Explicit browsing</strong> — a user holding <code>BASE_READ</code> via a global-scope role assignment may read released base content (e.g. to decide what to derive).</li> <li><strong>Implicit during DERIVE</strong> — a user authorized to <code>DERIVE</code> into the target scope may read the specific released source version for the duration of the derive, even without <code>BASE_READ</code>.</li> </ol> <p>The tension is with the uniform content-RLS policy. Every content table (<code>document</code>, <code>document_version</code>, <code>content_part</code>) carries a <code>scope_id</code> and the policy is <code>scope_id = any (lqms_authorized_scope_ids())</code> (V007/V009/V010). The V007 comment already records the intended direction: <em>"released-base readability is a permission resolved into the authorized scope set."</em> But a scope set is <strong>row-blind</strong>: adding the global scope to a user's authorized set would expose <strong>all</strong> global content — including base <strong>drafts</strong> — whereas REQ-SEP-010 grants only <strong>released</strong> base content. <code>content_part</code> has no <code>state</code> column (state lives on <code>document_version</code>), so "released-only" cannot be expressed by <code>scope_id</code> membership alone.</p> <p>The project's standing principle is that <strong>RLS is the hard backstop</strong> (ADR-0026, RISK-001/002): a buggy or injected query must not be able to cross a separation boundary. The decision is <em>where and how</em> "released-only base readability" is enforced so that this guarantee still holds for base drafts.</p> <h2 id="options-considered">Options Considered<a class="headerlink" href="#options-considered" title="Permanent link">¶</a></h2> <h3 id="option-a--state-aware-permissive-rls-policy-rls-remains-the-backstop">Option A — State-aware permissive RLS policy (RLS remains the backstop)<a class="headerlink" href="#option-a--state-aware-permissive-rls-policy-rls-remains-the-backstop" title="Permanent link">¶</a></h3> <p>Add a second, PERMISSIVE RLS policy (OR-combined with the tenant-isolation policy) to the content tables, granting <strong>read-only</strong> access to released global-base rows when the session user holds the right. Requires a session variable for the acting user id (e.g. <code>lqms.current_user_id</code>) and a <code>SECURITY DEFINER</code> predicate <code>lqms_may_read_base(user)</code>.</p> <ul> <li><code>document</code> / <code>document_version</code>: <code>USING (s.type = 'GLOBAL' AND state = 'RELEASED' AND lqms_may_read_base(...))</code> (document has no state → join to its current released version, or expose only via version).</li> <li> <p><code>content_part</code>: <code>USING (exists (select 1 from document_version dv where dv.id = version_id and dv.state='RELEASED' and dv.scope_id = <global>) AND lqms_may_read_base(...))</code>.</p> </li> <li> <p><strong>Pros:</strong> RLS stays the true backstop — even a forgetful query cannot read a base <strong>draft</strong>; faithful to ADR-0026; uniform "resolve into the policy" direction the schema already anticipates.</p> </li> <li><strong>Cons:</strong> more complex RLS (a correlated subquery on <code>content_part</code> reads); introduces a <code>current_user_id</code> session var alongside the scope-set var; small per-read cost; the implicit-during- derive case still needs the acting user to be recognised as "may read base" for that transaction.</li> </ul> <h3 id="option-b--resolve-the-global-scope-into-the-authorized-scope-set-rejected">Option B — Resolve the global scope into the authorized scope set (rejected)<a class="headerlink" href="#option-b--resolve-the-global-scope-into-the-authorized-scope-set-rejected" title="Permanent link">¶</a></h3> <p>Treat <code>BASE_READ</code> like <code>VIEW</code>: a resolver adds the global scope id to the authorized set.</p> <ul> <li><strong>Pros:</strong> zero new policy; reuses <code>lqms_authorized_scopes</code> shape exactly.</li> <li><strong>Cons:</strong> <strong>over-exposes</strong> — the authorized set is row-blind, so this leaks base <strong>drafts</strong>, not just released content. Violates REQ-SEP-010. Rejected.</li> </ul> <h3 id="option-c--application-enforced-read-path-global-base-stays-out-of-rls">Option C — Application-enforced read path; global base stays out of RLS<a class="headerlink" href="#option-c--application-enforced-read-path-global-base-stays-out-of-rls" title="Permanent link">¶</a></h3> <p>Keep content-RLS strict (global base never enters any authorized set). Serve both reads through a narrow, audited <code>SECURITY DEFINER</code> path that <em>always</em> filters <code>state = 'RELEASED'</code> and the global scope — e.g. <code>lqms_released_base_*</code> functions for browsing, and the derive operation reads the specific released version through such a function.</p> <ul> <li><strong>Pros:</strong> no RLS change; no new per-row subquery; "released-only" lives in one place; the implicit- during-derive case is natural (the function is the operation).</li> <li><strong>Cons:</strong> for base content, <strong>RLS is no longer the backstop</strong> — a bug in the definer path could expose base drafts. Narrower blast radius than it sounds (one small, audited path, only ever selecting RELEASED), but it is a deliberate, documented exception to ADR-0026 for base reads.</li> </ul> <h2 id="decision">Decision<a class="headerlink" href="#decision" title="Permanent link">¶</a></h2> <p><strong>Option A</strong> for browsing readability (keep RLS as the backstop for base drafts, consistent with ADR-0026), combined with handling the <strong>implicit-during-derive</strong> case through the same <code>lqms_may_read_base</code> predicate also returning true when the acting user holds <code>DERIVE</code> in <em>some</em> target scope for the duration of a derive transaction — or, if that proves to overreach, scoping the implicit read to the single source version inside the derive operation.</p> <p>Rationale: the separation backstop is the project's defining invariant; paying a little RLS complexity to keep "no base-draft leak" enforced by the database (not by careful code) is the trade the rest of the architecture has consistently made. Option C remains the documented fallback if, against expectation, the performance constraints below cannot be met.</p> <p><strong>Copy-on-derive mechanics</strong> (independent of A/C, all already baselined — for confirmation):</p> <ol> <li><strong>Source must be a RELEASED version in a derive-source scope</strong> (<code>scope.may_be_derive_source</code>, today the global base). Validate before any copy (REQ-DOC-010).</li> <li><strong>Authorization:</strong> caller holds <code>DERIVE</code> in the <strong>target</strong> scope (functional permission, ADR-0012) and the target scope <code>may_hold_records</code> / accepts the type (type activated, REQ-CAT-006).</li> <li><strong>Copy is byte-exact and content-addressed:</strong> the released version's <code>content_part</code> rows and their blobs are re-materialized into the target scope as a new <code>document</code> + <code>document_version</code>. <strong>The copy lands in state DRAFT</strong> (resolved at the 2026-07-01 implementation checkpoint): the adopting scope re-reviews and releases it under its own review policy before it becomes effective — conscious adoption with local approver/four-eyes accountability (ISO 13485), and the content may be adapted before local release. Blob store is per-scope partitioned (ADR-0001), so the copy is physically written under the target scope.</li> <li><strong>Identity:</strong> the derived document <strong>retains the source document ID</strong> (REQ-DOC-002/011); uniqueness is per <code>(scope, document_id)</code>, so the same ID legitimately appears in source and target.</li> <li><strong>Provenance:</strong> record a version-level <code>derived-from</code> relationship (ADR-0021, REQ-REL-001/002) bound to the exact source version.</li> <li><strong>Policy fit:</strong> the derive validates that the target scope's applicable review-policy roles are activated/staffed, else prompts to activate/staff or adapt the policy copy — an auditable config change (REQ-CAT-006).</li> <li><strong>Independence after derive:</strong> a later source release does <strong>not</strong> change the copy; affected scopes are <em>notified</em> and adopt consciously (REQ-DOC-012, REQ-NOT-005). Disposal of a derived copy is independent (REQ-DOC-018).</li> </ol> <h2 id="performance-option-a-constraints">Performance (Option A constraints)<a class="headerlink" href="#performance-option-a-constraints" title="Permanent link">¶</a></h2> <p>An RLS policy is an implicit filter folded into every plan; a PERMISSIVE policy is OR-combined with the tenant-isolation policy. The cost is governed by what each predicate does <em>per statement</em> vs. <em>per row</em>. The chosen design must observe these constraints so Option A adds ~zero cost on the hot path (a tenant reading its own scope):</p> <ol> <li><strong>Session-only, <code>stable</code> helpers.</strong> <code>lqms_may_read_base(user)</code> depends only on session state and is marked <code>stable</code>, so it is evaluated <strong>once per statement</strong>, not per row. For every user without base-read it collapses to <code>false</code> and the entire base-read branch is pruned from the plan — a non-base-reader pays nothing.</li> <li><strong>Constant-gate the only expensive predicate.</strong> <code>content_part</code> has no <code>state</code> column, so released-only requires an <code>EXISTS</code> back to <code>document_version</code>. Write it as <code>scope_id = <global> AND lqms_may_read_base(user) AND exists(… dv.state='RELEASED' …)</code> so the two leading per-statement constants gate the subquery: it fires only for <strong>global-scope</strong> content_part rows <strong>and only</strong> for a base-reader. Normal tenant queries (filtered by their own <code>scope_id</code>) never touch it.</li> <li><strong>Inject the global scope id as a GUC</strong> (like <code>lqms.authorized_scope_ids</code>) so the policy compares against a constant rather than sub-selecting "which scope is GLOBAL".</li> <li><strong>Index support.</strong> <code>content_part(version_id)</code> (already an FK) makes each rare <code>EXISTS</code> a PK-index probe; <code>document_version.id</code> is the PK.</li> <li><strong>Watch leakproofness / planner ordering.</strong> RLS treats USING predicates as security barriers; a non-<code>leakproof</code> function can force the RLS filter to run before other filters and occasionally hurt a plan. Because app queries already filter by <code>scope_id</code>, the blast radius is small — but it must be verified with <code>EXPLAIN</code>.</li> </ol> <p><strong>Acceptance:</strong> an <code>EXPLAIN</code>/benchmark pass against the ADR-0018 / REQ-NFR targets, on both the common tenant-read path and the base-read/derive path, before the readability mechanism is called done. If the targets are unexpectedly missed, fall back to Option C for base reads.</p> <h2 id="consequences">Consequences<a class="headerlink" href="#consequences" title="Permanent link">¶</a></h2> <ul> <li><strong>Implementation checkpoint</strong> still decides two sub-questions before/while building: the derived copy's initial lifecycle state (DRAFT-for-re-review vs RELEASED-as-adopted), and whether the implicit-derive read is predicate-based or operation-scoped.</li> <li>Option A requires a new <code>lqms.current_user_id</code> session var set wherever content is read (extend <code>AuthorizedRequestContext</code>/<code>RlsScopeContext</code>) and a GUC for the global scope id, plus <code>lqms_may_read_base</code> and the permissive policies — all under the existing pooled-connection- isolation test discipline (REQ-SEP-011) and the performance constraints above.</li> <li>Either way, copy-on-derive needs: a <code>DeriveService</code>, the <code>derived-from</code> relationship table (if not yet present — to confirm against ADR-0021's status), and notification hooks (REQ-DOC-012), which can follow as their own slices.</li> <li>Copy-on-derive is now unblocked for implementation under this accepted decision.</li> </ul> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> <button type="button" class="md-top md-icon" data-md-component="top" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg> Back to top </button> </main> <footer class="md-footer"> <nav class="md-footer__inner md-grid" aria-label="Footer" > <a href="../adr-0030-review-and-lifecycle-model/" class="md-footer__link md-footer__link--prev" aria-label="Previous: ADR-0030: Review & Life-Cycle Realization Model"> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </div> <div class="md-footer__title"> <span class="md-footer__direction"> Previous </span> <div class="md-ellipsis"> ADR-0030: Review & Life-Cycle Realization Model </div> </div> </a> <a href="../adr-0032-frontend-realization/" class="md-footer__link md-footer__link--next" aria-label="Next: ADR-0032: Frontend realization — Quinoa, Angular Material, i18n & E2E"> <div class="md-footer__title"> <span class="md-footer__direction"> Next </span> <div class="md-ellipsis"> ADR-0032: Frontend realization — Quinoa, Angular Material, i18n & E2E </div> </div> <div class="md-footer__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> <div class="md-copyright__highlight"> Built from <code>v0.9.56-4-g06c7f811</code> (commit <code>06c7f811</code>, 2026-09-09) — the same Markdown the repository ships. </div> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.instant", "navigation.tracking", "navigation.top", "navigation.footer", "navigation.indexes", "toc.follow", "search.suggest", "search.highlight", "content.code.copy", "content.action.edit"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script> </body> </html>