Skip to main content
Version: Latest
User ManualNeed configuration, code or deployment details? In the Technical Manual: Wizard (Stepper) Feature

Guide Visitors Through a Wizard

A wizard shows a form one step at a time, with a progress bar, remembers the answers between steps, and creates content items from them at the end. Use it for event or workshop registrations, customer onboarding, surveys and any form that is too long to show at once.

MenuDesign > Content Definition > Content Types (setup); Content > Content Items (building the steps)
PermissionEdit content types (setup); the usual permission to create the content item (building the steps); Start a wizard and Continue a wizard (for the people who take part)
FeatureWizard
Can't find it?

What you see depends on your role. If the menu, a button or a setting on this page is missing, ask your administrator to give you the permission listed above or to turn on the feature. Only administrators can turn features on and change site settings.

How a wizard is made​

  • Each step is an ordinary content type with its own boxes, for example Visitor Details with Full name and Email.
  • A wizard is a content item of a type that has the Wizard part. It holds the steps as cards, in order.
  • Visitors take part on the site's public wizard page, which opens on the first step. Ask your technical team for the link to put on a page or a button.

Prepare a wizard type​

  1. Create the content types for the steps, for example Visitor Details and Visit Preferences, with the boxes each step asks for.
  2. Open Design > Content Definition > Content Types and edit the type that will host the wizard, for example Workshop Registration.
  3. Click Add Parts, and click Add & Configure next to Wizard.
  4. Set the options below and click Save.
FieldWhat it does
Contained content typesThe kinds of step this wizard can have. Choose Content types and tick them, or choose Stereotype to allow every content type with a stereotype you type.
Display typeHow the steps are shown when the wizard item itself is displayed. The default is Summary.
Collapse contained stepsShows the steps collapsed when you edit the wizard.
Requires an authenticated userVisitors must be signed in to start. It is off for a new wizard.
Completion policyWhat happens to the answers when the wizard is finished: Create and publish the collected content items (the default), Create the collected content items as drafts, or Do not persist the collected content items.

Build the steps​

  1. Open Content > Content Items, click New and choose the wizard type.
  2. Enter the Title.
  3. Click Add step and choose a step type. Repeat for each step. Each step card has its own boxes, which can start with a default value.
  4. Drag a card by its handle to change the order. The order of the cards is the order of the steps.
  5. Click Publish.

What a visitor sees​

The wizard opens on the first step. A progress bar at the top shows every step and where the visitor is. Next saves the step and moves on, a finished step is marked with a tick, and Previous goes back without losing answers. On the last step the button reads Finish, and a confirmation tells the visitor the submission was completed.

See what was collected​

With the default Completion policy, each step's answers become a published content item of the step's type. Open Content > Content Items to find them, and edit or publish them like any other item.

note

The progress bar names each step after its content type. Give the step types names that make sense to visitors.