> ## 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.

# IT Onboarding

> IT onboarding queue for managing IT provisioning workflows for new employees — browse, filter, and view individual onboarding instance details.

The IT Onboarding page (`/it/onboarding`) is the IT department's queue for managing onboarding provisioning instances — one per new employee. It shows status, priority, target date, SLA status, and task progress for each onboarding workflow.

## Overview

The page queries `useOnboardingInstances` with `workflow_type: 'onboarding'` and optional `status` / `priority` filters. A client-side search filters by employee name or template name. Each row shows employee name, template, status badge, priority badge, target date, `OnboardingSLAIndicator`, and compact `OnboardingProgressCard`. A **Manage Templates** link navigates to `/it/jml/templates`.

**Status options**: `pending`, `in_progress`, `completed`, `cancelled`.\
**Priority options**: `low`, `normal`, `high`, `urgent`.

## Who it's for

No explicit secondary permission gate beyond the outer `ITViewGuard` (`it.view`). Managing onboarding requires `it.onboarding.manage`.

## Before you start

* Provisioning templates must exist at `/it/jml/templates` before workflows can be created.
* Confirm your role includes IT onboarding management permissions.

## Steps

<Steps>
  <Step title="Open the IT Onboarding queue">
    Navigate to `/it/onboarding`.
  </Step>

  <Step title="Filter the queue">
    Use the search box to find a specific employee or template. Use the Status and Priority dropdowns to narrow results.
  </Step>

  <Step title="Review SLA and progress">
    The SLA Status column indicates whether a workflow is on track or overdue relative to its target date. The Progress column shows task completion.
  </Step>

  <Step title="Start a pending workflow">
    Click the Play icon on a pending row to begin the provisioning workflow.
  </Step>

  <Step title="Open an onboarding instance">
    Click the eye icon to navigate to `/it/onboarding/:id` for full workflow details.
  </Step>

  <Step title="Manage templates">
    Click **Manage Templates** to navigate to the provisioning templates page at `/it/jml/templates`.
  </Step>
</Steps>

## Key concepts

| Concept                  | Description                                                            |
| ------------------------ | ---------------------------------------------------------------------- |
| `ITOnboardingInstance`   | Represents one provisioning run for a specific employee                |
| `OnboardingSLAIndicator` | Shows green/amber/red based on target date vs. current date and status |
| `OnboardingProgressCard` | Compact checklist progress view                                        |
| Provisioning templates   | Define the set of tasks that make up an onboarding workflow            |

## Viewing an onboarding instance

The Onboarding Details page (`/it/onboarding/:id`) shows employee information (name, work email, job title, assignee), a task checklist for all onboarding tasks, a notes section, and a sidebar with progress and SLA indicators. Quick links navigate to the employee's IT profile (access accounts) at `/it/employees/:employee_id/it-profile` and the asset assignment page at `/it/assets`.

Permission required: `IT_PERMISSIONS.VIEW` (`it.view`) via the module-level `ITViewGuard`. No additional per-route gate.

Before you start: the onboarding instance must already exist (created from the Onboarding dashboard); the provisioning template should have been selected when the instance was created.

1. Navigate to **IT > Onboarding** and click an employee's onboarding row, or navigate directly to `/it/onboarding/:id`.
2. Review the **Employee Information** card to confirm the correct employee and assignee.
3. Work through the **Task Checklist**, completing required tasks in order.
4. Use the sidebar **Progress** card to track overall completion.
5. Monitor **SLA Status** — the indicator compares the current date against the target date.
6. Add notes and click **Save Notes** as needed.
7. When all required tasks are complete, click **Mark Complete**.

**Key concepts:**

* **task\_instances** — individual task records associated with this onboarding instance, loaded from `useOnboardingTaskInstances`.
* **SLA status** — driven by `OnboardingSLAIndicator` comparing the current date to `target_date`.

## Related

<Columns cols={2}>
  <Card title="IT Service Management" icon="headset" href="/it/overview">
    IT Service Management overview.
  </Card>

  <Card title="Governance & parity" icon="scale-balanced" href="/governance/index" />
</Columns>

<Note>
  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.
</Note>

<Accordion title="Documentation sources">
  * src/routes/it.tsx
  * src/cores/it/pages/onboarding/OnboardingDashboardPage.tsx
  * src/cores/it/pages/onboarding/OnboardingInstanceDetailPage.tsx
  * src/cores/it/hooks/useOnboardingInstances.ts
  * src/cores/it/hooks/useOnboardingTaskInstances.ts
  * src/cores/it/types/onboarding.ts
</Accordion>
