Wizard commands

Wizard commands are advanced commands designed to control the flow and behavior of a wizard during its execution. These commands let you control the wizard's steps, get data, show messages, and handle errors. Using wizard commands improves your automation workflows and gives you better control.

Before you begin:

See the table below for an overview of each command and its functions. For more details on how to set up each command, check the individual command documentation.

Command Description

Check application

Check whether the current wizard is run from Nintex Robot or Nintex Studio.

Check run mode

Check whether the current wizard is run in Do it or Guide me mode.

Check video recording mode

Check whether the current wizard is recorded with Nintex's built-in recording feature.

Continue wizard

Exit the current group of commands, the logical flow, or the step section, and continue playing the wizard.

End wizard

End the wizard immediately.

Get last failure type

Retrieve the type of the last failure handled and store it in a variable, useful in conjunction with global error handling features.

Get step data

Retrieve the number or name of the current step and store the result in a variable.

Get user data

Retrieve the Username, User ID, or Language of the user running the current wizard and store the result in a variable.

Get wizard data

Retrieve the ID or name of the current wizard and store the result in a variable.

Go to step

Move immediately to the step you specify.

Raise wizard error

Display a custom wizard error message.

Resume error

Resume default error handling procedures after performing custom fallback procedures.

Set user interrupt mode

Select whether to pause a wizard when the end user interacts with the keyboard or mouse during its execution.

Show message

Display a custom message or request basic input while the wizard is running.