Skip to main content
Version: 0.10

Getting-started guide

The console has a built-in guide that takes you from an empty account to your first reviewed scan. It follows the same steps as the Quickstart, points at each button as you go, and keeps track of where you are.

It has five parts:

PartWhereWhat it is for
Welcome screenOver the console, at sign-inWhat is about to happen, and a button to start
ChecklistA panel docked on the rightEvery step and where it stands
Top-bar pillTop bar, every screenProgress at a glance, and the way back to the checklist
Dashboard card and screen promptsDashboards, and the screens each step happens onThe next step, in context
WalkthroughsOver the screen you are onClick-by-click help for one step

When it opens​

The guide opens on its own, once per browser session, when either:

  • your account is flagged to see it, which is the case for a new account, or
  • you can create tenants and your Organization has no tenant yet.

If you close it, it waits until your next session. If you hide it, or finish every step, it stops opening at sign-in.

The guide is about one tenant: the one you are working in, or, from System management with no tenant chosen yet, the first tenant you can see.

Welcome screen​

The welcome screen lists the steps, ticks off any already done, and estimates the time left, at a few minutes per step. It offers three ways on:

  • Start the walkthrough (or Continue the walkthrough if you have started): begins the walkthrough for the next step.
  • See the checklist: opens the checklist.
  • I'll explore on my own: closes it.

If your role in the tenant lets you look but not set anything up, you see a Where to look panel instead, with buttons to Dashboard, Endpoints, Scan history and Reports.

The checklist​

The checklist, titled Your first scan, step by step, shows the steps as a timeline with a progress ring. The next step is opened up with a sentence on why it matters and two buttons: Show me how, which starts a walkthrough, and a button that goes straight to the screen and opens its form for you.

StepButtonDone when
Create a tenantCreate tenantYou can see at least one tenant
Add a sensorAdd sensorThe tenant has at least one sensor that has enrolled
Connect an integrationBrowse integrationsThe tenant has at least one connected integration (one saved only as a draft by a connection test does not count)
Create a scan templateNew scan templateThe tenant has at least one scan template
Schedule it (optional)New scheduleThe tenant has at least one schedule
Run a scanGo to scan templatesThe tenant has at least one run
Review the scanOpen scan historyYou have opened a completed run's page in this browser (for an account that has already been through the guide, a completed run is enough)

Progress is worked out from the tenant's own data, never ticked by hand. A step counts as done whoever did it and from wherever, so the guide stays right when a colleague adds the sensor or you do things out of order. The optional schedule does not count towards the total, and the tenant step is left out for users who cannot create tenants, so they see six steps rather than seven.

Each step shows where it stands:

StateMeaning
DoneThe tenant's data says it is done
NextThe first step still to take, and you can take it
WaitingTaken, and waiting on something: the scan is still running
Needs attentionTaken, and stuck until someone acts: the last scan failed, or it is waiting for changes to be reviewed or approved
LockedAn earlier step has to be done first
Not available to youYour role in the tenant does not cover it. Ask an administrator

The guide never offers a button for an action your role would be refused. If your role cannot even read what a step depends on (the tenant's sensors, say), that step is shown as not available and does not hold up the steps after it.

For Run a scan, the guide warns you when no sensor is enabled and healthy, because a run would then wait for one. For Review the scan, the button follows the latest run: Follow the scan while it runs, Open the failed scan if it failed, Review the changes if it needs review or approval, and Open the finished scan once it completes.

When every required step is done the checklist reads You're all set and offers the same shortcuts as the Where to look panel.

Top-bar pill, dashboard card and screen prompts​

While setup is unfinished, three smaller prompts keep the next step in view:

  • Top-bar pill: Setup 3 of 6 (for example) with a ring that fills as steps are done. Click it to open the checklist. It stays until setup is finished, even after you hide the guide, and is not shown to users whose role only lets them look.
  • Dashboard card: a Getting started card at the top of Dashboards, naming the next step with Show me how, All steps and Hide.
  • Screen prompts: on the screen of a step (Tenants, Sensors, Integrations, Templates, Scheduled, History), a strip says what has just happened and what comes next, for example "Sensor added. Next: connect an integration.", or what the screen is still waiting for. It has All steps, a button for the next step and Show me how.

Walkthroughs​

Show me how starts a walkthrough for one step. It highlights the next thing to click, explains it in a card, and moves on when you have done it. Where a step depends on the platform (the sensor connecting, the tenant being created), the card says it is waiting and continues by itself when that happens.

The card shows the step's position (for example "Add a sensor · step 3 of 6") and offers Next where there is nothing to click, Back, and Skip tour. If the element it points at is not on screen, it offers Take me there. When a walkthrough finishes, it names the next step with Show me how, or See all steps.

Hiding and reopening the guide​

ActionEffect
Close the checklist (× or Escape) or the welcome screenNot now. The guide can open itself again next session
Hide the guide (checklist) or Hide (dashboard card)The dashboard card and screen prompts are hidden for this tenant in this browser, and the guide no longer opens at sign-in
Finish every required stepThe guide no longer opens at sign-in

You can always reopen the checklist from:

  • the Setup pill in the top bar, while setup is unfinished,
  • your user menu (top right) → Getting started,
  • the command palette (Ctrl+K or ⌘+K) → Getting started.
Some of it is remembered per browser

That you hid the guide, and that you opened a finished run, are kept in your browser for each user and tenant. In a new browser the dashboard card can reappear; hide it again there. Whether the guide opens at sign-in is kept on your account, so it follows you everywhere.