Rota overview

Product purpose

Rota is the workforce roster for an Antly workspace. It answers who should work, on which day, in which window, and at what headcount — then publishes that plan so staff, managers, and Attendance all read the same week.

Use Rota when coverage is planned in advance: wards, shops, reception, security, field crews, or any team that cannot rely on a single office clock-in window. Do not use it as a timesheet. Punches, lateness, and worked time remain in Attendance. Recurring task calendars remain in Schedules & rotas under work management.

Rota is a Launchpad module. It shares tenant identity, groups, permissions, workflow events, and JQL with Base. Enable it from Launchpad, then open Help in the Rota main menu for an interactive, from-scratch walkthrough of the same path described here.

Entity table

Area	Source entities	Why it matters
Policy	`RotaSettings`	One row per tenant: week start, swaps and claims, rest and hour limits, publish mail, attendance sync.
Catalogue	`ShiftTemplate`	Reusable windows (Early, Late, Night) with colour, headcount, role, and optional `attendance.Shift` policy.
Board	`Rota`	A named planning surface. Staff rows come from the groups attached to the board, not from an ad-hoc people picker.
Week	`RotaShift`	A dated instance of a template (or a one-off window) with required headcount and open-pool state.
People	`RotaAssignment`	A person on a shift, including shadow assignments. Presence on the board is punch-derived.
Repeat	`RotaPattern`, `RotaPatternSlot`	A reusable week cycle that can be stamped onto a date range.
Rules	`RotaComplianceRule`	Rest, weekly hours, consecutive days, and double-booking checks used before publish.
Self-service	`EmployeeAvailability`, `ShiftSwapRequest`, `OpenShiftClaim`	Cannot-work windows, exchanges, and claims on unfilled published slots.

How it connects to the rest of Antly

HCM: Employees, job roles, and competencies. A name cannot appear on a board unless they are an HCM employee in an attached group.
Groups (system.Group): The only source of scheduler rows. If a person is missing, they are not in the groups on that rota.
Attendance: When syncAttendanceExpectations is on, published assignees are expected to clock in. Presence states on the board are scheduled, due, live, and done — driven by punches, not by login. Attendance On shift is a read-only view of that published roster.
Tasks and tickets: Use these for follow-up (unfilled nights, failed claims, exception reviews). Do not duplicate the roster in a custom object.
Workflows: Assignment create, swap and claim create/approve, and publish-adjacent updates are the events worth automating.
Reference: Namespaces and intents live in /reference/rota.

Launchpad path and routes

Open Launchpad → Rota. Frontend package: packages/antly-app-rota. Backend app: src/rota.

Route	Audience	Use it for
`/`	All	Coverage snapshot and entry to the week
`/scheduler`	Planners	Drag templates, assign, publish
`/my-schedule`	Staff	Personal published week and presence
`/open-shifts`	Staff	Claim unfilled published slots
`/swaps`	Staff	Propose or respond to exchanges
`/availability`	Staff	Record cannot-work windows
`/help`	All	Interactive setup guide (also in the main menu)
`/admin/rota-rotas`	Administrators	Create boards and attach groups
`/admin/rota-templates`	Administrators	Shift template catalogue
`/admin/rota-patterns`	Administrators	Repeating week designs
`/admin/rota-compliance`	Administrators	Rest and hour rules
`/admin/rota-approvals`	Administrators	Swap and claim queues
`/admin/rota-settings`	Administrators	Tenant policy
`/reports`	Administrators	Coverage versus actual punches

Who uses it

Operations and ward or store managers who own the week.
HR or workforce administrators who own templates, groups, and policy.
Employees who only need their own schedule, claims, and swaps.
Attendance operators who reconcile expected versus punched presence.

What to keep in this module

Keep the published roster in Rota. Keep punches in Attendance. Keep employment and leave in HCM.
Use groups to decide who appears on a board. Do not invent a second staff list.
Use templates for any window you will place more than once. Use one-off times only for exceptions.
Publish deliberately. Draft shifts are planning artefacts; staff and Attendance should not treat them as live.
Use Help in the product when training a new planner — it mirrors this guide with animated captures of the board, palette, and presence chips.