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

Guided Tours

A guided tour walks you through one setup task on the real screens. The page dims, the control to use is highlighted with an animated arrow, and a card explains the step. You do the real thing, and the tour moves on by itself as you act — when you reach a page, fill in a field, or close a drawer.

Six tours make up the getting-started programme, listed in the order they are meant to be taken:

Tour	What it walks through	Requires permission
Find your way around	What the product does, the side navigation, and the help menu	None
Set up a director	The director create wizard, the install command, and the connection check	Director create
Collect data with a device	Adding a Syslog device	Device create
Deliver data to a target	Adding a Console target	Target create
Shape data with a pipeline	Creating a pipeline and opening the editor	Pipeline create
Connect it with a route	Quick Routes: device → pipeline → target, then save	Quick route create

Tours are gated by permission only. If your role lacks a tour's permission, the list shows no Start button for it, and reads "Your role does not include this. Ask an administrator for access."

The Tour Card

Each step's card shows the tour name with Step n of N, a title, a short explanation, and a highlighted line saying what to do. Depending on the step, the card offers:

• Back — return to the previous step
• Skip step — on optional steps, or when the control cannot be found on the page
• Take me there — jump to the page the step needs
• Next, or Finish on the last step

While a step is highlighted, clicks elsewhere on the page are held back, and the card says so. Two icon buttons sit on the card: Minimize the tour folds it into a small bar in the corner, with Resume to bring it back, so you can look around first; End the tour closes it.

Tour Progress

Progress is saved per user, not per organization. A finished tour shows Completed and offers Replay. A running tour survives a page reload but not signing out.

Tours never start by themselves: onboarding behaves as described on this page until you open one.

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 /onboarding URL. Its only header action is Continue to Home
• Home page menu: The collapsible onboarding panel on the Home page, which carries the progress counter and the Complete Onboarding action

The Guided tours are reached from both, and from anywhere else in the console:

• Guided setup card: On the Onboarding page, a card between the header and the steps reads "Not sure where to start? Let us guide you". Start guided setup starts the first tour you can take and have not finished. After you finish one, the button reads Continue: followed by the next tour's name. Browse all tours opens the tour list. Each incomplete step also gets Show me how beside its own button, disabled in the same cases as that button.
• Scenario cards: Between the guided setup card and the steps, the Or start from a real scenario section offers end-to-end data flows built around Content Hub packs. It asks which SIEM you send to first, then shows a card per scenario with its flow, its length or progress, and Start scenario or Continue. See all scenarios opens the Guided tours panel on the Scenarios tab. See Scenarios.
• Help menu: Select the ? in the header, then Guided tours. This opens a side panel with a tab for each course. The Getting started tab lists the six tours above with your progress (n of 6 tours completed) and Start, Resume, or Replay for each. It is available at any time, not only during onboarding.

Completing Onboarding

Click Complete onboarding in the Home page panel at any point to dismiss onboarding for the whole organization. You do not need to complete all steps first — and there is no equivalent button on the /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.