Getting Started
Bring the whole Compliance suite online: enable the module, run its migrations, grant the per-area permissions your team needs, optionally load demo data, and learn where each of the twelve areas lives. New administrators should start at the Overview dashboard and expand outward.
1. Enable the module
Go to Settings → Manage Modules and enable Compliance. This sets the module_compliance flag that gates the whole suite — the left-menu group, the twelve area screens, the settings tab, the permissions, the routes, and the cron job. When the module is off, every area is withdrawn and the scheduled job self-skips.
module_compliance is seeded from the legacy module_disciplinary value, so an environment that already ran Disciplinary comes up with Compliance enabled automatically.2. Run module migrations
The suite ships 19 tables across the twelve areas. Apply them with the module migration runner, which tracks its versions in the per-module migrations_compliance table:
php erpat migrate:modules
Run this against the main database and every tenant during deployment so all areas exist everywhere. The disciplinary tables that predate the module already ship in the base install schema; the migrations create the ten additional areas' tables (investigations, corrective actions, disclosures, speak-up reports, training, policies, obligations, saved reports, audit events, and configuration).
3. Grant per-area permissions
In Settings → Roles, grant Compliance access. Each area is gated independently — a role only sees the areas you switch on. Most areas offer a base toggle plus Create / Edit / Remove; Overview and Audit Log are view-only, and Configuration is an administrator area.
| Area | Base permission | Actions |
|---|---|---|
| Overview | compliance_overview | View only |
| Disciplinary | deciplinary | Create / Edit / Remove (+ category, manage, labels, officers, comment permissions) |
| Investigations | compliance_investigation | Create / Edit / Remove |
| Corrective Actions | compliance_corrective_action | Create / Edit / Remove |
| Disclosures | compliance_disclosure | Create / Edit / Remove |
| Speak-up & Grievances | compliance_report | Create / Edit / Remove (restricted — grant sparingly) |
| Training & Certifications | compliance_training | Create / Edit / Remove |
| Policies & Attestations | compliance_policy | Create / Edit / Remove |
| Compliance Calendar | compliance_calendar | Create / Edit / Remove |
| Reports & Analytics | compliance_analytics | Create / Edit / Remove |
| Audit Log | compliance_audit | View only |
| Configuration | compliance_config | Create / Edit / Remove (administrators) |
Existing disciplinary grants carry over unchanged — the original permission keys were preserved. The full disciplinary key list and matrix is in Administration and Controls.
4. (Optional) Load demo data
To explore every screen with realistic sample content, run the module's demo seeder:
php erpat db:seed ComplianceDemo [--tenant=<key>|--all|--dry-run]
It seeds every area at once — disciplinary categories and cases, investigations, corrective actions, disclosures, speak-up reports, training courses and assignments, policies with attestation campaigns and exceptions, calendar obligations, saved reports, audit events, and configuration (jurisdictions, templates, retention rules, integrations). It is idempotent, so re-running it is safe.
--dry-runpreviews what would be written without changing data.--tenant=<key>targets one tenant;--allcovers the main database and every active tenant.php erpat db:seed ComplianceDemo --removesoft-deletes the demo data again when you are done.
5. Where each area lives
Once enabled, the Compliance group appears in the left menu under Human Resource. These are the twelve area items, in menu order, each opening its own screen:
| # | Menu item | Opens |
|---|---|---|
| 1 | Overview | compliance/dashboard |
| 2 | Disciplinary | hrs/compliance |
| 3 | Investigations | compliance/investigations |
| 4 | Corrective Actions | compliance/corrective_actions |
| 5 | Disclosures | compliance/disclosures |
| 6 | Speak-up & Grievances | compliance/reports |
| 7 | Training & Certifications | compliance/training |
| 8 | Policies & Attestations | compliance/policies |
| 9 | Compliance Calendar | compliance/calendar |
| 10 | Reports & Analytics | compliance/analytics |
| 11 | Audit Log | compliance/audit |
| 12 | Configuration | compliance/config |
The Disciplinary area also appears as a tab on each team member's profile, and administrators get a Disciplinary settings tab under Settings (compliance/settings).
6. Your first week
A recommended path for a new compliance administrator:
- Start at Overview. Open Compliance → Overview to read the cross-area KPIs (open cases, SLA risk, policy-attestation and required-training percentages) and the compliance-health score. This is read-only, so you cannot break anything.
- Set up Configuration. Under Configuration, define your jurisdictions, document templates, retention rules, and integrations so the rest of the suite has a foundation.
- Seed Disciplinary categories. Populate the categories catalog (via Settings → Initial Data industry presets, or manually) so cases can be filed.
- Publish a first policy. In Policies & Attestations, add a policy and run a small attestation campaign to see the workflow end to end.
- Assign a training course. In Training & Certifications, add a course and assign it to a pilot group.
- Add a calendar obligation. In Compliance Calendar, add an upcoming obligation and watch it appear on the Overview action center.
- Return to Overview. Confirm your activity is reflected in the KPIs, then review the Audit Log to see the trail your setup created.
7. Confirm it works
- The Compliance group appears in the left menu with all twelve items you granted.
- The Overview dashboard loads its KPIs and health score.
- Each area screen opens at the route above and lists its records (with demo data present if you seeded it).
- A team member profile shows a Disciplinary tab.
- Administrators see a Disciplinary tab under Settings, and the Configuration area is reachable.
- The Audit Log shows entries for the actions you performed during setup.