Module: LIMS v1.0.0
What is LIMS?
Lab Information Management System — sample tracking, test methods, and laboratory operations for Perfex CRM
This module installs into modules/lims/ and adds its own admin menus, permissions, and database tables — without editing Perfex CRM core files.
Who should use this module?
- Admins — activate the module, configure Settings, assign roles, and manage integrations.
- Operators / day-to-day staff — create and update records (orders, attendance, shipments, messages, etc.).
- Managers / approvers — review queues, approve workflows, and monitor dashboards/KPIs.
- Finance / compliance / ops leads — run reports, exports, and audit trails when the module supports them.
What you can achieve
- Keep all related work in one place inside Perfex CRM instead of spreadsheets.
- Control who can view, create, edit, approve, or export with role permissions.
- Use dashboards and reports to see status, bottlenecks, and history.
- Connect to other CRM data (customers, invoices, items, staff) where the module integrates.
Recommended learning path
- Read How to Install and activate the module.
- Skim Features so you know what screens exist.
- Complete the Quick Start checklist on this page (Settings → masters → first sample record).
- Open each screen guide under Screen-by-screen guides when you need step-by-step help.
- Check Version & Changelog after upgrades for new options.
Tip: Train one admin first, then create a limited role for operators so they only see the screens they need.
5-minute Quick Start
Follow this short path the first time you use LIMS:
- Activate — Setup → Modules → activate LIMS (run Upgrade if prompted).
- Permissions — Setup → Staff → Roles → enable view/create/edit (and approve/settings if needed) for this module.
- Settings — Open LIMS → Settings and save company defaults, prefixes, and integrations.
- Master data — Create the first required masters (products, warehouses, templates, channels, accounts, routes, etc.).
- First transaction — Create one sample record end-to-end (save → submit/approve → complete) and confirm it appears in lists/reports.
- Cron — If the module uses alerts, sync, queues, or AI, confirm Perfex CRM cron is scheduled on the server.
Module documentation index
Start here — full guides for LIMS:
- Overview & How to Use — what it is, who uses it, daily workflow
- Quick Start Guide — first 5 minutes + printable how-to
- How to Install — upload, activate, permissions, verify
- Features (Full Detail) — every capability explained
- FAQ & Tips — common questions and best practices
- Version & Changelog — version history
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that LIMS screen:
- Lab Dashboard
- Laboratories
- Test Categories
- Test Methods
- Sample Types
- Samples
- Work Queue
- QC Review Queue
- Reports & COA
- Integrations
- Settings
How to use in Perfex CRM (daily operations)
- Sign in to the admin area with a role that includes LIMS permissions.
- Open Lims (sidebar) or search for LIMS 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 Perfex CRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the LIMS section in the admin sidebar. Screens your staff may use (depending on role):
- API Keys
- Bulk Import
- Integrations
- Lab Dashboard
- Laboratories
- Lab Samples
- QC Approval
- QC Review Queue
- Reports & COA
- Samples
- Sample Types
- Settings
- Test Categories
- Test Methods
- Test Results
- Webhooks
- Work Queue
Screens map — what each menu is for
These are the admin screens registered by LIMS. Click a name in the Knowledge Base for a full how-to, or open the path in admin.
| # | Screen | Admin path | Guide |
|---|---|---|---|
| 1 | Lab Dashboard | admin/lims | How to use |
| 2 | Laboratories | admin/lims/lims_labs | How to use |
| 3 | Test Categories | admin/lims/lims_test_categories | How to use |
| 4 | Test Methods | admin/lims/lims_test_methods | How to use |
| 5 | Sample Types | admin/lims/lims_sample_types | How to use |
| 6 | Samples | admin/lims/lims_samples | How to use |
| 7 | Work Queue | admin/lims/lims_work_queue | How to use |
| 8 | QC Review Queue | admin/lims/lims_results/qc_queue | How to use |
| 9 | Reports & COA | admin/lims/lims_reports | How to use |
| 10 | Integrations | admin/lims/lims_integrations | How to use |
| 11 | Settings | admin/lims/lims_settings | How to use |
Detailed guide — features, workflows, API & FAQ
Features
| Area | Description |
|---|---|
| ------ | ------------- |
| Labs & methods | Multi-lab context, categories, methods, sample types |
| Samples | Registration, events, priorities, plant/client links |
| Results & QC | Work queue, result entry, QC approve/reject |
| Reports | Test reports, COA PDF, labels |
| Portal | Client-visible completed samples (optional) |
| Integrations | REST API, webhooks, bulk import, invoice linking |
How To Use
1. First-time setup
- Open LIMS → Settings.
- Set default laboratory, lab/sample code prefixes, portal options, and integration toggles.
- Save settings.
2. Create master data
- Laboratories — create at least one lab and optionally set it as default.
- Test Categories — group your test methods.
- Sample Types — define sample types and retention/storage info.
- Test Methods — add methods with unit, limits, turnaround days, and price.
3. Register and process samples
- Go to Samples → New Sample.
- Select lab, sample type, client (optional), priority, and notes.
- Assign one or more test methods.
- Use sample events for chain-of-custody notes (received, stored, transferred, etc.).
4. Work queue & QC
- Open Work Queue and enter results for assigned tests.
- Open QC Review Queue and approve or reject results.
- Approved results can trigger staff email notifications (if enabled).
5. Reports & portal
- Generate Test Report or Certificate of Analysis (COA) PDFs from Reports / sample view.
- Print sample labels when needed.
- Enable client portal visibility for completed samples if required.
6. Integrations (optional)
- Open Integrations.
- Create API keys for REST access.
- Configure webhooks for outbound events.
- Use bulk import tools and invoice linking when enabled.
Features
- Multi-laboratory management with active lab context
- Test categories, sample types, and test methods
- Sample registration, priorities, and chain-of-custody events
- Work queue and result entry
- QC approve/reject workflow
- PDF test reports, COA, and sample labels
- Optional client portal visibility
- REST API, webhooks, invoice linking, bulk import
- Dashboard widget and activity logs
- Granular staff permissions
- Clean uninstall of all module data
Permissions
Assign under Setup → Staff → Roles / Permissions.
| Capability | Purpose |
|---|---|
| lims_dashboard | View LIMS dashboard |
| lims_labs | Manage laboratories |
| lims_test_categories | Manage test categories |
| lims_test_methods | Manage test methods |
| lims_sample_types | Manage sample types |
| lims_samples | Manage samples |
| lims_results | Work queue / result entry |
| lims_qc_approve | QC review approve/reject |
| lims_reports | Reports and PDFs |
| lims_integrations / api_keys / webhooks / import | Integrations tools |
| lims_settings | Module settings |
Uninstall
- Deactivate LIMS in Setup → Modules.
- Click Uninstall.
This removes all LIMS database tables, module options, and the result-approved email template. Core Perfex CRM files are never modified.
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
After activation — configuration checklist
- Extract the purchased package.
- Go to Setup → Modules and activate LIMS.
- Assign permissions under Setup → Staff → Roles / Permissions.
- Open LIMS → Settings and configure defaults.
One-time setup (first time only)
- Setup → Modules → activate LIMS.
- Setup → Staff → Roles → assign LIMS permissions (view, create, edit, delete, approve, export, settings as needed).
- Open LIMS → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable Perfex CRM cron (
php /path/to/perfex/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
Tips for success
- Always configure Settings before creating live transactions.
- Create master data (items, warehouses, templates, channels, accounts) first — most modules block incomplete records.
- Use a test/sample record before going live with real customers or production stock.
- Separate roles: operators create/edit; managers approve; finance/reporting get view/export only.
- After any module upgrade, reopen Settings and confirm new options have sensible defaults.
- If overnight jobs fail, verify Perfex CRM cron and check the module log / failed queue screen.
Common questions (FAQ)
Where do I find the module after activation?
In the admin sidebar look for LIMS. If missing, your role may lack view permission — fix under Setup → Staff → Roles.
Do I need to edit core Perfex CRM files?
No. Keep all custom code under modules/lims/. Activate/deactivate from Setup → Modules.
What happens if I uninstall?
Deactivate keeps data. Uninstall usually removes module tables/options (see the Install article). Core customers, invoices, and items are not deleted by well-built modules.
Why can't my staff see a screen?
Almost always a permissions issue. Give the role at least view on that feature, then ask the user to log out and back in.
Reports/export buttons do nothing
Confirm the role has export (or view reports) permission, and that filters return at least one row. Try PDF/CSV from a wider date range.
FAQ from module documentation
Support
See documentation/index.html for the buyer guide.
Perfex CRM Knowledge Base — detailed usage guide generated from module README, HOW_TO_USE, and documentation.