Staff Hub

Staff Roster · Scheduling · Clock · Leave · Reports

Main features

Dashboard — live attendance KPIs from /api/timetracker/roaster-dashboard/
Roster Generator — week/day/month shift grid backed by /schedules/; publish via rota periods
Timesheet — hours derived from clock events for the selected period
Clock In / Out — punch, break start/end, verification methods
Employees — CRUD via /roaster-employees/; departments via /roaster-departments/
Leave & Availability — leave requests, unavailable dates, holidays
Reports — attendance summary from timesheets or clock-event fallback

Access routes

Entry	URL
Standalone app	`/Roaster.html?standalone=1`
ERP shell	`/erp_home.html#roaster`
Deep link section	`#roaster?section=clockin` (also roster, leave, reports, …)
Landing	`/roaster-landing.html`
This documentation	`/docs/staffhub.html`
Academy article	`/docs/index.html#/modules/roaster`

Requires a signed-in ERP user (erpAuthToken). All mutating calls use DRF token auth.

API endpoints

Staff Hub loads and saves application data through Timetracker APIs (HR employee/department tables, without requiring an HR subscription for roster-scoped endpoints).

Resource	Methods	Path
Employees	GET/POST/PUT/DELETE	`/api/timetracker/roaster-employees/`
Departments	GET/POST	`/api/timetracker/roaster-departments/`
Dashboard	GET	`/api/timetracker/roaster-dashboard/`
Schedules	GET/POST/PUT/DELETE	`/api/timetracker/schedules/`
Rota periods	GET/POST/PATCH + publish	`/api/timetracker/rota-periods/`
Clock events	GET + punch/live	`/api/timetracker/clock-events/`
Leave requests	GET/POST/PATCH/DELETE + approve	`/api/timetracker/leave-requests/`
Holidays	GET/POST	`/api/timetracker/holidays/`
Unavailable dates	GET/POST/DELETE	`/api/timetracker/unavailable-dates/`
Workforce profiles	GET/POST (upsert)	`/api/timetracker/wf-profiles/`
Workforce settings (geofence zone)	GET/POST/PATCH	`/api/timetracker/wf-settings/`
Attendance report	GET	`/api/timetracker/reports/attendance/`

Client

js/staffhub-api.js → window.RoasterAPI. UI logic lives in js/staffhub-app.js.

Data flow

Auth token

Employees / Depts

Schedules / Rota

Clock punches

Timesheet / Reports

Leave / Holidays

Browser (Roaster.html)
  → RoasterAPI (Token auth)
    → /api/timetracker/*  (Django DRF, user-scoped)
      → hr.Employee / hr.Department
      → timetracker.WorkSchedule / ClockEvent / LeaveRequest / Holiday
      → workforce RotaPeriod / WorkforceMemberProfile / WorkforceSettings

Geofence zone: lat/lng/radius/zone name persist on /api/timetracker/wf-settings/ (tenant workforce settings). Legacy localStorage values are migrated once then cleared.

Important rules

Empty employee lists stay empty — the UI does not seed demo staff.
Schedule POST upserts by (user, employee, date) to avoid duplicate roster cells.
Clock verification aliases: geofence→gps, both→biometric, standard→none.
Break control toggles break_start / break_end; live state comes from event replay.
Publish/Unpublish writes RotaPeriod.status on the API (draft/published).
Leave approval via PATCH or /approve/ updates balances and syncs HR/payroll hooks.
Attendance report prefers timesheet entries; otherwise derives from clock events.
All list/create/update operations are scoped to the authenticated tenant user.