Search Knowledge Base Articles

HRM Pro — Overview & module guide

Module: HRM Pro v3.6.1

Ultimate Enterprise HRM module for BIXCRM.

How to use in BIXCRM (daily operations)

  1. Sign in to the admin area with a role that includes HRM Pro permissions.
  2. Open Hrm Pro (sidebar) or search for HRM Pro in the admin menu.
  3. Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
  4. Review Settings after upgrades — new options may need defaults for your company.
  5. Create or import master data first; most modules block transactions until masters exist.
  6. Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
  7. Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
  8. For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
  9. Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
  10. 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 HRM Pro section in the admin sidebar. Screens your staff may use (depending on role):

  • Announcements
  • Asset management
  • Attendance
  • Biometric
  • Biometric logs
  • Contracts
  • Dashboard
  • Departments
  • Designations
  • Holidays
  • HR analytics
  • HRM
  • Job Cards
  • KPI system
  • Leaves
  • Loans
  • My HR Panel
  • Offices
  • Payroll
  • Payslips
  • Performance appraisal
  • Recruitment
  • Reports
  • Salary structure templates
  • Settings
  • Shift rota
  • Shifts
  • Staff
  • Staff timeline
  • Training

Detailed guide — features, workflows, API & FAQ

v3.6.1 — Security & CodeCanyon Readiness

  • Careers portal honeypot + IP rate limiting (spam protection)
  • Biometric push API: mandatory API key + rate limiting (120/min per IP)
  • Upload directories secured with index.html (no directory listing)
  • Reports permission fix (view_staff capability)
  • Complete uninstall cleanup (all module options)
  • LICENSE.txt, documentation, CHANGELOG for marketplace submission

Features

Core HR

  • Staff profiles linked to BIXCRM staff (departments, designations, shifts, offices)
  • Attendance (manual, self-service portal, biometric sync, GPS/IP rules)
  • Leave management with balances and calendar
  • Payroll generation, payslips (PDF/email)
  • Loans, job cards, contracts, assets, KPI & appraisal

v2.1 Polish

  • HR Analytics wired to live KPIs and Chart.js trends
  • Recruitment Kanban drag-and-drop stage persistence
  • Complete uninstall (tables + all module options)
  • Legacy controller redirects (Hrm_pro, Staff → primary routes)

v2.2 Features

  • CSV import — staff HRM profiles and attendance rows
  • Leave approval comments saved on approve/reject
  • HR Reports PDF download (attendance, payroll, loans, staff, summary)

v2.3 Enterprise

  • Multi-level leave approvals — 1–3 step chain (manager → HR → final approver)
  • Training module — programs, sessions, staff enrollments
  • Public careers portal — job listings and online applications at /careers

v2.4 Integration & Polish

  • Custom timeline events — save promotion, warning, and other HR events with attachments
  • Salary template description — persisted in database
  • Rota notes — saved per shift assignment
  • Recruitment resume upload — file upload in admin (plus optional URL)
  • Email alerts — next leave approver + contract expiry (employee + HR contact)

v2.5 Self-Service & Import

  • Leave attachments — optional file upload when applying (staff portal + admin leaves)
  • Holidays CSV import — bulk import with type, apply-to, and date range metadata
  • Offices CSV import — bulk import geofence offices
  • Staff portal training — employees view their training enrollments and scores

v2.6 Bulk Operations & Import

  • Salary template CSV import — bulk create/update salary structures
  • Leave bulk approve/reject — process multiple pending requests via AJAX
  • Contracts bulk upload — ZIP with manifest.csv + contract files

v2.7 Reports & Operations

  • Reports charts — live attendance trend (present/absent/late) and payroll bar chart
  • Reports tab export — per-tab PDF download buttons wired to the reports PDF endpoint
  • Reports DataTables — sortable/searchable tables on each report tab
  • Attendance delete — single-row and bulk delete for attendance records
  • Leave iCal export — download .ics calendar feed for all leave requests

v3.6 Staff Portal Appraisals & Filtered KPI Exports

  • Staff portal → My Appraisal — employees view published performance reviews only
  • Portal dashboard — latest published appraisal rating card
  • KPI PDF & rollup CSV — respect staff, department, year, and month filters from the KPI page

v3.5 Appraisal ↔ KPI & KPI PDF

  • Performance appraisal — stores linked kpi_rollup_score; live lookup by staff/period; optional “Apply as rating (÷10)”
  • Appraisal table — KPI score column alongside manager rating
  • KPI PDF — download rollups and score rows from KPI → Download PDF

v3.4 Staff Portal KPI & Rollup Export

  • Staff portal → My KPIs — employees view their scores, monthly rollups, and year filter
  • Portal dashboard — current-month KPI average card with link to full view
  • Admin KPI — Export rollups CSV downloads staff/period weighted averages

v3.3 Cleanup & Weighted KPI Rollups

  • Weighted KPI average — dashboard stat, staff/month rollup table, and HR Analytics card respect definition weights
  • Code cleanup — removed nested Stripe iDEAL module (ideal/) and unused legacy view wrappers

v3.2 KPI Scope, Biometric Notes & Scheduled Reports

  • KPI definitions — weight (%), optional department/designation scope; assignment dropdown filters by staff scope
  • Biometric devices — notes field saved on create/edit (modal + standalone form)
  • Scheduled reports — cron email summary to configured recipients (weekly Monday or monthly 1st); configure in Reports modal or Settings

v3.1 Extended Metadata & Returns

  • Contracts — type, start date, status, department, designation, salary, notes (create, edit, filter, bulk CSV)
  • Loans — interest_rate and tenure_months stored in database (legacy [HRM_INT:] notes still read)
  • Assets — return assignment from recent assignments list (sets asset back to available)
  • UI polish — corrected stale hints for payroll filters, CSV imports, salary template description

v3.0 Enterprise Operations

  • Assets — purchase date/cost, vendor, warranty, location, condition columns + form fields
  • Payroll generate — optional department, office, and staff filters (adds missing items to existing month runs)
  • Recruitment jobs — close/reopen posting, delete job (cascades applications)

v2.9 Recruitment, Contracts & Timeline

  • Recruitment — reject, delete application, move stage modal (table + kanban already supported drag)
  • Contracts — edit title, expiry, optional document replace
  • Timeline — delete custom timeline events

v2.8 Delete & Bulk Operations

  • Loans — reject, delete, bulk approve/reject/delete via AJAX
  • Assets — delete asset (cascades assignments)
  • KPI — delete monthly scores and KPI definitions
  • Payroll — bulk mark paid, lock, delete; single lock/delete
  • Payslips — bulk delete, single delete, regenerate

Setup

  1. Setup → Modules → HRM Pro → Activate
  2. Run Upgrade when prompted (migrations apply schema changes)
  3. Assign HRM permissions under Setup → Staff → Roles
  4. Configure HRM Pro → Settings (attendance rules, payroll, leave approval, careers portal, cron jobs)

Leave approval workflow

Configure under HRM Pro → Settings → Leave approval settings:

LevelsChain
---------------
1HR / attendance managers approve directly
2Reporting manager → HR approver
3Reporting manager → HR approver → Final approver

Set HR and final approver staff in settings. Multi-step requests show the approval chain on the leaves list and in the detail modal.

Training

HRM Pro → Training — create programs, schedule sessions, enroll staff, mark completions. Requires training_manage permission.

Staff with portal access can view their enrollments under Staff Portal → My training.

Careers portal

  1. Enable in HRM Pro → Settings → Careers portal
  2. Post jobs with List on public careers portal checked (Recruitment)
  3. Public URL: https://your-site/careers

Applications from the portal appear in Recruitment with source Careers portal.

CSV Import

Staff (`HRM Pro → Staff → Import`)

Required columns: staff_email (or staff_id), department, designation, employment_type, joining_date

Attendance (`HRM Pro → Attendance → Import attendance from CSV`)

Required: staff_email (or staff_id), attendance_date

Holidays (`HRM Pro → Holidays → Import`)

Required: title, holiday_date (or start_date). Optional: end_date, description, status, type, apply_to, department_id, office_id

Offices (`HRM Pro → Offices → Import`)

Required: office_name. Optional: latitude, longitude, radius, status

Salary templates (`HRM Pro → Salary templates → Import`)

Required: name. Optional: basic_salary, allowances, bonus, commission_pct, other_deductions, description, status

Contracts bulk upload

  1. Create a ZIP containing manifest.csv and contract files
  2. Manifest columns: staff_email, title, expiry_date, file
  3. Upload via HRM Pro → Contracts → Bulk Upload

Download the manifest sample from the bulk upload modal.

Reports PDF

HRM Pro → Reports — apply filters, open a tab, click Download PDF. Use Schedule Report to enable cron email delivery.

Migrations

VersionFileNotes
----------------------
2.0.0200_version_200.phpUltimate enterprise schema
2.2.0220_version_220.phpLeave approval_comment column
2.3.0230_version_230.phpMulti-level approvals, training, careers portal
2.4.0231_version_231.phpTimeline events, rota notes, email alerts
2.5.0232_version_232.phpLeave attachment column
2.6.0233_version_233.phpFeature release (no schema changes)
2.7.0234_version_234.phpReports charts, attendance delete, leave iCal
2.8.0235_version_235.phpLoan/payroll bulk delete, asset & KPI delete, payslip regen
2.9.0236_version_236.phpRecruitment actions, contract edit, timeline delete
3.0.0300_version_300.phpAsset tracking columns, scoped payroll, job management
3.1.0310_version_310.phpContract extended fields, loan interest/tenure, asset return
3.2.0320_version_320.phpKPI weight/scope, biometric notes, scheduled report email
3.3.0330_version_330.phpWeighted KPI rollups; code cleanup (no schema changes)
3.4.0340_version_340.phpStaff portal KPI view, rollup CSV export
3.5.0350_version_350.phpAppraisal KPI rollup column, KPI PDF export
3.6.0360_version_360.phpStaff portal appraisals, filtered KPI exports

BIXCRM maps module version to migration number by removing dots (3.6.0 → 360). Migration files must increase by 1 with no gaps between your installed migration and the target (e.g. 350 → 360 runs 351…360). Bridge files 351–359 are empty steps; 360 has no schema changes.

Upgrade path from 3.5.x installed migration 350: run Upgrade once (applies 351 through 360).

Permissions

CapabilityPurpose
---------------------
view_staffDashboard, analytics, staff list
create_staff / edit_staff / delete_staffStaff CRUD, CSV import
attendance_manageAttendance, leaves, CSV import; HR override on leave approvals
payroll_managePayroll & payslips
loan_manageLoans
recruitment_manageJobs & pipeline
training_manageTraining programs & sessions
staff_self_accessEmployee portal

Cron (optional)

Configure in HRM Pro → Settings. Jobs run after the main CRM cron: biometric sync, auto payroll, leave balance reset, contract expiry alerts, scheduled HR report email.

Permissions

CapabilityAccess
view_staffDashboard, staff list, reports, analytics, KPI, assets, contracts, timeline
create_staffAdd staff HRM profiles, CSV import
edit_staffEdit profiles, KPI scores, assets, contracts
delete_staffDelete staff records, appraisals
attendance_manageAttendance, leaves, biometric, settings (partial)
payroll_managePayroll, payslips, settings (partial)
loan_manageEmployee loans
recruitment_manageJobs, applications, pipeline
training_manageTraining programs and sessions
staff_self_accessEmployee self-service portal (My Panel)

Key Features

  • Staff profiles, departments, designations, shifts, offices, holidays
  • Attendance (manual, portal, biometric, GPS/IP geofence)
  • Leave management with multi-level approvals
  • Payroll generation and payslip PDF/email
  • Loans, job cards, assets, contracts
  • Recruitment Kanban + public careers portal
  • Training programs and enrollments
  • KPI system with weighted rollups + performance appraisal
  • HR Analytics, reports (PDF + scheduled email)
  • Employment card with QR verification

Cron Jobs

Configure in HRM Pro → Settings. All run via BIXCRM's main cron:

  • Biometric sync — reconcile device logs to attendance
  • Auto payroll — generate previous month's payroll
  • Leave balance reset — annual leave balance reset
  • Contract alerts — email on contract expiry
  • Scheduled reports — weekly/monthly HR summary email

Careers Portal

Enable in Settings → Careers portal enabled. Public URLs:

https://yourdomain.com/careers
https://yourdomain.com/careers/job/{id}
https://yourdomain.com/careers/apply/{id}

Job postings must be open and marked public listing in Recruitment.

Biometric Push API

Register devices under HRM Pro → Biometric. Each device receives an API key.

POST /admin/hrm_pro/biometric/push
Content-Type: application/json
X-API-Key: {device_api_key}

{
  "employee_id": 1,
  "timestamp": "2026-09-03 09:00:00",
  "device_id": "DEVICE-001"
}

Rate limited to 120 requests/minute per IP. API key is mandatory.

CSV Imports

Supported imports (see README.md for column formats):

  • Staff HRM profiles
  • Attendance rows
  • Holidays, offices, salary templates
  • Contracts bulk upload (ZIP + manifest.csv)

Security Notes

  • All admin routes require staff login + RBAC permissions
  • CSRF tokens on admin forms; public careers apply is CSRF-excluded (honeypot + rate limit instead)
  • Biometric push uses API key + rate limiting (no staff session)
  • Employment card verification uses signed token (hash_equals)
  • Upload directories include blank index.html files
  • File uploads restricted by MIME/extension and size

After activation — configuration checklist

  1. Go to Setup → Modules and activate HRM Pro.
  2. Assign permissions under Setup → Staff → Roles (HRM Pro capability group).
  3. Open HRM Pro → Settings to configure attendance, payroll, and cron options.
  4. Ensure your server cron runs BIXCRM's cron URL daily (required for biometric sync, scheduled reports).

One-time setup (first time only)

  1. Setup → Modules → activate HRM Pro.
  2. Setup → Staff → Roles → assign HRM Pro permissions (view, create, edit, delete, approve, export, settings as needed).
  3. Open HRM Pro → Settings and complete company defaults, prefixes, integrations, and notification options.
  4. Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
  5. Enable BIXCRM cron (php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs.
  6. Optionally enable REST API / webhooks in module settings if you integrate external systems.

BIXCRM Knowledge Base — usage guide generated from module README and documentation.

Did you find this article useful?