Setup, version, access and architecture

Verify Letter Manager database readiness

Confirm the history, templates and email-open records required by current features are present. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: Administrators and developersPermission: Authorised database administratorModule v1.0.0
Jump to steps
Where to goServer/database diagnostics → CRM database → Letter Manager tables
Before you start
  • Use an authorised account and confirm the customer, external recipient, template, letter or configuration is the intended one.
  • Follow the exact route shown above and verify the stored record, generated file and delivery evidence instead of relying on an alert alone.

What you’ll accomplish

Confirm the history, templates and email-open records required by current features are present. These instructions follow the inspected module’s live hook, route, controller, model, installer, PDF helper and view flow.

Follow these steps

  1. Verify the prefixed letter_manager_history table exists.
  2. Verify the prefixed letter_manager_templates table exists.
  3. Verify the prefixed letter_manager_email_opens table exists when read tracking is used.
  4. Check the history table contains delivery, signature, verification, enclosure and read-receipt columns.
  5. Return to the UI and test create, verify, sign and email-open flows.

Fields and options to review

History tableLetter content, recipient, reference, public tokens, email, postal, signature, enclosure and audit metadata.
Templates tableInternal template name, subject and HTML content.
Email opens tableOne row per detected tracking-pixel request with letter, token, time, IP, user agent and referer.

Rules the system enforces

  • Do not rename module-owned tables or columns.
  • Runtime guards can add selected missing columns, but production changes must still be controlled and backed by a tested rollback.

How to confirm it worked

  • The requested letter, template, setting, file or tracking detail is created or updated through the supported route.
  • The history row, generated PDF, email/send metadata, public verification, signature evidence, client view or postal display agrees with the action.
  • Any warning, missing file or failed send is investigated rather than bypassed.

Security, privacy and operational checks

  • Apply least privilege and verify recipient identity before sending or exposing public links.
  • Protect PDFs, enclosures, signatures, verification URLs, email-open metadata, IP addresses and customer data under organisational policy.
  • Test configuration and deployment changes with controlled records before production-wide use.
  • Interpret email opens and e-signatures according to their documented technical limitations.