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:
| Step | Purpose | Dependency |
|---|---|---|
| Directors | Create orchestration controllers that manage data processing | None |
| Devices | Add data sources that receive telemetry | Requires at least one Director |
| Targets | Configure data destinations for processed output | Requires at least one Device |
Pipelines & Routes (Required)
These steps define how data flows through your system:
| Step | Purpose | Dependency |
|---|---|---|
| Pipelines | Define transformation and processing rules | None |
| Routes | Connect devices to pipelines and targets | Requires at least one Device AND one Target |
Organization (Optional)
These steps configure team access and settings:
| Step | Purpose |
|---|---|
| Users | Add team members to your organization |
| Organizational Settings | Configure 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
/onboardingURL - Home page menu: Use the collapsible onboarding panel on the Home dashboard, which displays your current progress
Completing Onboarding
Click
The onboarding steps serve as guidance for initial setup. You can return to configure any components at any time through the standard navigation.
Related Documentation
For detailed configuration information, see Directors, Devices, Targets, Pipelines, and Routes.