Free cookie consent management tool by TermsFeed

Wizard Step

On This Page

About the wizard step

Displays the components and layouts of a single wizard step within the Wizard Layout.

wizard-step-example

Where to use the wizard step

Use a!wizardStep() in the steps parameter of a!wizardLayout().

Supported components

The contents parameter of a!wizardStep() supports any component or layout, except:

  • Top-level layouts, such as a!formLayout(), a!wizardLayout(), a!paneLayout(), and a!headerContentLayout().
  • Components that are designed for use in a specific parameter of another component, such as a!sideBySideItem() and a!sidebarTemplate().

Parameters

a!wizardStep( label, instructions, contents, showWhen, disableNextButton, validations, validationGroup )

Name Keyword Types Description

Label

label

Text

Text to display as the heading for the wizard step. If using a milestone style for the wizard step indicator, the step label also displays as the step name in the milestone.

Instructions

instructions

Text

Optional text to display below the heading for the wizard step.

Contents

contents

Any Type

Components and layouts to display in the wizard step.

Show When

showWhen

Boolean

Determines whether the step is visible in the wizard. When set to false, the step is hidden. Default: true.

Disable next button

disableNextButton

Boolean

Determines if the user is prevented from selecting the Next button. Default: false.

Validations

validations

List of Variant

Validation errors displayed above the buttons when the value is not null. Configured using a text array or an array with a mix of text and Validation Message using a!validationMessage(message, validateAfter).

Validation Group

validationGroup

Text

The keyword used to identify the validation group for the wizard step's validations parameter. When this parameter is specified, the validations parameter is only evaluated when a button that uses the same validation group is selected. This value cannot contain spaces. See the following recipes for more information:

Using the wizard step

The following section covers important details about the wizard step.

Async loading placeholder

If this component relies on an async variable, a placeholder will be displayed until the async data is finished loading. See a!asyncVariable() for more information on how the placeholder behavior works.

Example

The following example demonstrates the wizard step component.

To experiment with the example, copy and paste the expression into an interface object.

Simple wizard step

wizard_step_example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
a!wizardLayout(
  titleBar: a!headerTemplateFull(
    title: "Wizard",
    secondaryText: "This is an example of a wizard layout"
  ),
  steps: {
    /* Wizard steps must be used in the steps parameter of a wizard layout */
    a!wizardStep(
      label: "Name",
      instructions: "Enter your first and last name",
      contents: {
        a!columnsLayout(
          columns: {
            a!columnLayout(
              contents: {
                a!textField(
                  label: "First Name",
                  required: true
                )
              }
            ),
            a!columnLayout(
              contents: {
                a!textField(
                  label: "Last Name",
                  required: true
                )
              }
            )
          }
        )
      }
    ),
    a!wizardStep(
      label: "Step 2",
      contents: {}
    ),
    a!wizardStep(
      label: "Step 3",
      contents: {}
    )
  },
  primaryButtons: {
    a!buttonWidget(
      label: "Submit",
      showWhen: fv!isLastStep,
      submit: true,
      loadingIndicator: true,
      style: "SOLID"
    )
  },
  secondaryButtons: {
    a!buttonWidget(
      label: "Cancel",
      value: true,
      saveInto: {},
      validate: false,
      submit: true,
      style: "LINK"
    )
  }
)

Feature compatibility

The table below lists this component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Interfaces Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

Process Autoscaling Incompatible

Cannot be used in autoscaled processes.

Event Consumer Filter Conditions Compatible

Can be used in filter conditions.

Event Consumer Event Handlers Compatible

Can be used in event handler expressions.

The following recipes include usage of the Wizard Step.

Feedback