Module setup, access and architecture

Install and activate the Delivery Note module

Follow this guide to create the module tables and default options through the supported activation flow. 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: AdministratorsPermission: AdministratorModule v1.0.0
Jump to steps
Where to goAdmin Area → Setup → Modules → Delivery Note → Activate

What you’ll accomplish

Create the module tables and default options through the supported activation flow. This guide follows the supplied Delivery Note module’s live hooks, controller actions, model rules, views and stored side effects.

Follow these steps

  1. Upload the complete `delivery_note` module directory to the CRM modules location.
  2. Go to Setup → Modules.
  3. Find Delivery Note version 1.0.0 and select Activate.
  4. Wait for activation to finish, then open Admin Area → Delivery Note.

Fields and options to review

  • Required PHP version: 7.4 or later
  • Module directory: delivery_note
  • Module version: 1.0.0
  • Default enabled option: 1

Rules the system enforces

  • Activation calls the module installer and creates both module-owned tables when absent.
  • The installer adds options without changing core invoice tables, core routes, server configuration, mail configuration or cron.
  • Activation also sets `delivery_note_enabled` to `1`.

How to confirm it worked

  • The Delivery Note menu appears for staff whose role has view access, and the register opens without a schema error.

Safety checks and troubleshooting

  • Do not run copied SQL manually when the supported activation hook can create the portable schema.
Stay within the supported flowDo not force database values, expose secure tokens, bypass permission checks, replace a stored signature or invent a status or interface that the supplied code does not implement.