Search Knowledge Base Articles

Inventory Management — How to Install

← Back to Inventory Management overview

How to Install — Inventory Management

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

Enterprise inventory management module 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 inventory_management.

Step-by-step installation

  1. Upload the inventory_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 Inventory 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 Inventory Management → Settings and save defaults.

Install notes from README

Requirements

RequirementNotes
--------------------
Perfex CRM2.3.x or later
PHP7.4+ (8.x supported)
MySQL / MariaDBInnoDB
Perfex cronRequired for scheduled alerts
Purchase ManagementOptional — for GRN sync

---

Installation

  1. Copy the module folder to modules/inventory_management/
  2. Go to Setup → Modules → Inventory Management → Activate
  3. Database tables and default settings are created automatically on activation
  4. Assign permissions under Setup → Staff → Roles
  5. Configure Inventory Management → Settings
  6. Ensure the Perfex CRM cron job is running (Setup → Settings → Cron Job)

Uninstall

Deactivate the module, then Uninstall from Setup → Modules. All inventory_* database tables and module options are removed automatically.

Upgrades (after 1.0.0)

Future releases add numbered files under migrations/ (e.g. 101_version_101.php for module version 1.0.1). Run Upgrade database from Setup → Modules when prompted, or rely on inventory_management_maybe_upgrade_database() on admin load.

---

Uninstall

Deactivating leaves data intact. Uninstalling (Setup → Modules) runs uninstall.php which:

  • Drops all 15 inventory tables
  • Removes all module options including cron settings

This is destructive. Back up the database before uninstalling.

---

Requirements

ItemVersion
---------------
Perfex CRM2.3.x+
PHP7.4+ (8.x supported)
MySQL / MariaDBInnoDB
Perfex cronRequired for scheduled alerts

Optional: Purchase Management module for GRN sync.

---

Installation

  1. Upload inventory_management folder to modules/
  2. Setup → Modules → Inventory Management → Activate
  3. Assign permissions under Setup → Staff → Roles
  4. Configure Inventory Management → Settings
  5. Enable Perfex CRM cron job

Uninstall: Deactivate, then Uninstall from Setup → Modules — all inventory_* tables and options are removed.

---

Uninstall

Uninstalling drops all 15 inventory tables and module options. Back up first.

---

Requirements

ItemVersion
---------------
Perfex CRM2.3.x+
PHP7.4+ (8.x supported)
MySQL / MariaDBInnoDB
Perfex cronRequired for scheduled alerts

Optional: Purchase Management module for GRN sync.

---

Installation

  1. Upload inventory_management folder to modules/
  2. Setup → Modules → Inventory Management → Activate
  3. Assign permissions under Setup → Staff → Roles
  4. Configure Inventory Management → Settings
  5. Enable Perfex CRM cron job

Uninstall: Deactivate, then Uninstall from Setup → Modules — all inventory_* tables and options are removed.

---

Uninstall

Uninstalling drops all 15 inventory tables and module options. Back up first.

---

After activation — configuration checklist

  1. Go to Setup → Modules and activate Inventory Management.
  2. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the module menu and configure settings.
  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 inventory_management folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Inventory Management.
  3. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open the module menu and configure settings.

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
Inventory
inventory_management		view
Dashboard
inventory_dashboard		view
Warehouses
inventory_warehouse		view, create, edit, delete
Stock
inventory_stock		view, create, edit, adjust
Stock Transfers
inventory_transfer		view, create, approve, receive
Stock Adjustments
inventory_adjustment		view, create, approve
Reports
inventory_reports		view, export
Settings
inventory_settings		view, edit

Verify installation (checklist)

  1. Setup → Modules shows Inventory Management as Active.
  2. Admin sidebar shows the Inventory Management menu for an admin user.
  3. Setup → Staff → Roles lists this module's permission groups.
  4. Opening Inventory 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