Documentation
Understand and operate Orkyo
Shared product knowledge with explicit SaaS and Community guidance.
Getting started
- Getting started with OrkyoUnderstand Orkyo's core model and walk the setup path from an empty workspace to your first scheduled request.
- Create your account and workspaceSign up, accept an invitation, agree to the Terms of Service, and set up your organization with the onboarding wizard.
- A tour of OrkyoWhere everything lives — the main navigation, the top bar, global search, and the built-in guided tour.
- SaaS or Community?How the hosted Orkyo SaaS and the self-hosted Community Edition compare, and how this documentation covers both.
User guide
- The Utilization boardOrkyo's home page — schedule space allocations, review people utilization, and move through time on one board.
- Auto-schedulingHand the unscheduled backlog to a solver, review the proposed placements, and commit only what you accept.
- Working with requestsCapture the work that needs scheduling — create requests, nest them into containers, and manage them as a tree or a list.
- Spaces and floorplansManage the spaces you schedule work into — on a visual floorplan, as a list, and organized into groups.
- People, teams and skillsManage people as schedulable resources — skills, availability, absences, teams, job titles, and departments.
- Custom resource typesBeyond spaces, people, and tools — define your own resource types and manage them on their own pages.
- Insights and KPIsThe analytics dashboard — KPI cards, utilization and conflict trends, and request-status history over a period you choose.
- Import and exportMove data in and out of Orkyo — CSV and JSON imports, exports per page, and the PDF Gantt of the schedule.
- Your account and securityProfile, organization memberships, password, two-factor authentication, sessions, and email preferences.
- Criteria and capabilitiesDefine the reusable, typed attributes that drive capability matching — data types, units, enums, and applicability.
- Resource typesDefine the kinds of things your organization manages — spaces, people, tools, and any type you add yourself.
- Request templatesReusable blueprints for common request patterns — duration, timing constraints, and pre-set criteria in one definition.
- PresetsMove whole tenant configurations — criteria, groups, and templates — between workspaces as validated preset files.
- Scheduling settingsPer-site working hours, weekends, public holidays, and availability events — the calendar every schedule is placed into.
Concepts
- The Orkyo planning modelRequests, resources, criteria, sites, and schedules — the five ideas every other Orkyo feature builds on.
- How capability matching worksOne criteria vocabulary, used as capabilities on resources and requirements on requests — and validated automatically.
- Scheduling and availabilityHow working hours, weekends, holidays, availability events, and absences combine to decide when work can be placed.
- Understanding conflictsWhat counts as a conflict, every conflict kind explained, and how conflicts surface across the product.
Administration
- Managing sitesAdministratorCreate and maintain physical sites — the containers for spaces and the unit scheduling settings are scoped to.
- Users and rolesAdministratorInvite people into your workspace, choose their role — Viewer, Editor, or Admin — and manage access over time.
- Organization settingsAdministratorRename your organization, export its data, transfer ownership, configure tenant parameters — and, if it comes to it, delete it.
- Reporting API and integrationsAdministratorRead-only API tokens that connect Power BI, Excel, or Metabase to your workspace data — creation, rotation, and revocation.
- Audit logAdministratorWho did what across your workspace — sign-ins, admin changes, and support access, filterable and reviewable.
- Usage and limitsAdministratorSaaSStorage consumption, plan quotas, and enabled features — what your workspace uses and where its ceilings are.
Community Edition
- Install Orkyo CommunityCommunityAdministratorWhat self-hosting Orkyo takes — requirements, the two supported deployment paths, and where the authoritative install guide lives.
- Operate Orkyo CommunityCommunityAdministratorDay-two operations for self-hosters — backups, upgrades, environment configuration, and the Community admin console.