Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The Onboarding Wizard is a multi-step guided form for creating a new employee record and is available at /hr/onboarding/wizard (new instance) or /hr/onboarding/wizard/:instanceId (resume an existing instance). Alternative route: /hr/onboarding/wizard/:instanceId — resumes an existing wizard instance. See Overview below.

​
Overview

The Onboarding Wizard (OnboardingWizardPage, PF-41 / HR-UX-01) renders a configurable or hardcoded multi-step wizard for new-hire intake. On completion it creates the employee record via useEmployeeMutation, triggers IT onboarding integration via useITOnboardingIntegration, and sends welcome and manager notifications via useOnboardingNotifications. The route /hr/onboarding/wizard starts a new instance; /hr/onboarding/wizard/:instanceId resumes an existing wizard instance. Wizard mode (useWizardMode) determines whether steps are loaded from configuration or from a hardcoded sequence.

​
Who it’s for

No explicit permission gate on this route.

​
Before you start

  • A platform profile (profile_id) must exist for the new hire before starting the wizard.
  • Have the following information ready: employment type, hire date, job title, employee number, manager, work email, work phone, work location, and emergency contact details.

​
Steps

  1. Navigate to /hr/onboarding/wizard to start a new onboarding.
  2. Follow each wizard step, providing the required information.
  3. At the profile selection step, choose the existing profile for the new hire.
  4. Complete remaining steps (employment details, role, manager assignment, etc.).
  5. Submit the wizard; the employee record is created, IT access is requested, and notifications are sent.
  6. You will be redirected upon completion.

​
Key concepts

  • Wizard Instance — A saved state of a partially completed onboarding wizard, resumable via its instanceId.
  • IT Onboarding Integration — An automated step that creates system access requests in the IT module when the wizard completes.
  • Welcome Notification — A notification sent to the new employee on wizard completion.

Human Resources

Human Resources core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/hr.tsx
  • src/cores/hr/pages/OnboardingWizardPage.tsx
  • src/cores/hr/hooks/employees/useEmployeeMutation.ts
  • src/cores/hr/hooks/onboarding/useITOnboardingIntegration.ts
  • src/cores/hr/hooks/onboarding/useOnboardingNotifications.ts