Search Knowledge Base Articles

SRB Integration — How to Install

← Back to SRB Integration overview

How to Install — SRB Integration

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

Pakistan SRB Sindh Revenue Board POS integration for Perfex CRM (sandbox and production APIs).

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 srb_integration.

Step-by-step installation

  1. Upload the srb_integration 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 SRB Integration 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 SRB Integration → Settings and save defaults.

Install notes from README

Setup

  1. Activate module: Setup → Modules → SRB Integration
  2. Open Setup → Settings → Integrations → SRB Integration
  3. Configure auto-submit, field mapping, retry, webhooks, and REST API
  4. Open SRB Integration → API Settings (or click Open SRB API settings on the settings tab)
  5. Set mode, environment, seller SNTN, POS ID, API key (and optional custom URLs)
  6. Click Test connection
  7. Start in Simulation, then switch to Live

Uninstall

  1. Setup → Modules → Deactivate SRB Integration
  2. Click Uninstall

This removes tables (srb_settings, srb_invoices, srb_audit_log, srb_webhook_queue), all module options, and the module files.

Cron (required for retries & webhooks)

Ensure Perfex CRM cron runs on schedule. Failed live submissions retry when Retry failed SRB submissions is enabled. Webhook delivery also runs on cron.

After activation — configuration checklist

  1. Go to Setup → Modules and activate SRB Integration.
  2. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open Setup → Settings → Integrations → SRB Integration and configure settings.
  5. Perfex CRM 3.0+
  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 srb_integration folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate SRB Integration.
  3. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open Setup → Settings → Integrations → SRB Integration and configure settings.

No core CRM files are modified. All tables and options are created on activation.

Requirements

  • Perfex CRM 3.0+
  • PHP 7.4+ (8.1+ recommended)
  • MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  • PHP extensions: mysqli, json, mbstring, curl, fileinfo

Verify installation (checklist)

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