Module: Global Consolidation & Reporting v1.4.0
Enterprise consolidation groups, reporting entities, and executive reporting for BIXCRM
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 BIXCRM (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 BIXCRM 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
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 104 after Phase 5 install/upgrade.
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
Features
Enterprise consolidation groups, reporting entities, and executive reporting for BIXCRM
See README.md in the module folder for the complete feature list.
Permissions
Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Global Consolidation & Reporting capability group.
Typical capabilities include view, create, edit, delete, plus module-specific actions (approve, export, settings, API access).
Cron Jobs
Background tasks (if enabled) run through BIXCRM's main cron. Example crontab (every 5 minutes):
* * * * * php /path/to/bixcrm/index.php cron/index > /dev/null 2>&1
Check module settings for scheduled jobs (alerts, sync, reports, retention).
After activation — configuration checklist
- Go to Setup → Modules and activate Global Consolidation & Reporting.
- If prompted, click Upgrade Database or reload admin — migrations run automatically.
- Assign permissions under Setup → Staff → Roles.
- Open the module menu and configure settings.
- BIXCRM 3.0+
- 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 BIXCRM cron (
php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs. - Optionally enable REST API / webhooks in module settings if you integrate external systems.
BIXCRM Knowledge Base — usage guide generated from module README and documentation.