Search Knowledge Base Articles

Quality Management System — How to Install

← Back to Quality Management System overview

How to Install — Quality Management System

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

ISO-aligned document control, NCR/CAPA, audits, training, and quality KPIs 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 qms.

Step-by-step installation

  1. Upload the qms 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 Quality Management System 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 Quality Management System → Settings and save defaults.

Install notes from README

Installation

  1. Upload the qms folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Quality Management System.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open QMS → Settings and configure prefixes, notifications, and integrations.

No core CRM files are modified. Schema version qms_db_version is set to 100 for v1.0.0.

Uninstall

Deactivate the module, then click Uninstall. This removes:

  • All qms_* database tables
  • All qms_* options / settings
  • QMS email templates
  • Uploaded files under uploads/qms/

Core Perfex CRM files are not modified.

After activation — configuration checklist

  1. Extract the purchased ZIP.
  2. Go to Setup → Modules and activate Quality Management System.
  3. Assign permissions under Setup → Staff → Roles / Permissions.
  4. Open QMS → Settings and configure prefixes, notifications, and integrations.
  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. Extract the purchased ZIP.
  2. Upload the qms folder to modules/ in your Perfex CRM installation.
  3. Go to Setup → Modules and activate Quality Management System.
  4. Assign permissions under Setup → Staff → Roles / Permissions.
  5. Open QMS → Settings and configure prefixes, notifications, and integrations.

No core CRM files are modified. Schema version qms_db_version is set to 100 for v1.0.0.

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
QMS Dashboard
qms_dashboard		view
Document Categories
qms_document_categories		view, create, edit, delete
Documents
qms_documents		view, create, edit, delete, approve
Non-Conformances (NCR)
qms_non_conformances		view, create, edit, delete
CAPA Actions
qms_capa		view, create, edit, delete, verify
Audits
qms_audits		view, create, edit, delete
Audit Checklists
qms_audit_checklists		view, create, edit, delete
Audit Findings
qms_audit_findings		view, create, edit, delete
Training Records
qms_training_records		view, create, edit, delete
Competency Matrix
qms_competency_matrix		view, create, edit, delete
Supplier Quality
qms_supplier_quality		view, create, edit, delete
Integrations
qms_integrations		view
API Keys
qms_api_keys		view, create, edit, delete
Webhooks
qms_webhooks		view, create, edit, delete
Settings
qms_settings		view, edit

Verify installation (checklist)

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