Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Creating a Service Catalog Wizard

Service Catalog wizards help you to create wizard like, multi-step experiences.

Before you begin

Service Catalog wizards are especially useful when the input required is huge and complex since the wizard offers a step-by-step experience for the requester and also provides a side panel to provide contextual help. A visa application is a good example where Service Catalog wizards could be used as the data needs to be presented in steps such as Personal details, Education details, and so on.

Pre-requisites for creating Service Catalog wizards:

  • Ensure that you have either a composite record producer, or a record producer set up. For more information, see Create a record producer.
  • The Save options field must have the value Save in destination in the composite record producer or record producer to enable the wizard to create records.
  • The Allow edit option should be selected on the composite record producer or record producer form so that records are editable in the wizard.

Role required: wizard_admin, or admin

About this task

The Service Catalog Wizard is available as a component in UI Builder (UIB). You can use it to create guided experiences backed by composite record producers or record producers. You can create multi-step wizard experiences using Service Catalog Wizard.

Service Catalog Wizards are used in these modes:

  • Normal mode: To create records in the table configured in the record producer, or the composite record producer associated with the wizard.
  • Template mode: To create a template where admins can predefine some data and provide guardrails to fine-tune and personalize the creation of records.

Procedure

  1. Navigate to Service Catalog Wizards > Maintain Wizards, and click New to create a new wizard.

  2. On the form, fill in the fields.

FieldDescription
NameName of the wizard.
TypeThe wizard uses a composite record producer, or record producer.
ProducerReference of the composite record producer, or record producer.
Has feedback panelOption to specify if the wizard has a feedback panel.
Layout[Stacked/Tabbed]The rendering of wizard steps can be either stacked or tabbed layout mode.
TitleTitle of the wizard. Note: The title can also dynamically refer to the composite record producer, or record producer variables using ${variable} syntax.
Enable SaveAuto-save the wizard on each step change.
Show review stepThe Review and submit step is displayed to summarize the wizard steps, and field values.
Show Submit on last stepIf true, the Submit button is displayed in the last step.
Review step labelLabel of the Review and submit step.
For more information on fields, steps, sections, or questions on Service Catalog wizard, see the following:

-   [Add step, section, or question to catalog item wizard](configure-the-catalog-builder-experience.md)
-   [Catalog Wizard form](service-catalog-wizard-forms-field.md)
Image omitted: wiztemplate\_callouts.png
Catalog Wizard form.
After you set up the field values, the resulting wizard with the steps, layout, labels, and other elements appear as follows:
  1. Set up the Catalog Wizard component properties using the UI Builder (UIB) components, for more information see Customize UI Builder pages using components.
Image omitted: uib-wizardconfig.png
Service Catalog Wizard component configuration in UI Builder
1.  **Select Wizard**: Select the wizard that you're creating the experience for \(you can choose the wizard you created in the previous step\).
2.  **Wizard mode**: Select the mode for this experience.
3.  **Field space**: Specify the spacing that should appear between fields in the wizard. The possible values are **Small**, **Medium**, **Large**, and **Extra Large**.
4.  **Sys\_id of the record**: In Normal mode, the sys\_id of the record being edited or created by the wizard. In Template mode, the sys\_id of the template that is being edited.
5.  **Select template**: Select the template that must be applied to the wizard. The **Select Template** option is applicable only in Normal mode.
6.  **Make template mandatory**: If **true**, providing a template is mandatory for creating records, and is applicable only in Normal mode.
7.  **Home button icon**: Select an icon that appears in place of the Home button icon.
8.  **Hide home button**: If **true**, the **Home** button is hidden in the wizard.
9.  **Hide step navigator Back button**: If **true**, hides the **Back** button in the footer of the wizard.
10. **Hide step navigator Forward button**: If **true**, hides the **Forward** or **Continue** button in the footer of the wizard.
11. **Step navigator forward button type**: Specify the button type for the **Forward** button in the wizard footer. The possible values are **Primary** or **Secondary**.
For more information, see [Next Experience Components](https://developer.servicenow.com/dev.do#!/reference/next-experience/components?&query=&order_by=nameAsc&limit=120&offset=0&categories[]=uib_component&categories[]=uib_macroponent-component&categories[]=uib_facades) in the developer documentation site.

Parent Topic:Service Catalog