Search Knowledge Base Articles

Business Intelligence Dashboard — Overview & module guide

Module: Business Intelligence Dashboard v1.4.0

Executive BI dashboards, KPI analytics and reporting for BIXCRM

Screen-by-screen guides (each tab explained)

Click a menu item below for step-by-step instructions on that Business Intelligence Dashboard screen:

How to use in BIXCRM (daily operations)

  1. Sign in to the admin area with a role that includes Business Intelligence Dashboard permissions.
  2. Open Business Intelligence (sidebar) or search for Business Intelligence Dashboard in the admin menu.
  3. Start on the Dashboard (if available) to see open tasks, pending approvals, and KPIs.
  4. Review Settings after upgrades — new options may need defaults for your company.
  5. Create or import master data first; most modules block transactions until masters exist.
  6. Run the main business flow (create → submit → approve → post/complete) using the screens listed in Admin menu below.
  7. Use Reports / Analytics screens to reconcile stock, finance, compliance, or SLA metrics.
  8. For integrations (API, EDI, gateways, tax), confirm credentials in Settings and monitor logs or webhook delivery screens.
  9. Train staff with role-based access — give approvers approve permissions only, operators create/edit on their area.
  10. 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 Business Intelligence Dashboard section in the admin sidebar. Screens your staff may use (depending on role):

  • Advanced Analytics
  • API & Embed
  • BI
  • BI Dashboard
  • Custom Dashboards
  • Enterprise Integrations
  • Goals & Targets
  • Reports
  • Scheduled Refresh
  • Settings

Detailed guide — features, workflows, API & FAQ

Phase 5 Features (Current)

FeatureStatus
-----------------
Read-only REST API (KPIs, dashboards, analytics, goals)Done
Outbound webhooks (goal.alert, forecast.generated)Done
Token-based public embed dashboardsDone

Phase 4 Features

FeatureStatus
-----------------
Enterprise module integrations (6 modules)Done

REST API

Enable under Settings → REST API. Authenticate with header X-BI-API-Key.

MethodEndpoint
------------------
GET/business_intelligence/api
GET/business_intelligence/api/kpis
GET/business_intelligence/api/dashboards
GET/business_intelligence/api/dashboards/{id}
GET/business_intelligence/api/analytics/cohort
GET/business_intelligence/api/analytics/funnel
GET/business_intelligence/api/analytics/forecast
GET/business_intelligence/api/analytics/staff
GET/business_intelligence/api/goals

Embeds

Create tokens under API & Embed. Public URL format:

/business_intelligence/embed/{token}

Database Tables (Phase 5)

TablePurpose
----------------
bi_embed_tokensPublic embed access tokens

Check option bi_db_version — expected 104 after Phase 5.

See [docs/ROADMAP.md](docs/ROADMAP.md) for the full module history.

Features

Executive BI dashboards, KPI analytics and 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 Business Intelligence Dashboard 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

  1. Go to Setup → Modules and activate Business Intelligence Dashboard.
  2. If prompted, click Upgrade Database or reload admin — migrations run automatically.
  3. Assign permissions under Setup → Staff → Roles.
  4. Open the module menu and configure settings.
  5. BIXCRM 3.0+
  6. PHP 7.4+ (8.1+ recommended)
  7. MySQL 5.7+ / MariaDB 10.3+ (InnoDB)
  8. 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

One-time setup (first time only)

  1. Setup → Modules → activate Business Intelligence Dashboard.
  2. Setup → Staff → Roles → assign Business Intelligence Dashboard permissions (view, create, edit, delete, approve, export, settings as needed).
  3. Open Business Intelligence Dashboard → Settings and complete company defaults, prefixes, integrations, and notification options.
  4. Create master data (warehouses, products, templates, accounts, routes, etc.) before processing live transactions.
  5. Enable BIXCRM cron (php /path/to/bixcrm/index.php cron/index) for sync, retries, alerts, and scheduled jobs.
  6. Optionally enable REST API / webhooks in module settings if you integrate external systems.

BIXCRM Knowledge Base — usage guide generated from module README and documentation.

Did you find this article useful?

Related Articles