Wizard Step

On This Page

Function

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

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

Parameters

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: Configure Buttons with Conditional Requiredness Validation Groups for Buttons with Multiple Validation Rules'

Usage considerations

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.

Examples

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

Simple wizard step

This example is intended to be used within a a!wizardLayout() function.

a!wizardStep(
  label: "Name",
  instructions: "",
  contents: {
     a!columnsLayout(
      columns: {
        a!columnLayout(
          contents: {
            a!textField(
              label: "First Name",
              labelPosition: "ABOVE",
              saveInto: {},
              refreshAfter: "UNFOCUS",
              validations: {}
            )
          }
        ),
        a!columnLayout(
          contents: {
            a!textField(
              label: "Last Name",
              labelPosition: "ABOVE",
              saveInto: {},
              refreshAfter: "UNFOCUS",
              validations: {}
            )
          }
        )
      }
    )
  }
)

Feature compatibility

The table below lists this component's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	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.

The following recipes include usage of the Wizard Step.

Upload Multiple Documents and Edit Document Properties (Document Management, Records):
Build a form that allows users to create a record and upload related documents. Users can edit the document name and add a document description before submitting the form.

Feedback

Was this page helpful?