Search Knowledge Base Articles

Mobile SFA — How to Install

← Back to Mobile SFA overview

How to Install — Mobile SFA

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

Mobile Sales Force Automation for Perfex CRM — territories, routes, visits, orders, and collections via REST API

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

Step-by-step installation

  1. Upload the mobile_sfa 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 Mobile SFA 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 Mobile SFA → Settings and save defaults.

Install notes from README

Install

  1. Copy modules/mobile_sfa/ into your Perfex CRM modules/ directory
  2. Go to Setup → Modules and activate Mobile SFA
  3. Configure Mobile SFA → Settings
  4. Create territories, assign clients, add sales reps with PIN
  5. Approve mobile devices as they register

Uninstall

From Setup → Modules, uninstall Mobile SFA. This removes all msfa_* tables, options, and files under uploads/mobile_sfa/. Core CRM data is kept.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Mobile SFA.
  2. Reload admin if needed — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open SFA → Settings and configure the module.
  5. Perfex CRM 2.3+ / 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 mobile_sfa folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Mobile SFA.
  3. Reload admin if needed — migrations run automatically.
  4. Assign permissions under Setup → Staff → Roles.
  5. Open SFA → Settings and configure the module.

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

Requirements

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

Staff permissions (from module)

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

FeatureActions
Dashboard
msfa_dashboard		view
Sales Reps
msfa_sales_reps		view, create, edit, delete
Territories
msfa_territories		view, create, edit, delete
Mobile Devices
msfa_devices		view, edit, delete
Visits
msfa_visits		view, delete
Routes & Beats
msfa_routes		view, create, edit, delete
Orders
msfa_orders		view, edit, delete
Collections
msfa_collections		view, edit, delete
API Keys
msfa_api		view, create, delete
Settings
msfa_settings		view, edit
Webhooks
msfa_webhooks		view, create, edit, delete
Executive Reports
msfa_reports		view

Verify installation (checklist)

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