Module: Asset Performance Management v1.4.0
Asset registry, KPI tracking, OEE monitoring, and performance alerts for BIXCRM
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that Asset Performance Management screen:
- APM Dashboard
- Asset Categories
- Assets
- KPI Definitions
- KPI Readings
- Downtime Events
- OEE Calculator
- Maintenance Schedules
- Work Orders
- Maintenance Calendar
- Performance Alerts
- Analytics & Reports
- Integration
- Import KPI Readings
- Settings
How to use in BIXCRM (daily operations)
- Sign in to the admin area with a role that includes Asset Performance Management permissions.
- Open Asset Performance Management (sidebar) or search for Asset Performance Management in the admin menu.
- Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
- Review Settings after upgrades — new options may need defaults for your company.
- Create or import master data first; most modules block transactions until masters exist.
- Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
- Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
- For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
- Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
- If something fails overnight, check BIXCRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the Asset Performance Management section in the admin sidebar. Screens your staff may use (depending on role):
- Analytics & Reports
- API Keys
- APM Dashboard
- Asset Categories
- Asset Performance
- Assets
- Downtime Events
- Import KPI Readings
- Integration
- KPI Definitions
- KPI Readings
- Maintenance Calendar
- Maintenance Schedules
- OEE Calculator
- Performance Alerts
- Settings
- Webhooks
- Work Orders
Detailed guide — features, workflows, API & FAQ
Features
Phase 1 ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| Asset Categories | Master data for grouping assets |
| Asset Registry | Full asset lifecycle with criticality, location, status |
| KPI Definitions | Pre-seeded OEE, Availability, Performance, Quality, MTBF, MTTR |
| KPI Readings | Manual/sensor/import readings with breach detection |
| Performance Alerts | Auto-generated alerts on threshold breaches |
| Dashboard | KPI cards, charts, recent alerts |
Phase 2 ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| Downtime Events | Track planned/unplanned downtime with reason codes |
| OEE Calculator | Calculate Availability × Performance × Quality |
| MTBF/MTTR | Auto-compute reliability metrics from failures |
| Manufacturing Sync | Hook into Manufacturing downtime & IoT readings |
| Asset Links | Link assets to Manufacturing workstations |
| Auto KPI Storage | Store calculated OEE metrics as KPI readings |
Phase 3 ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| Maintenance Schedules | Time/meter-based PM with due dates and priorities |
| Work Orders | Full lifecycle: draft → scheduled → in progress → completed |
| Spare Parts | Link BIXCRM items to work orders |
| Maintenance Calendar | Monthly view of PM and work orders |
| PM Alerts | Auto-alert on overdue or due-soon maintenance |
| Cron Integration | Daily PM alert check |
Phase 4 ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| Analytics Overview | KPI summary, OEE trend chart, top performing assets |
| OEE Trends | 30/60/90-day presets with per-asset line charts |
| Asset Scorecard | Rank assets by composite performance score |
| KPI Comparison | Benchmark readings against targets with variance |
| PDF/CSV Export | Export all analytics reports |
| Multi-Plant Filter | Filter by MPM plants or plant/site field |
Phase 5 ✅
| Feature | Description |
|---|---|
| --------- | ------------- |
| REST API | Read/write assets, KPI readings, alerts, downtime events |
| API Keys | Scoped keys with rate limiting |
| Webhooks | kpi.breach, alert.created, asset.status_changed events |
| IoT Gateway | CSRF-excluded sensor ingestion endpoint |
| CSV Import | Bulk KPI readings upload |
| Cold Chain Link | Shared equipment via asset links |
| MPM Integration | Plant picker syncs to plant_site |
---
Database Tables
| Table | Purpose |
|---|---|
| ------- | --------- |
apm_asset_categories | Asset type master |
apm_assets | Asset registry |
apm_kpi_definitions | KPI templates with thresholds |
apm_kpi_readings | Time-series performance data |
apm_alerts | Performance alerts |
apm_downtime_events | Downtime tracking |
apm_downtime_reason_codes | Downtime reason master |
apm_asset_links | External entity links (workstations) |
apm_activity_logs | Audit trail |
---
Permissions
| Feature ID | Capabilities |
|---|---|
| ------------ | ------------- |
apm_dashboard | view |
apm_asset_categories | view, create, edit, delete |
apm_assets | view, create, edit, delete |
apm_kpi_definitions | view, create, edit, delete |
apm_kpi_readings | view, create, edit, delete |
apm_downtime_events | view, create, edit, delete, end |
apm_oee | view, calculate |
apm_maintenance_schedules | view, create, edit, delete |
apm_work_orders | view, create, edit, delete, complete |
apm_alerts | view, create, edit, delete, resolve |
apm_analytics | view |
apm_integration | view |
apm_api | view, create, delete |
apm_webhooks | view, create, edit, delete |
apm_settings | view, edit |
---
Design Principles
- Zero core changes — All behaviour via
modules/asset_performance_management/+ hooks - Incremental phases — Future features via DB migrations (v101, v102…)
- Optional integrations — Works standalone; enhanced via hooks to Manufacturing, MES, Cold Chain
- Auto-upgrade —
apm_maybe_upgrade_database()runs on admin_init
See [docs/ROADMAP.md](docs/ROADMAP.md) for the full phase plan.
---
Features
Asset registry, KPI tracking, OEE monitoring, and performance alerts for BIXCRM
See README.md in the module folder for the complete feature list.
Permissions
Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Asset Performance Management capability group.
Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).
Cron Jobs
Background tasks (if enabled) run through BIXCRM's main cron. Example crontab (every 5 minutes):
* * * * * php /path/to/bixcrm/index.php cron/index > /dev/null 2>&1
Check module settings for scheduled jobs (alerts, sync, reports, retention).
After activation — configuration checklist
- Go to Setup → Modules and activate Asset Performance Management.
- If prompted, click Upgrade Database or reload admin — migrations run automatically.
- Assign permissions under Setup → Staff → Roles.
- Open the module menu and configure settings.
- BIXCRM 3.0+
- PHP 7.4+ (8.1+ recommended)
- MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
- PHP extensions: mysqli, json, mbstring, curl, fileinfo
One-time setup (first time only)
- Setup → Modules → activate Asset Performance Management.
- Setup → Staff → Roles → assign Asset Performance Management permissions (view, create, edit, delete, approve, export, settings as needed).
- Open Asset Performance Management → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable BIXCRM cron (
php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
BIXCRM Knowledge Base — usage guide generated from module README and documentation.