1. Home
  2. Fields
  3. Command Field

Command Field

The Command Field allows the user to bind a specific command, event, wizard, or generic action to a button.

This can be configured as a command bar action, replicating the same functionality in button form.

It can also change workspaces, directing the user to the workspaces page.

Additionally, it can be configured as any command, event, wizard set at the form level, or other generic action.

If the selected command cannot be executed in the form’s current state, a message will display: “The command/event/wizard cannot be executed in the current state!”

Screenshot of the command field

Command Button Text

Overrides the text on the button that executes the action. This should be a short phrase that clearly states what will happen when the user clicks the button. If this field is left blank, the default button text will be the name of the action.

Action Type

Determines the type of action that will be executed.

  • Command/Event/Wizard: Choose a preconfigured command, event, or wizard. These are the commands, events, and wizards that exist at the form level.
  • Command Bar Action: Choose an action from the command bar. This will duplicate the action in a button form.
Screenshot of the command bar actions in command fields
  • Change Workspace: Brings the user back to the workspaces page to change workspace (if the user has multiple workspaces).
Screenshot of the change workspace command field, opening the change workspace page
  • Generic Action: Choose from other, generic actions.

Command/Event/Wizard

Only applicable when “Action Type” is set to “Command/Event/Wizard”.

This drop down menu displays all the available commands, events, and wizards. The commands, events, and wizards are configured at the form level.

The selected command, event, or wizard will be linked to a button and executed upon clicking.

Command Bar Action

Only applicable when “Action Type” is set to “Command Bar Action”.

This drop down menu displays all the available command bar actions. These are the same actions that are found in the command bar, and the action selected will be duplicated from the command bar.

The selected action will be linked to a button and executed upon clicking.

Note: This type of command button will follow the same visibility rules imposed on the command bar. For example: if implementing a save button and there are no changes to save, the button will not be visible until there are changes to save.

Generic Action

Only applicable when “Action Type” is set to “Generic Action”.

This drop down menu displays all the available generic actions available to replicate.

The selected action will be linked to a button and executed upon clicking.

Updated on August 23, 2024

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for?
Contact Support