Search Knowledge Base Articles

LIMS — How to Install

← Back to LIMS overview

How to Install — LIMS

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

Lab Information Management System — sample tracking, test methods, and laboratory operations 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 lims.

Step-by-step installation

  1. Upload the lims 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 LIMS 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 LIMS → Settings and save defaults.

Install notes from README

Installation

  1. Upload the lims folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules, find LIMS, and click Activate.
  3. Assign staff permissions under Setup → Staff → Permissions.
  4. Open LIMS → Settings to set defaults (lab, prefixes, integrations).

Database schema is created on activation. The internal schema version is stored in lims_db_version (100 for v1.0.0).

Uninstall

  1. Deactivate the module in Setup → Modules.
  2. Click Uninstall.

Uninstall drops all tblims_* tables, removes module options, and deletes the LIMS email template. Core Perfex files are never modified.

After activation — configuration checklist

  1. Extract the purchased package.
  2. Go to Setup → Modules and activate LIMS.
  3. Assign permissions under Setup → Staff → Roles / Permissions.
  4. Open LIMS → Settings and configure defaults.

Official documentation — Installation

Installation

  1. Extract the purchased package.
  2. Upload the lims folder to modules/ in your Perfex CRM installation (final path: modules/lims/).
  3. Go to Setup → Modules and activate LIMS.
  4. Assign permissions under Setup → Staff → Roles / Permissions.
  5. Open LIMS → Settings and configure defaults.

No Perfex CRM core files are modified. Tables and options are created on activation. Schema version option: lims_db_version = 100.

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

FeatureActions
Lab Dashboard
lims_dashboard		view
Laboratories
lims_labs		view, create, edit, delete
Test Categories
lims_test_categories		view, create, edit, delete
Test Methods
lims_test_methods		view, create, edit, delete
Sample Types
lims_sample_types		view, create, edit, delete
Samples
lims_samples		view, create, edit, delete
Test Results
lims_results		view, create, edit
QC Approval
lims_qc_approve		view, edit
Reports & COA
lims_reports		view
Integrations
lims_integrations		view
API Keys
lims_api_keys		view, create, edit, delete
Webhooks
lims_webhooks		view, create, edit, delete
Bulk Import
lims_import		view, create
Settings
lims_settings		view, edit

Verify installation (checklist)

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