Search Knowledge Base Articles

Multi-Plant Management — How to Install

← Back to Multi-Plant Management overview

How to Install — Multi-Plant Management

Module folder: modules/multi_plant_management/   Version: v1.0.0

Enterprise multi-plant hierarchy, access control, and inter-plant operations for Perfex CRM

Before you begin

  • Backup your database (Setup → Backup or your host backup tool).
  • Use a staff account with Modules / Settings access.
  • PHP version and Perfex CRM version should match the module README requirements when listed.
  • Keep the module folder name exactly multi_plant_management.

Step-by-step installation

  1. Upload the multi_plant_management folder into your CRM modules/ directory (FTP, cPanel, or Setup → Modules → Upload when available).
  2. Log in to Admin.
  3. Go to Setup → Modules.
  4. Find Multi-Plant Management and click Activate (or Upgrade if already installed).
  5. Wait for migrations/tables to finish — do not refresh mid-activation.
  6. Go to Setup → Staff → Roles and assign permissions for this module.
  7. Open Multi-Plant Management → Settings and save defaults.

Install notes from README

Installation

  1. Upload folder to modules/multi_plant_management/
  2. Go to Setup → Modules
  3. Activate Multi-Plant Management
  4. Assign permissions under Setup → Staff → Roles

No changes to Perfex CRM core files are required. On activation, all tables and options are created (mpm_db_version = 100).

---

Uninstall

Deactivate and uninstall from Setup → Modules. All mpm_* tables and module options are removed completely.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Multi-Plant Management.
  2. Reload admin once if menus do not appear — schema version mpm_db_version is set to 100 for v1.0.0.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the module menu and configure settings (default plant, prefixes, API/webhooks).
  5. Perfex CRM 2.3+ (3.x recommended)
  6. PHP 7.4+ (8.1+ recommended)
  7. MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  8. PHP extensions: mysqli, json, mbstring, curl, fileinfo

Official documentation — Installation

Installation

  1. Upload the multi_plant_management folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Multi-Plant Management.
  3. Reload admin once if menus do not appear — schema version mpm_db_version is set to 100 for v1.0.0.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open the module menu and configure settings (default plant, prefixes, API/webhooks).

No core CRM files are modified. All tables and options are created on activation.

Requirements

  • Perfex CRM 2.3+ (3.x recommended)
  • PHP 7.4+ (8.1+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  • PHP extensions: mysqli, json, mbstring, curl, fileinfo

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
Plant Dashboard
mpm_dashboard		view
Plants
mpm_plants		view, create, edit, delete
Inter-Plant Transfers
mpm_transfers		view, create, edit, approve, receive
Reports
mpm_reports		view, export
Settings
mpm_settings		view, edit
Integrations
mpm_integrations		view
API Keys
mpm_api_keys		view, create, edit, delete
Webhooks
mpm_webhooks		view, create, edit, delete
Bulk Import
mpm_import		view, create

Verify installation (checklist)

  1. Setup → Modules shows Multi-Plant Management as Active.
  2. Admin sidebar shows the Multi-Plant Management menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening Multi-Plant Management → Settings loads without PHP errors.
  5. Creating one sample record succeeds and appears in the list/table.
  6. (If used) Cron-dependent features have Perfex CRM cron enabled on the server.

After install — first actions

  1. Create master data required by this module.
  2. Create one sample record and walk it through approve/complete if applicable.
  3. Train staff using the Quick Start Guide.

Related: Features · Quick Start · FAQ · Version & Changelog

Did you find this article useful?

Related Articles