Admin Reference
Document Templates Route Reference
Understand template editing, version lifecycle, branding, preview, and render history for document outputs.
Before you start
- Template administration is enabled and you are adjusting how customer-facing outputs render.
Expected outcome
You can manage template lifecycle without confusing source-record data fixes with template fixes.
What this route is for
Document Templates is the structured React-PDF administration desk for PDF-backed outputs such as reports, certificates, and quotes.
Visibility and capability notes
| Item | Details |
|---|---|
| Route id | pdf-templates |
| Visible nav label | Document Templates |
| Visibility | Customer-facing only when template administration capability is enabled. |
| Capability notes | This is a specialist workspace and is intentionally separate from the operational desks that produce the underlying data. |
| Direct inbound | Reports, Quotes, Inspections, and direct shell navigation when enabled. |
Main regions, tabs, and dialogs
| Surface | What it does |
|---|---|
| Workspace tabs | templates, template, versions, lifecycle, branding, render_history |
| Template controls | Structured React-PDF settings for headings, section order, visibility, and protected server-owned sections. |
| Template dialogs | Create template, import package, and confirm or destructive flows. |
| Scope controls | Switch between organization and global scope where permitted. |
Key actions
- Refresh the workspace.
- Create or import a template.
- Duplicate, archive, restore, delete, or export a template.
- Create a draft version.
- Save structured template changes.
- Save branding changes.
- Open rendered proof output.
- Review render history.
Filters and URL state
| Param | What it controls |
|---|---|
documentType | Current output type |
previewMode | Preview behaviour |
previewSubject | Current preview subject |
scope | Organization or broader scope |
templateId | Selected template |
versionId | Selected version |
- The route keeps URL state for reopening a specific template or version directly.
- Published versions become read-only even while still visible in the workspace.
Outputs and side effects
- Changes template lifecycle and branding used later in reports, certificates, and quotes.
- Stores draft or published template versions.
- Exported template packages can be moved between environments or retained for backup.
Troubleshooting
| Symptom | What to check |
|---|---|
| A published version cannot be edited | Published versions are intentionally read-only. Create or open a draft path instead. |
| The PDF looks wrong in Reports or Quotes | Confirm whether the issue is data or template structure before editing the template. |
| A direct link opens a different view than expected | Re-check templateId, versionId, and preview-related params. Retired editor route params are normalized back to the workspace. |
| Branding changes do not appear where expected | Confirm the template scope and the selected branding workspace state. |
Report Writer Route Reference
Understand the review queue for generated report drafts, blocked items, preview state, and the separation between export generation and review.
AI Assistant Route Reference
Understand the route-aware office copilot, conversation context, and how assistant launches preserve the current admin desk state.