Search Knowledge Base Articles

Asset Performance Management — How to Install

← Back to Asset Performance Management overview

How to Install — Asset Performance Management

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

Asset registry, KPI tracking, OEE monitoring, and performance alerts 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 asset_performance_management.

Step-by-step installation

  1. Upload the asset_performance_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 Asset Performance 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 Asset Performance Management → Settings and save defaults.

Install notes from README

Installation

  1. Module files are in modules/asset_performance_management/
  2. Go to Setup → Modules
  3. Find Asset Performance Management and click Activate
  4. Assign permissions at Setup → Staff → Permissions
  5. Access via sidebar menu Asset Performance Management

Uninstall

  1. Deactivate the module under Setup → Modules
  2. Click Uninstall — all apm_* tables and module options are removed automatically
  3. No Perfex CRM core files are modified

---

Uninstall

Deactivate and uninstall from Setup → Modules. All APM tables and options are removed automatically.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Asset Performance Management.
  2. Tables, seed data (categories, KPIs, downtime reasons), and options are created automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open Asset Performance → Settings and configure prefixes, targets, and integrations.
  5. Perfex CRM 2.3+ (3.0+ 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 asset_performance_management folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Asset Performance Management.
  3. Tables, seed data (categories, KPIs, downtime reasons), and options are created automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open Asset Performance → Settings and configure prefixes, targets, and integrations.

No core CRM files are modified.

Requirements

  • Perfex CRM 2.3+ (3.0+ 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
APM Dashboard
apm_dashboard		view
Asset Categories
apm_asset_categories		view, create, edit, delete
Assets
apm_assets		view, create, edit, delete
KPI Definitions
apm_kpi_definitions		view, create, edit, delete
KPI Readings
apm_kpi_readings		view, create, edit, delete
Performance Alerts
apm_alerts		view, create, edit, delete, resolve
Downtime Events
apm_downtime_events		view, create, edit, delete, end
OEE Calculator
apm_oee		view, calculate
Maintenance Schedules
apm_maintenance_schedules		view, create, edit, delete
Work Orders
apm_work_orders		view, create, edit, delete, complete
Analytics & Reports
apm_analytics		view
Integration
apm_integration		view
API Keys
apm_api		view, create, delete
Webhooks
apm_webhooks		view, create, edit, delete
Settings
apm_settings		view, edit

Verify installation (checklist)

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