Orbit documentation
Orbit is a multi-tenant case-management and employment-services platform. It covers clients, cases, scheduling, employers, a job portal, events, public applications, imports and reporting.
This documentation is organised by who you are and what you're doing. Screenshots were taken from a demo organisation (acme) and can be regenerated with scripts/doc-shots.mjs.
Start here
| I am… | Read |
|---|---|
| New to Orbit | Signing in → Navigating Orbit → Dashboard |
| A front-line staff member | Basic use and the workflows |
| Migrating data into Orbit | CSV imports and Onboarding existing data |
| My organisation's administrator | Administration overview and its first-time setup checklist |
| A platform operator (superadmin) | Platform and Operations |
Getting started
- Signing in: sign in, two-step verification, forgotten passwords, invitations
- Navigating Orbit: sidebar, sites, search, notifications, account menu, page patterns
- Your profile and security: personal details, two-step verification, recovery codes, password
Basic use (day-to-day work)
- Dashboard
- Clients: list, add, record, notes, interactions
- Cases: create, status history, closing
- Follow-ups and tasks
- Appointments: the scheduler, drag and drop, conflicts
- Recurring appointments
- Staff
- Employers: contacts, interactions, NAICS
- Job postings: create, publish to the portal
- Job applications: queues, stages, placements
- Events: registrations, check-in
- Public submissions: review, convert, reject
- Documents and files
- Notifications
Advanced use
Data imports
- CSV imports: concepts: record types, mapping, lookups, duplicates, history
- CSV import walkthrough: step by step
- Import templates: create, run, update and manage templates
- Import recipes: every record type, sample files, multi-step import order
- Import troubleshooting
- Sample files:
assets/samples/
Reporting
- Reports overview
- Custom reports: starters, the five-step builder, exports
- Report delivery: email and schedules
More
- Classification and matching (NOC & NAICS)
- Staff workload and availability
- Public portal: job and event boards, confirmation, embedding
Workflows (end-to-end processes)
- Client intake to first appointment
- Job placement
- Running an event
- Onboarding existing data (multi-step import)
- Month-end reporting
Administration
- Administration overview: what's where, first-time setup checklist
- Users and access: add users, invites, roles, sites, passwords, staff links, offboarding
- Roles and permissions
- Sites
- Staff management
- General settings and terminology
- Definitions (dropdown values)
- Forms and the form builder: build, publish and use forms, step by step
- Scheduling settings and resources
- Notification settings
- Classification settings
- Documents settings
- Integrations
- Audit logs
- Licensing and features
Platform (Overseer)
- Overseer overview
- Provisioning tenants
- Tenant management: licenses, sites, users, MFA reset, feedback
- Superadmins and security
Operations (IT and developers)
- Installation: local, Docker, Dokploy, production checklist
- Configuration: every environment variable
- Background worker
- Backups and migrations
- API
- Testing and documentation screenshots
- Extending Orbit
Reference
Conventions in this documentation
- Bold text is a button, field or menu exactly as it appears in Orbit.
Codetext is something you type, a code, or a permission (for exampleclients.write).- Needs: lists the permissions required; License: lists the module that must be enabled.
-
Note / Tip / Important / Warning blocks call out things that are easy to miss.