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 workspaceAccept an invitation, agree to the Terms of Service, and get into your workspace during early access.
- 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 work onto your resources, review 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.
- StationsResources that stand still — machines, cells and benches — placed on a floorplan and booked by name.
- AssetsResources that move — people, tools and vehicles — planned by availability rather than by location.
- OrganizationDepartments, job titles and the other shared reference data your workspace keeps about its own structure.
- The floorplanOne plan per site, holding every station that stands on it — drawn, placed, moved and booked.
- Insights and KPIsThe analytics dashboard — KPI cards, utilization and conflict trends, request-status history, and the bottlenecks and critical path that constrain the plan.
- Your own resource typesWhen the catalog has nothing for what you schedule — define the type yourself and it works like every other.
- 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.
- See your schedule in OutlookSubscribe to your Orkyo schedule from Outlook, Google Calendar or Apple Calendar with a live feed that keeps itself up to date.
- AI assistantAsk about your schedule, get help with conflicts, let the assistant open the right page, and keep your conversations.
- Criteria and capabilitiesDefine the reusable, typed attributes that drive capability matching — data types, units, enums, and applicability.
- Resource typesDefine the kinds of resource your workspace schedules — machines, people, tools, and anything else you run.
- Type catalogSwitch on the kinds of resource your shop runs — mills, lathes, stations, people, tools — or hide and delete the ones you do not.
- Request templatesReusable blueprints for common request patterns — duration, timing constraints, and pre-set criteria in one definition.
- List definitionsThe reference data your shop keeps beside the schedule — departments, maintenance logs, part catalogs — as lists you define.
- PresetsMove a whole workspace configuration — criteria, groups, and templates — between workspaces as validated preset files.
- RoutingsA part's sequence of operations, defined once and instantiated per work order with setup time plus run time × quantity.
- 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.
- Dependencies and the critical pathHow to make one request wait for another, which predecessors it waits for, what a lag does, and how Orkyo computes the finish date.
Administration
- Managing sitesAdministratorCreate and maintain physical sites — the containers for stations 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 workspace 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.
- AI assistant administrationAdd your Anthropic API key, grant people access to the assistant, and set the token and daily interaction limits.
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.