Run the Letter Manager schema-version upgrade
Allow the module to bring an older Letter Manager database to schema version 1.0.0.
Exact navigationAdmin Area → any admin page after Letter Manager is active
Before you begin
- 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 this guide covers
Allow the module to bring an older Letter Manager database to schema version 1.0.0. These instructions follow the inspected module’s live hook, route, controller, model, installer, PDF helper and view flow.
Exact step-by-step process
- Confirm the module files are the intended v1.0.0 release.
- Sign in to the admin area.
- Load an admin page so the admin_init migration guard runs.
- Open Letter Manager → Dashboard and perform a controlled create/send test.
- Verify get_option(letter_manager_schema_version) is 1.0.0 only through authorised diagnostics.
Fields, choices and supported possibilities
Action scopeAllow the module to bring an older Letter Manager database to schema version 1.0.0.
Module version1.0.0
Exact routeAdmin Area → any admin page after Letter Manager is active
EvidenceVerify the history row, PDF, email metadata, open evidence, signature, public page, client view or postal fields produced by this flow.
Code-backed validations and workflow rules
- The module compares letter_manager_schema_version with 1.0.0 on admin_init.
- When different, it includes install.php and then updates the option.
- Installer ALTER statements are guarded by field_exists or table_exists where implemented.
Expected result and verification
- 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.
