Developer Docs
Portal Login Get Started

Onboarding Workflow

Current onboarding flow with reference/non-reference hardware paths.

Purpose

The onboarding flow guides teams through profile setup, hardware path selection, and next actions. It also controls which portal areas are available before onboarding is completed.

Entry Points

Entry When used Result
Standard registration/login New team starts in portal first User is redirected into onboarding step flow
/?prov=DEVICE_UUID Device already shows QR code (devkit path) UUID is captured in session and used when adding a device
/prov=DEVICE_UUID Direct provisioning link route Same behavior as query parameter flow

Step-by-Step Flow

  1. Create or join workspace using register, login, or invitation acceptance.
  2. Step 1 - Profile: complete company/evaluation profile fields.
  3. Step 2 - Hardware: choose one hardware path:
    • Reference hardware: continue to Step 3 (reference).
    • Non-reference hardware: continue to Step 3 (non-reference).
  4. Step 3 - Next actions:
    • Reference path: flash demo image in onboarding flasher. Then add/register device (QR path supported).
    • Non-reference path: create hardware integration request, track requests, then complete onboarding.
  5. Complete onboarding to unlock full workspace navigation.

Onboarding Completion Logic

  • Reference path can be completed from the Step 3 reference screen (or after first device registration/provisioning).
  • Non-reference path can be completed from Step 3 once an open hardware integration request exists.
  • The old global onboarding banner in the app header is removed. Completion happens in-step.
  • Account settings include an admin action to reset onboarding progress.

Navigation During Onboarding

  • Unavailable menu items are shown as disabled/greyed out.
  • Devices and Flasher are only clickable on Step 3 reference path; otherwise disabled.
  • After completion, full portal navigation is enabled.

Portal Functions After Login

Area Main function
Dashboard Company workspace summary, status indicators, and next actions
Projects Logical grouping of devices (including evaluation project)
Devices Register hardware UUIDs, inspect device status, provision licenses
Licenses View company licenses, request additional licenses, review project allocations
Flasher Flash supported release images to target hardware (onboarding mode available)
GraphLab Boot Configs Create/manage boot configs, use public/company templates, request integration if needed
Team (admin) Invite members, manage roles, revoke invitations
Account Manage profile/password and inspect user/company data

Role Notes

  • The first user of a newly created company workspace is always admin.
  • The first company user remains protected as admin in team management.
  • Invitations are managed via /team by admin users.

Operational Notes

  • If onboarding seems blocked, verify current step prerequisites (profile, hardware choice, request state).
  • If QR was scanned before login, the pending UUID is kept in session and applied on device registration.
  • For devkits with preinstalled image, onboarding flashing can be skipped and device can be registered directly.
  • Template files for GraphLab Boot Configs use relative filesystem paths (under storage).
← Quickstart Prerequisites →