Search Knowledge Base Articles

Business Intelligence Dashboard — How to Install

← Back to Business Intelligence Dashboard overview

How to Install — Business Intelligence Dashboard

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

Executive BI dashboards, KPI analytics and reporting 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 business_intelligence.

Step-by-step installation

  1. Upload the business_intelligence 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 Business Intelligence Dashboard 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 Business Intelligence Dashboard → Settings and save defaults.

Install notes from README

Installation

  1. Upload the business_intelligence folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Business Intelligence Dashboard.
  3. Assign capabilities under Setup → Staff → Roles (Business Intelligence group).
  4. Configure Perfex CRM cron for goal alerts, forecast webhooks, and scheduled refresh.

Uninstall

Deactivate the module, then use Uninstall from Setup → Modules. This removes all module tables (tblbi_*) and settings (bi_* options). Module data is not kept after uninstall.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Business Intelligence Dashboard.
  2. If prompted, click Upgrade Database or reload admin — migration 100 / install.php runs automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the module menu and configure Settings.
  5. Perfex CRM 2.3+ (3.x recommended)
  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. Extract the CodeCanyon Main File ZIP.
  2. Upload the business_intelligence folder to modules/ in your Perfex CRM installation.
  3. Go to Setup → Modules and activate Business Intelligence Dashboard.
  4. If prompted, click Upgrade Database or reload admin — migration 100 / install.php runs automatically.
  5. Assign permissions under Setup → Staff → Roles.
  6. Open the module menu and configure Settings.

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

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

Staff permissions (from module)

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

FeatureActions
BI Dashboard
bi_dashboard		view
Reports
bi_reports		view, export
Custom Dashboards
bi_dashboards		view, create, edit, delete
Settings
bi_settings		view, edit
Advanced Analytics
bi_analytics		view
Goals & Targets
bi_goals		view, create, edit, delete

Verify installation (checklist)

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