Skip to main content

Introduction

Welcome to the Human Resources Management (HRM) module documentation for Perfex CRM. This guide will help you install, configure, and use all features of the module.

What is the HRM Module?โ€‹

The HRM module is a complete Human Resources solution that integrates directly into your Perfex CRM admin area. It allows you to:

  • Manage staff with extended profiles, contracts, and documents
  • Handle contracts with types, templates, and validity tracking
  • Track insurance and benefits per employee
  • Manage shifts and timekeeping
  • Process payroll and generate payslips
  • Onboard new hires with customizable checklists (per-item checkable!)
  • Track performance with reviews and goals (OKRs/KPIs)
  • Manage learning paths and course enrollments
  • Engage employees with surveys and 1:1 meeting notes
  • Store HR documents in a central library
  • Support staff via the HR Helpdesk (with status updates)
  • Assign assets (laptops, equipment) to staff
  • Generate reports with built-in and custom report builder

Requirementsโ€‹

  • Perfex CRM 2.3.x or higher
  • PHP 7.4 or higher
  • Admin privileges to access all HRM features

Quick Startโ€‹

  1. Install the module via Perfex CRM โ†’ Setup โ†’ Modules
  2. Activate the module (requires valid license)
  3. Configure Settings โ†’ HRM โ†’ Setting for contract types, allowances, job positions, etc.
  4. Add staff or use existing Perfex staff members
  5. Start using the HRM menu items in the sidebar

Installation Stepsโ€‹

  1. Download the module package from Codecanyon (ZIP file)
  2. Extract the ZIP file
  3. Upload the hrm folder (or human-resources-management-module-for-perfex-cr) to your Perfex installation: 
    /application/modules/hrm/
warning

The folder must be named hrm when placed in the modules directory for Perfex to recognize it.

  1. Go to Perfex Admin โ†’ Setup โ†’ Modules
  2. Find "Human Resources Management" in the list
  3. Click the Activate button

Activation & Licenseโ€‹

The HRM module requires a valid purchase code from Codecanyon to activate. During activation:

  • Enter your purchase code (Envato license)
  • The module will validate the license with the author's servers
  • Upon success, the module activates and all features become available
tip

If activation fails, ensure your purchase code is correct and you have an active support period. Contact Themesic support for assistance.

Module Structureโ€‹

After installation, the module creates:

PathPurpose
modules/hrm/Main module files
modules/hrm/uploads/Uploaded files (documents, attachments)
modules/hrm/migrations/Database migration files for upgrades

Upgrading from a Previous Versionโ€‹

  1. Backup your database and modules/hrm/ folder
  2. Deactivate the module (optional but recommended)
  3. Replace the module files with the new version
  4. Reactivate the module
  5. When prompted, click "Upgrade Database" to run migrations
  6. Migrations will add any new tables or columns required for the new version
tip

The module uses Perfex migrations. Each version change creates a migration file. When you upgrade, Perfex detects the version change and prompts you to upgrade the database.

Uninstallationโ€‹

To remove the module:

  1. Go to Setup โ†’ Modules
  2. Deactivate the HRM module
  3. Delete the modules/hrm/ folder from your server
warning

Uninstalling will not remove database tables. Tables created by the module (e.g. tblhrm_*, tblstaff_contract, etc.) will remain. Manual database cleanup may be required if you want to remove all traces.