Getting Started
Enable the module, let its migration build the tables, grant the twelve permissions to the right roles, review the seeded setups, and — optionally — load demo data. Then run one offboarding case from start to clearance so the whole workflow is familiar before you go live.
Prerequisites
- PHP 8.2+ and a running ERPat install with admin access to Settings → Manage Modules and the Roles editor.
- Employees exist in the Employee Master. A case is opened for an existing staff user — the module reads people, departments, and department heads from ERPat, it does not create them.
- Assets are optional but recommended. If the Asset Registry is in use, assets endorsed to a leaver are pulled into the case automatically.
- A ticking Advanced Cron runtime if you want scheduled releases (access actions becoming due) and reminders/escalations to fire — see Switch on the crons.
Activation — four steps
-
Run the module migration
From the project root. The migration is idempotent and reversible, and is tracked in the module's own
migrations_offboardingtable.php erpat migrate:modules # (or) php erpat migrate:latestThis creates the fifteen
offboarding_*tables and seeds the four system separation types and the connector slots. -
Turn the module on
Go to Settings → Manage Modules and enable Offboarding (listed under the Human Resource category — this sets
module_offboarding = 1). An Offboarding group appears in the left sidebar for every user who also holds theoffboardingpermission. -
Grant permissions (for non-admins)
In Roles, assign the Offboarding permission categories to the roles that need them. Administrators see everything by default. The twelve keys and what each unlocks are on Administration → Permissions.
-
Review the Setups
Open Offboarding → Setups and confirm the seeded Separation Types, the Task Catalog, and at least one published Checklist Template per type you intend to use. A case can only start if a published template matches its separation type.
With the module enabled and the offboarding permission granted, the sidebar gains an
Offboarding group with up to three items (Automation and Setups are hidden from users who lack
their permission):
| # | Menu item | URL | Opens | Needs |
|---|---|---|---|---|
| 1 | Checklist | offboarding/checklist | The list of offboarding cases and the case workspace. | offboarding |
| 2 | Automation | offboarding/automation | Versioned workflow definitions, dry runs, and run history. | offboarding_automation |
| 3 | Setups | offboarding/setups | Templates, separation types, task catalog, sign-offs, SLA, connectors, settings. | offboarding_setups |
Switch on the crons
Two scheduled jobs run on ERPat's Advanced Cron runtime. They only run if your server cron is ticking the runtime (or you tick it manually):
php erpat cron:list # confirm the two offboarding jobs are registered
php erpat cron:tick # run whatever is due right now
php erpat cron:run offboarding_scheduler # force a single job| Job (slug) | Schedule | What it does |
|---|---|---|
offboarding_scheduler | Every 10 minutes | Releases scheduled work as it becomes due — moves access actions to awaiting verification, marks tasks ready, and progresses case state. |
offboarding_reminders | Hourly | Sends reminders as SLA lead times approach and raises escalations on overdue tasks, actions, and sign-offs. |
Optional: load demo data
To explore the module with realistic sample cases, load the demo seeder. It is idempotent, so you can run it more than once safely, and it is reversible.
# Load sample offboarding data
php erpat db:seed OffboardingDemo
# Remove the sample data again (soft delete)
php erpat db:seed OffboardingDemo --removeYou can also run it from the Bulk Database Seeder modal (Tenants → toolbar) and remove it there with "Remove seed data". Keep demo data out of production tenants.
Your first case — a walkthrough
Who: an administrator (or a role holding
offboarding_create,
offboarding_actions, offboarding_assets, offboarding_signoff,
and offboarding_clearance).Preconditions: migration run, module enabled, one published template for the chosen type, at least one active staff user.
-
Open the Checklist and start a case
Go to Offboarding → Checklist and click Start case. Pick the departing employee and a separation type, set the last working day and time, and confirm the auto-resolved template. Preview the tasks, then start.
-
Explore the case tabs
The case page has five tabs — Checklist, Assets, Access, Sign-offs, and Audit. Skim each so you know where handover tasks, asset outcomes, access actions, approvals, and the activity log live.
-
Complete a task
On the Checklist tab, open a task and mark it complete. If the task is evidence-required, add a completion note first; dependency-blocked tasks stay locked until their prerequisite is done.
-
Record an asset and verify an access action
On Assets, mark an item returned with its condition. On Access, wait for (or trigger) the action to become awaiting verification, then mark it completed.
-
Approve the sign-offs
On Sign-offs, request and approve the department sign-offs. A rejection needs a note and sends the case back for rework.
-
Run final clearance
When the gates pass, the case shows Ready for clearance. Open Final clearance; if anything still blocks it, the dialog lists the exact items. Clear them (or record an authorized exception closure with a different approver) to complete the case.