Search Knowledge Base Articles

Regulatory Compliance Hub — Overview & module guide

Module: Regulatory Compliance Hub v1.4.0

Regulatory framework management, compliance obligations tracking, and audit readiness for BIXCRM

Screen-by-screen guides (each tab explained)

Click a menu item below for step-by-step instructions on that Regulatory Compliance Hub screen:

How to use in BIXCRM (daily operations)

Sign in to the admin area with a role that includes Regulatory Compliance Hub permissions.
Open Regulatory Compliance Hub (sidebar) or search for Regulatory Compliance Hub 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 Regulatory Compliance Hub section in the admin sidebar. Screens your staff may use (depending on role):

API Keys
Audit Calendar
Audit Findings
Compliance Dashboard
Compliance Hub
Compliance Reports
Compliance Scorecard
Corrective Actions (CAPA)
Frameworks
Integrations
Obligations
Policies
Regulations
Settings
Training Records
Training Requirements
Webhooks

Detailed guide — features, workflows, API & FAQ

Features (Phase 1–5)

Frameworks — Catalog of regulatory frameworks (GDPR, ISO 27001, SOX, HIPAA, PCI-DSS, OSHA)
Regulations — Individual compliance rules with risk levels linked to frameworks
Obligations — Assignable compliance tasks with due dates, recurrence, evidence upload
Audit Calendar — Schedule internal, external, regulatory, and surveillance audits
Audit Findings — Track findings with severity, regulation link, root cause analysis
Corrective Actions (CAPA) — Remediation workflow with owner assignment, completion, and verification
Policies — Document register with version control (Draft → Review → Published → Archived)
Staff Acknowledgments — Track who read/acknowledged each published policy
Training Requirements — Mandatory training rules linked to frameworks/regulations
Training Records — Staff certifications with expiry tracking and certificate upload
Compliance Scorecard — Per-staff mandatory training readiness percentage
REST API — Read compliance data via API keys (frameworks, obligations, findings, policies, training)
Webhooks — HTTP notifications on overdue obligations, new findings, published policies, expiring certs
Compliance Reports — PDF and CSV compliance status packs
Cron Alerts — Automated due-date and expiry notifications
ESG Integration — Sync governance KPIs to ESG module metrics
HRM Pro Integration — Import completed training enrollments from HRM Pro
Dashboard — KPI cards, charts, upcoming obligations/audits/policies/certs, activity log
Settings — Code prefixes, overdue alerts, API/webhook/cron toggles
Permissions — Granular staff capabilities per feature
Dashboard Widget — Compliance summary on the home dashboard

No Core Changes

This module uses only BIXCRM hooks and the standard module system. No files in application/ are modified.

API Usage

Enable REST API in Settings, create an API key, then:

GET /regulatory_compliance_hub/rch_api/obligations
Authorization: Bearer rch_...

Or header: X-RCH-API-Key: rch_...

ESG Governance Sync

Create ESG governance metrics with codes:

RCH-OBL-COMPLETION
RCH-OPEN-FINDINGS
RCH-TRAINING-COMPLIANCE
RCH-POLICY-ACK-RATE

Enable ESG sync in Settings, then use Integrations → Sync to ESG.

Database Tables

Table	Purpose
-------	---------
`tblrch_frameworks`	Regulatory framework catalog
`tblrch_regulations`	Individual regulations/requirements
`tblrch_obligations`	Compliance tasks and obligations
`tblrch_audits`	Scheduled audit calendar
`tblrch_audit_findings`	Audit findings with severity and regulation link
`tblrch_corrective_actions`	CAPA remediation actions
`tblrch_policy_documents`	Policy document register with versions
`tblrch_policy_frameworks`	Policy-to-framework mapping
`tblrch_policy_acknowledgments`	Staff policy acknowledgments
`tblrch_training_requirements`	Mandatory training rules
`tblrch_training_records`	Staff training completions and certifications
`tblrch_api_keys`	REST API authentication keys
`tblrch_webhooks`	Outbound webhook subscriptions
`tblrch_webhook_deliveries`	Webhook delivery log and retry queue
`tblrch_integration_logs`	Integration activity audit trail
`tblrch_logs`	Activity audit trail

Options

Option	Default	Description
--------	---------	-------------
`rch_db_version`	104	Database schema version
`rch_enable_api`	0	Enable REST API
`rch_enable_webhooks`	0	Enable outbound webhooks
`rch_enable_cron_alerts`	1	Enable cron email/in-app alerts
`rch_enable_esg_sync`	0	Enable ESG governance KPI sync
`rch_api_rate_limit_per_minute`	120	Default API rate limit

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

Features

Regulatory framework management, compliance obligations tracking, and audit readiness for BIXCRM

**Frameworks** — Catalog of regulatory frameworks (GDPR, ISO 27001, SOX, HIPAA, PCI-DSS, OSHA)
**Regulations** — Individual compliance rules with risk levels linked to frameworks
**Obligations** — Assignable compliance tasks with due dates, recurrence, evidence upload
**Audit Calendar** — Schedule internal, external, regulatory, and surveillance audits
**Audit Findings** — Track findings with severity, regulation link, root cause analysis
**Corrective Actions (CAPA)** — Remediation workflow with owner assignment, completion, and verification
**Policies** — Document register with version control (Draft → Review → Published → Archived)
**Staff Acknowledgments** — Track who read/acknowledged each published policy
**Training Requirements** — Mandatory training rules linked to frameworks/regulations
**Training Records** — Staff certifications with expiry tracking and certificate upload
**Compliance Scorecard** — Per-staff mandatory training readiness percentage
**REST API** — Read compliance data via API keys (frameworks, obligations, findings, policies, training)
**Webhooks** — HTTP notifications on overdue obligations, new findings, published policies, expiring certs
**Compliance Reports** — PDF and CSV compliance status packs
**Cron Alerts** — Automated due-date and expiry notifications
**ESG Integration** — Sync governance KPIs to ESG module metrics
**HRM Pro Integration** — Import completed training enrollments from HRM Pro
**Dashboard** — KPI cards, charts, upcoming obligations/audits/policies/certs, activity log
**Settings** — Code prefixes, overdue alerts, API/webhook/cron toggles
**Permissions** — Granular staff capabilities per feature

Permissions

Granular staff capabilities are registered on activation. Assign them under Setup → Staff → Roles for the Regulatory Compliance Hub 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 Regulatory Compliance Hub.
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

Staff permissions (from module)

Assign under Setup → Staff → Roles. Each feature can expose different actions:

Feature	Actions
Compliance Dashboard `rch_dashboard`	view
Frameworks `rch_frameworks`	view, create, edit, delete
Regulations `rch_regulations`	view, create, edit, delete
Obligations `rch_obligations`	view, create, edit, delete, complete
Audit Calendar `rch_audits`	view, create, edit, delete
Audit Findings `rch_audit_findings`	view, create, edit, delete
Corrective Actions (CAPA) `rch_corrective_actions`	view, create, edit, delete, complete, verify
Policies `rch_policies`	view, create, edit, delete, publish
Training Records `rch_training_records`	view, create, edit, delete
Training Requirements `rch_training_requirements`	view, create, edit, delete
Compliance Scorecard `rch_scorecard`	view
Compliance Reports `rch_reports`	view, export
API Keys `rch_api_keys`	view, create, delete
Webhooks `rch_webhooks`	view, edit, delete
Integrations `rch_integrations`	view, edit
Settings `rch_settings`	view, edit

One-time setup (first time only)

Setup → Modules → activate Regulatory Compliance Hub.
Setup → Staff → Roles → assign Regulatory Compliance Hub permissions (view, create, edit, delete, approve, export, settings as needed).
Open Regulatory Compliance Hub → 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.

Did you find this article useful?

Regulatory Compliance Hub — Compliance Dashboard (how to use)

← Back to Regulatory Compliance Hub overviewCompliance DashboardModule: Regulatory Compliance HubWhe...
Regulatory Compliance Hub — Obligations (how to use)

← Back to Regulatory Compliance Hub overviewObligationsModule: Regulatory Compliance HubWhere to ope...
Regulatory Compliance Hub — Compliance Scorecard (how to use)

← Back to Regulatory Compliance Hub overviewCompliance ScorecardModule: Regulatory Compliance HubWhe...
Regulatory Compliance Hub — Policies (how to use)

← Back to Regulatory Compliance Hub overviewPoliciesModule: Regulatory Compliance HubWhere to open i...
Regulatory Compliance Hub — Training Records (how to use)

← Back to Regulatory Compliance Hub overviewTraining RecordsModule: Regulatory Compliance HubWhere t...