Requirements: Phase 3 — Print Diagnostics
REQ-P3-001: Debug payload return
Section titled “REQ-P3-001: Debug payload return”All print endpoints (labels, breadcrumbs, cards) shall accept a debug query parameter (boolean, default false). When true, the API response shall include the constructed Documint payload(s) — template ID, template configuration, and grid JSON — alongside the normal print result.
The debug payload shall be included regardless of whether the Documint rendering succeeds or fails. On failure, both the error and the payload are returned.
Traces to: SAC::PRINT-DX::FR-0003, SAC::PRINT-DX::FR-0004, SAC::PRINT-DX::FR-0005, #762
REQ-P3-002: Dry-run mode
Section titled “REQ-P3-002: Dry-run mode”All print endpoints shall accept a dry-run query parameter (boolean, default false). When true, the system shall:
- Construct the full Documint payload (template resolution, field mapping, grid layout)
- Not call the Documint API
- Return the payload in the response
- Not update print status or produce any side effects
Traces to: SAC::PRINT-DX::FR-0006, SAC::PRINT-DX::FR-0007, SAC::PRINT-DX::FR-0008, SAC::PRINT-DX::FR-0009, #792
REQ-P3-003: Parameter interaction rules
Section titled “REQ-P3-003: Parameter interaction rules”- When
dry-run=true,live-printhas no effect (no Documint call is made) - When
dry-run=true,debughas no effect (payload is always returned in dry-run mode) debug=trueandlive-print=falsemay be combined (test print + payload in response)
Traces to: SAC::PRINT-DX::FR-0010, SAC::PRINT-DX::FR-0011
REQ-P3-004: Live-print documentation
Section titled “REQ-P3-004: Live-print documentation”The existing live-print parameter shall be documented as a diagnostic capability:
true: Production rendering, counts against Documint quota, no watermarkfalse: Test rendering, no quota impact, watermarked output
Traces to: SAC::PRINT-DX::FR-0001, SAC::PRINT-DX::FR-0002
REQ-P3-005: Design documentation updates
Section titled “REQ-P3-005: Design documentation updates”The following design documents shall be updated:
- PDF Render Module — Document debug and dry-run passthrough in PdfRenderService
- Item Module — Document new query parameters on print endpoints
Copyright: (c) Arda Systems 2025-2026, All rights reserved
Copyright: © Arda Systems 2025-2026, All rights reserved