Module: Global Consolidation & Reporting v1.0.0
What is Global Consolidation & Reporting?
Enterprise consolidation groups, multi-entity reporting, KPI dashboards, and executive packs for Perfex CRM
This module installs into modules/global_consolidation_reporting/ and adds its own admin menus, permissions, and database tables — without editing Perfex CRM core files.
Who should use this module?
- Admins — activate the module, configure Settings, assign roles, and manage integrations.
- Operators / day-to-day staff — create and update records (orders, attendance, shipments, messages, etc.).
- Managers / approvers — review queues, approve workflows, and monitor dashboards/KPIs.
- Finance / compliance / ops leads — run reports, exports, and audit trails when the module supports them.
What you can achieve
- Keep all related work in one place inside Perfex CRM instead of spreadsheets.
- Control who can view, create, edit, approve, or export with role permissions.
- Use dashboards and reports to see status, bottlenecks, and history.
- Connect to other CRM data (customers, invoices, items, staff) where the module integrates.
Recommended learning path
- Read How to Install and activate the module.
- Skim Features so you know what screens exist.
- Complete the Quick Start checklist on this page (Settings → masters → first sample record).
- Open each screen guide under Screen-by-screen guides when you need step-by-step help.
- Check Version & Changelog after upgrades for new options.
Tip: Train one admin first, then create a limited role for operators so they only see the screens they need.
5-minute Quick Start
Follow this short path the first time you use Global Consolidation & Reporting:
- Activate — Setup → Modules → activate Global Consolidation & Reporting (run Upgrade if prompted).
- Permissions — Setup → Staff → Roles → enable view/create/edit (and approve/settings if needed) for this module.
- Settings — Open Global Consolidation & Reporting → Settings and save company defaults, prefixes, and integrations.
- Master data — Create the first required masters (products, warehouses, templates, channels, accounts, routes, etc.).
- First transaction — Create one sample record end-to-end (save → submit/approve → complete) and confirm it appears in lists/reports.
- Cron — If the module uses alerts, sync, queues, or AI, confirm Perfex CRM cron is scheduled on the server.
Module documentation index
Start here — full guides for Global Consolidation & Reporting:
- Overview & How to Use — what it is, who uses it, daily workflow
- Quick Start Guide — first 5 minutes + printable how-to
- How to Install — upload, activate, permissions, verify
- Features (Full Detail) — every capability explained
- FAQ & Tips — common questions and best practices
- Version & Changelog — version history
Screen-by-screen guides (each tab explained)
Click a menu item below for step-by-step instructions on that Global Consolidation & Reporting screen:
- Consolidation Dashboard
- Consolidation Groups
- Reporting Entities
- Report Periods
- KPI Dashboard
- Reports
- Adjustments
- Eliminations
- FX Rates
- BI Exports
- Webhooks
- Settings
How to use in Perfex CRM (daily operations)
- Sign in to the admin area with a role that includes Global Consolidation & Reporting permissions.
- Open Global Consolidation Reporting (sidebar) or search for Global Consolidation & Reporting in the admin menu.
- Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
- Review Settings after upgrades — new options may need defaults for your company.
- Create or import master data first; most modules block transactions until masters exist.
- Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
- Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
- For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
- Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
- If something fails overnight, check Perfex CRM cron ran and open the module log / failed queue screen if present.
Admin menu — where to work
Open the Global Consolidation & Reporting section in the admin sidebar. Screens your staff may use (depending on role):
- Adjustments
- BI Exports
- Consolidation
- Consolidation Dashboard
- Consolidation Groups
- Eliminations
- FX Rates
- KPI Dashboard
- Reporting Entities
- Report Periods
- Reports
- Settings
- Webhooks
Screens map — what each menu is for
These are the admin screens registered by Global Consolidation & Reporting. Click a name in the Knowledge Base for a full how-to, or open the path in admin.
| # | Screen | Admin path | Guide |
|---|---|---|---|
| 1 | Consolidation Dashboard | admin/global_consolidation_reporting | How to use |
| 2 | Consolidation Groups | admin/global_consolidation_reporting/global_consolidation_reporting_groups | How to use |
| 3 | Reporting Entities | admin/global_consolidation_reporting/global_consolidation_reporting_entities | How to use |
| 4 | Report Periods | admin/global_consolidation_reporting/global_consolidation_reporting_periods | How to use |
| 5 | KPI Dashboard | admin/global_consolidation_reporting/global_consolidation_reporting_kpi | How to use |
| 6 | Reports | admin/global_consolidation_reporting/global_consolidation_reporting_reports | How to use |
| 7 | Adjustments | admin/global_consolidation_reporting/global_consolidation_reporting_adjustments | How to use |
| 8 | Eliminations | admin/global_consolidation_reporting/global_consolidation_reporting_eliminations | How to use |
| 9 | FX Rates | admin/global_consolidation_reporting/global_consolidation_reporting_fx_rates | How to use |
| 10 | BI Exports | admin/global_consolidation_reporting/global_consolidation_reporting_exports | How to use |
| 11 | Webhooks | admin/global_consolidation_reporting/global_consolidation_reporting_webhooks | How to use |
| 12 | Settings | admin/global_consolidation_reporting/global_consolidation_reporting_settings | How to use |
Detailed guide — features, workflows, API & FAQ
Features
Phase 1 — Foundation
| Feature | Status |
|---|---|
| --------- | -------- |
| Consolidation groups with member entities | Done |
| Ownership % per entity in group | Done |
| Reporting entities (plant/branch/company/custom) | Done |
| Report periods (monthly/quarterly/yearly/custom) | Done |
| Executive consolidation dashboard | Done |
| Module settings | Done |
| Staff permissions | Done |
| Audit logging | Done |
| Multi-Plant sync (optional) | Done |
| Dashboard widget | Done |
Phase 2 — Financial Consolidation
| Feature | Status |
|---|---|
| --------- | -------- |
| Report definitions (TB, P&L, Balance Sheet) | Done |
| Consolidation report runs | Done |
| FX rates and currency translation | Done |
| Accounting Pro integration (branch-linked entities) | Done |
| Inter-company elimination entries | Done |
| Ownership-weighted consolidation | Done |
| CSV export of run lines | Done |
Phase 3 — Operational KPI Consolidation
| Feature | Status |
|---|---|
| --------- | -------- |
| Sales consolidation (invoices + estimates) | Done |
| Inventory valuation (plant warehouse scoped) | Done |
| Manufacturing output (completed work orders) | Done |
| Demand forecast vs actual | Done |
| KPI Dashboard with snapshots | Done |
| Operational report run definitions | Done |
| Inventory turns metric | Done |
Phase 4 — Report Runs & Executive Pack
| Feature | Status |
|---|---|
| --------- | -------- |
| Run workflow (Draft → Calculated → Reviewed → Published) | Done |
| Consolidation adjustments | Done |
| Period-over-period variance analysis | Done |
| Executive pack PDF/Excel/CSV export | Done |
| Scheduled monthly consolidation (cron) | Done |
Phase 5 — API & Enterprise Integration
| Feature | Status |
|---|---|
| --------- | -------- |
| REST API (groups, entities, periods, report runs, KPI snapshots) | Done |
| API key auth (X-GCR-API-Key / Bearer / query param) | Done |
Webhooks (consolidation.published, period.closed) | Done |
| BI exports (CSV/JSON for Power BI / Tableau) | Done |
| Nasbix SaaS cross-tenant flag (optional) | Done |
| Accounting Pro deep integration detection | Done |
Quick Start
- Settings — Set default currency and code prefixes
- Reporting Entities — Create entities or sync from Multi-Plant Management
- Consolidation Groups — Create a group and assign entities with ownership %
- Report Periods — Define open reporting periods
- FX Rates — Set exchange rates for multi-currency groups
- Reports — Create a run, select group/period/definition, and Calculate
- Eliminations — Add inter-company elimination entries (optional)
Permissions
| Feature | Capabilities |
|---|---|
| --------- | ------------- |
gcr_dashboard | view |
gcr_groups | view, create, edit, delete |
gcr_entities | view, create, edit, delete |
gcr_periods | view, create, edit, delete |
gcr_reports | view, create, delete, export |
gcr_settings | view, edit |
Database Tables
| Table | Purpose |
|---|---|
| ------- | --------- |
gcr_reporting_entities | Plants, branches, companies for consolidation |
gcr_consolidation_groups | Consolidation group master |
gcr_group_members | Entity membership with ownership % |
gcr_report_periods | Fiscal/reporting periods |
gcr_logs | Audit trail |
gcr_report_definitions | Report templates (TB, P&L, BS) |
gcr_report_runs | Consolidation run snapshots |
gcr_report_run_lines | Entity-level consolidated lines |
gcr_fx_rates | Currency exchange rates |
gcr_elimination_entries | Inter-company eliminations |
gcr_kpi_snapshots | Operational KPI snapshots by group + period |
gcr_consolidation_adjustments | Manual consolidation adjustments |
gcr_run_variances | Period-over-period variance lines |
gcr_webhooks | Outbound webhook subscriptions |
gcr_webhook_deliveries | Webhook delivery log |
Integrations
| Module | Integration |
|---|---|
| -------- | ------------- |
| Multi-Plant Management | Sync plants as reporting entities |
| Accounting Pro | Trial balance, P&L, balance sheet per branch entity |
| Demand Planning | Forecast vs actual, accuracy metrics |
| Inventory Management | Plant-scoped stock valuation |
| Manufacturing | Completed work order output by plant |
Roadmap
See [docs/ROADMAP.md](docs/ROADMAP.md) for the full phase-wise plan (Phases 2–5).
DB Version
Check option gcr_db_version — expected 100 after install (v1.0.0).
REST API
Enable under Settings → API & Integrations, then generate an API key.
Base URL: your-site/global_consolidation_reporting/global_consolidation_reporting_api/
Auth headers: X-GCR-API-Key, Authorization: Bearer {key}, or ?api_key={key}
BI export example: GET .../export/run/{id}?format=json&api_key=YOUR_KEY
2. How to Use This Module
Step A — Configure settings
- Open the sidebar menu Global Consolidation & Reporting → Settings.
- Set default currency and code prefixes (groups, entities, periods, runs, eliminations, adjustments).
- Optionally enable scheduled monthly runs, API, and webhooks.
Step B — Create reporting entities
- Go to Reporting Entities.
- Add entities as plant, branch, company, or custom.
- If Multi-Plant Management is installed, you can sync plants as entities.
Step C — Create a consolidation group
- Go to Consolidation Groups → create a group.
- Add member entities and set ownership % for each member.
- Set the group status to Active when ready.
Step D — Define report periods
- Go to Report Periods.
- Create periods (monthly / quarterly / yearly / custom).
- Keep periods Open while working; Close when reporting is finished.
Step E — FX rates (multi-currency)
- Go to FX Rates.
- Add rates for from/to currency pairs by date.
Step F — Run a consolidation report
- Go to Reports → create a new run.
- Select consolidation group, period, and report definition (TB / P&L / BS / operational types).
- Click Calculate.
- Review results → mark Reviewed → Publish when approved.
- Export CSV / PDF / executive pack as needed.
Step G — Eliminations & adjustments (optional)
- Use Eliminations for inter-company amounts.
- Use Adjustments for manual consolidation journals.
Step H — KPI dashboard
- Open KPI Dashboard to view operational snapshots for a group and period.
Typical first-week workflow
Settings → Entities → Group (+ ownership %) → Periods → FX Rates → Report Run → Publish → Export
3. Features
| Area | What you get |
|---|---|
| Foundation | Groups, entities, periods, settings, permissions, audit log, dashboard widget |
| Financial | TB, P&L, Balance Sheet definitions, report runs, FX translation, ownership weighting |
| Operational | Sales, inventory valuation, manufacturing output, demand forecast, KPI pack |
| Workflow | Draft → Calculated → Reviewed → Published; adjustments; variances; scheduled runs |
| Enterprise | REST API, webhooks, BI CSV/JSON exports, optional SaaS cross-tenant flag |
Optional integrations
- Accounting Pro — branch-linked financial balances
- Multi-Plant Management — sync plants as entities
- Inventory / Manufacturing / Demand Planning — operational consolidation sources
These modules enhance data sources but are not required for installing and using the core module.
4. Permissions
Assign under Setup → Staff → Roles.
| Feature key | Capabilities |
|---|---|
gcr_dashboard | view |
gcr_groups | view, create, edit, delete |
gcr_entities | view, create, edit, delete |
gcr_periods | view, create, edit, delete |
gcr_reports | view, create, delete, export |
gcr_settings | view, edit |
Administrators have full access by default.
5. REST API & Webhooks
- Enable API under Settings → API & Integrations and generate an API key.
- Authenticate with header
X-GCR-API-Key, orAuthorization: Bearer {key}, or?api_key={key}. - Base path:
admin/global_consolidation_reporting/global_consolidation_reporting_api/(follow on-screen API docs / helper routes). - Webhook events:
consolidation.published,period.closed. - BI export: CSV/JSON for published runs (Power BI / Tableau friendly).
6. Uninstall (clean removal)
- Go to Setup → Modules.
- Deactivate the module, then click Uninstall.
Uninstall removes:
- All module database tables (
{prefix}gcr_*) - All module options (
gcr_*) - Upload folder
uploads/global_consolidation_reporting/(if present)
Core Perfex CRM tables and other modules are not affected. Uninstall is irreversible for module data — export reports first if needed.
7. Cron Jobs
Scheduled consolidation (if enabled in Settings) uses the main Perfex CRM cron:
* * * * * php /path/to/perfex/index.php cron/index > /dev/null 2>&1
Ensure cron is already configured for your Perfex installation.
After activation — configuration checklist
- Log in as administrator → go to Setup → Modules.
- Find Global Consolidation & Reporting and click Activate.
- Tables and options are created automatically on activation.
- Assign staff permissions under Setup → Staff → Roles (or staff permissions).
- Perfex CRM 2.3+ (3.0+ recommended)
- PHP 7.4+ (8.1+ recommended)
- MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
- PHP extensions: mysqli, json, mbstring, curl, fileinfo
One-time setup (first time only)
- Setup → Modules → activate Global Consolidation & Reporting.
- Setup → Staff → Roles → assign Global Consolidation & Reporting permissions (view, create, edit, delete, approve, export, settings as needed).
- Open Global Consolidation & Reporting → Settings and complete company defaults, prefixes, integrations, and notification options.
- Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
- Enable Perfex CRM cron (
php /path/to/perfex/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
Tips for success
- Always configure Settings before creating live transactions.
- Create master data (items, warehouses, templates, channels, accounts) first — most modules block incomplete records.
- Use a test/sample record before going live with real customers or production stock.
- Separate roles: operators create/edit; managers approve; finance/reporting get view/export only.
- After any module upgrade, reopen Settings and confirm new options have sensible defaults.
- If overnight jobs fail, verify Perfex CRM cron and check the module log / failed queue screen.
Common questions (FAQ)
Where do I find the module after activation?
In the admin sidebar look for Global Consolidation & Reporting. If missing, your role may lack view permission — fix under Setup → Staff → Roles.
Do I need to edit core Perfex CRM files?
No. Keep all custom code under modules/global_consolidation_reporting/. Activate/deactivate from Setup → Modules.
What happens if I uninstall?
Deactivate keeps data. Uninstall usually removes module tables/options (see the Install article). Core customers, invoices, and items are not deleted by well-built modules.
Why can't my staff see a screen?
Almost always a permissions issue. Give the role at least view on that feature, then ask the user to log out and back in.
Reports/export buttons do nothing
Confirm the role has export (or view reports) permission, and that filters return at least one row. Try PDF/CSV from a wider date range.
Perfex CRM Knowledge Base — detailed usage guide generated from module README, HOW_TO_USE, and documentation.