Search Knowledge Base Articles

Sustainability / ESG Tracking — How to Install

← Back to Sustainability / ESG Tracking overview

How to Install — Sustainability / ESG Tracking

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

Environmental, Social & Governance (ESG) metrics tracking, KPI management, and sustainability 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 esg.

Step-by-step installation

  1. Upload the esg 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 Sustainability / ESG Tracking 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 Sustainability / ESG Tracking → Settings and save defaults.

Install notes from README

Installation

  1. Upload the esg folder to modules/ in your Perfex CRM installation
  2. Go to Setup → Modules in admin
  3. Find Sustainability / ESG Tracking and click Activate
  4. Assign staff permissions under Setup → Staff → Roles

Uninstall

Deactivating keeps data. Uninstall (Setup → Modules) drops all tbl_esg_* tables, removes esg_* settings, and deletes uploaded evidence under uploads/esg/.

After activation — configuration checklist

  1. Go to Setup → Modules and activate Sustainability / ESG Tracking.
  2. All database tables and settings are created on activation (no core file edits).
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the ESG 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. Upload the esg folder to modules/ in your Perfex CRM installation.
  2. Go to Setup → Modules and activate Sustainability / ESG Tracking.
  3. All database tables and settings are created on activation (no core file edits).
  4. Assign permissions under Setup → Staff → Roles.
  5. Open the ESG menu and configure Settings.

No core CRM files are modified. Uninstall removes all module tables, options, and files under uploads/esg/.

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
ESG Dashboard
esg_dashboard		view
Metric Categories
esg_metric_categories		view, create, edit, delete
ESG Metrics
esg_metrics		view, create, edit, delete
Metric Data Entries
esg_metric_entries		view, create, edit, delete
Settings
esg_settings		view, edit
Carbon Dashboard
esg_carbon		view
Carbon Sources
esg_carbon_sources		view, create, edit, delete
Emission Factors
esg_emission_factors		view, create, edit, delete
Carbon Entries
esg_carbon_entries		view, create, edit, delete
Sustainability Goals
esg_sustainability_goals		view, create, edit, delete
ESG Reports
esg_reports		view, create, edit, delete
Supplier ESG Assessments
esg_supplier_assessments		view, create, edit, delete
Integrations
esg_integrations		view, edit
API Keys
esg_api_keys		view, create, delete
Webhooks
esg_webhooks		view, create, edit, delete

Verify installation (checklist)

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