Skip to main content

Onboarding

After creating your account, the onboarding process guides you through essential setup steps to create a functional data pipeline. Complete these steps to configure your DataStream environment with Directors, Devices, Targets, Pipelines, and Routes.

Who Sees Onboarding

Onboarding appears for users with administrative privileges:

  • Owner role: Users who create an organization account see onboarding on first login
  • Admin role: If the Owner does not complete onboarding, the next Admin user will see it
  • New Tenants: When a new Tenant is created, users with Owner or Admin roles for that Tenant also see onboarding

Once any user with the appropriate role completes the onboarding, it no longer appears for other users in that organization or Tenant.

Onboarding Steps

The onboarding wizard presents seven steps organized into three categories. Five steps are required to complete onboarding; two are optional.

Fleet Setup (Required)

These steps establish your data collection infrastructure:

StepPurposeDependency
DirectorsCreate orchestration controllers that manage data processingNone
DevicesAdd data sources that receive telemetryRequires at least one Director
TargetsConfigure data destinations for processed outputRequires at least one Device

Pipelines & Routes (Required)

These steps define how data flows through your system:

StepPurposeDependency
PipelinesDefine transformation and processing rulesNone
RoutesConnect devices to pipelines and targetsRequires at least one Device AND one Target

Organization (Optional)

These steps configure team access and settings:

StepPurpose
UsersAdd team members to your organization
Organizational SettingsConfigure organization preferences

Progress Tracking

The onboarding interface displays a progress counter showing 5/5 for recommended steps. Optional steps (Users and Organizational Settings) can be configured at any time after onboarding.

Each step shows a completion status:

  • Incomplete: Step requires action
  • Completed: At least one item has been configured for this step

Accessing Onboarding

You can access the onboarding wizard through two methods:

  • Onboarding page: Navigate directly to the /onboarding URL
  • Home page menu: Use the collapsible onboarding panel on the Home dashboard, which displays your current progress

Completing Onboarding

Click Complete onboarding at any point to dismiss the onboarding wizard. You do not need to complete all steps before marking onboarding as complete.

The onboarding steps serve as guidance for initial setup. You can return to configure any components at any time through the standard navigation.

For detailed configuration information, see Directors, Devices, Targets, Pipelines, and Routes.