Sustainability / ESG Tracking — Quick Start Guide

HOW TO USE — Sustainability / ESG Tracking Module for Perfex CRM

Author: Nasbix Technologies | Version: 1.0.0

═══════════════════════════════════════════════════════

1. INSTALLATION

═══════════════════════════════════════════════════════

1. Extract the main ZIP.

2. Upload the folder "esg" into:

/your-perfex-root/modules/

1. Login as admin → Setup → Modules.
2. Click Activate on "Sustainability / ESG Tracking".
3. Database tables + default settings are created automatically.

6. Assign staff permissions: Setup → Staff → Roles

(Dashboard, Categories, Metrics, Entries, Carbon, Goals,

Reports, Assessments, Integrations, API Keys, Webhooks, Settings).

7. Configure: ESG → Settings

(code prefixes, verification, portal, API, webhooks, imports).

═══════════════════════════════════════════════════════

2. FIRST SETUP (recommended order)

═══════════════════════════════════════════════════════

1. Open ESG → Metric Categories

(defaults are already seeded for E / S / G pillars).

2. Open ESG → Settings and set:

- Metric / carbon / goal / report / assessment code prefixes

- Require entry verification (on/off)

- Client portal for published reports (optional)

- REST API & webhooks (optional)

1. Create your first ESG Metrics under ESG → Metrics.
2. Add Metric Data Entries for a reporting period.
3. (Optional) Review Carbon Sources & Emission Factors

(11 sources + 11 factors are pre-seeded).

═══════════════════════════════════════════════════════

3. ESG METRICS WORKFLOW

═══════════════════════════════════════════════════════

• Categories — organize by Environmental / Social / Governance

• Metrics — KPI code, unit, target, direction, frequency, framework ref

• Entries — period start/end, actual value, notes, evidence file

• Verification — Draft → Submitted → Verified (if enabled in Settings)

• Dashboard — pillar charts, pending verification, recent activity

═══════════════════════════════════════════════════════

4. CARBON ACCOUNTING

═══════════════════════════════════════════════════════

• Carbon Sources — Scope 1 / 2 / 3 (fuel, electricity, travel, waste…)

• Emission Factors — kg CO2e conversion factors (IPCC / DEFRA style)

• Carbon Entries — activity amount × factor → CO2e kg & tonnes

• Carbon Dashboard — totals by scope and trends

• Optional imports — Transport / Manufacturing when those modules exist

• Multi-plant scoping — plant_id on metric & carbon entries (optional)

═══════════════════════════════════════════════════════

5. SUSTAINABILITY GOALS

═══════════════════════════════════════════════════════

• Create goals with SDG number / reference and target year

• Set baseline, target value, and direction

• Add milestones with due dates

• Link ESG metrics to auto-calculate progress

• Status: not started / on track / at risk / off track

• Cron can notify staff of upcoming / overdue milestones (if enabled)

═══════════════════════════════════════════════════════

6. DISCLOSURE REPORTS

═══════════════════════════════════════════════════════

• Templates: GRI, SASB, TCFD, or Custom

• Attach metrics for the reporting period

• Narrative text + validation status

• Publish / review workflow

• PDF preview via module PDF library

• Optional: share published reports to client portal

═══════════════════════════════════════════════════════

7. SUPPLIER ASSESSMENTS

═══════════════════════════════════════════════════════

• Create supplier ESG scorecards (E / S / G + overall)

• Questionnaire responses + notes

• Draft → Submitted → Reviewed workflow

• Track assessment date and period

═══════════════════════════════════════════════════════

8. API, WEBHOOKS & INTEGRATIONS

═══════════════════════════════════════════════════════

REST API:

1. ESG → Settings → enable REST API

2. ESG → API Keys → create key (scopes: read / write / read_write)

3. Use the token on API requests (see documentation)

Webhooks:

1. Settings → enable webhooks

2. ESG → Webhooks → add URL + secret + events

3. Delivery attempts are logged

Integrations page:

- Toggle transport / manufacturing import helpers

- Multi-plant scoping options

═══════════════════════════════════════════════════════

9. UNINSTALL

═══════════════════════════════════════════════════════

1. Setup → Modules → Deactivate (optional)

2. Click Uninstall

3. All esg_* tables and esg_* options are removed

1. uploads/esg/ evidence folder is deleted

5. No core Perfex CRM files are modified

6. Export data first — uninstall cannot be undone

═══════════════════════════════════════════════════════

10. DOCUMENTATION

═══════════════════════════════════════════════════════

Open documentation/index.html inside the module package

for a browser-friendly guide (installation, features, permissions,

how to use, cron, support).