Use instance tours

When Knowledge Base is enabled in Constructor, Instance tours lets you create step-by-step UI scenarios, store them on the instance, and launch them from articles or via a direct link.

When you need this

  • Walk a colleague through a new workflow in the UI without a long text-only guide.
  • Update tour steps after menu or settings change on your instance.
  • Add a Launch tour button next to instructions in a knowledge base article.

Before you start

  • Knowledge base must appear in the menu; from the document list use Tours.
  • Create and edit tours require Manage instance UI tours under Settings → Roles, or root; you can grant edit roles on a specific tour.
  • New tours are not public by default — assign read roles if others should launch the tour.
  • If you do not see Knowledge Base, ask an administrator to enable Instance Docs under Settings → Configure instance (feature flags). See Configure instance settings.

Open the tour list

  1. Open Knowledge Base.
  2. Click Tours in the top bar — Instance tours opens.
  3. Use search, status (draft / ready), or archive filters (active / archived / all).

Create or edit a tour

  1. Click New tour (if your role allows).
  2. Set Tour ID (Latin identifier) and title.
  3. In the YAML field define steps, routes, and step targets in the interface — same shape as platform product tours.
  4. Click Validate YAML — errors or step count appear.
  5. Click Save. Ready status allows launch; Draft blocks launch from the card.

Import: Import YAML — choose a .yaml / .tour.yaml file.
Export: row action Export YAML for backup or migration (per your organization policy).

Archive a tour

Use Archive in the tour actions — it leaves the active list but stays under Archived. Restore from archive brings it back.

Embed a tour in a knowledge base article

  1. Open Edit on a document in Knowledge Base.
  2. Click Insert tour in the editor toolbar.
  3. Pick a tour — the editor adds [[tour:your-tour-id|Button label]].
  4. Save. Preview shows a card with Launch tour.

If the tour is missing, a draft, or no access — the card shows the matching status instead of an active button.

Launch a tour

  • From an article — click Launch tour on the embed card.
  • From the tour list — open the row or Open tour for ready tours with link launch enabled.

Step-by-step guidance runs in Constructor (same runtime as AI Assistant link tours).