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 is not gated on a role. Whether it appears depends only on the organization's onboarding status, so every user of an organization that has not completed it sees it, whatever their role.
The status is per organization: once anyone marks it complete, or the five recommended steps are all satisfied, it stops appearing for everyone in that organization.
Users of a subtenant never see it. A delegated user's onboarding status is set to complete when the subtenant is created, so onboarding is skipped there even when the parent organization has not finished its own.
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 progress counter — Platform setup completion, reading n/5 of recommended steps — is part of the onboarding panel on the Home page, not of the /onboarding page. Optional steps (Users and Organizational Settings) are outside the count and can be configured at any time.
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. Its only header action isContinue to Home - Home page menu: The collapsible onboarding panel on the Home page, which carries the progress counter and the
Complete Onboarding action
Completing Onboarding
Click /onboarding page itself.
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.