Definition and Usage
Displays an input dialog where the user can enter text, and returns the entered content. This command creates an interactive dialog box that can collect single line or multi-line text input from users during workflow execution.
Parameter Values
Input parameters
Parameter | Description | Possible Values | Required | Options / Notes |
Input type | Choose between single and multi-line input | Single line, Multiline | Yes | Determines the type of text field displayed |
Input field label | Enter the label text shown to the left of the input field (within 20 characters) | Text | Yes | Keep label concise and descriptive |
Help text | Provide helper text to guide users when filling out this input field | Text | No | Used to provide additional context or instructions |
Default value | Set a default value to pre-fill the input field | Text | No | Provides a starting point for user input |
Advanced settings
Parameter | Description | Possible Values | Required | Options / Notes |
Dialog title | Enter the text shown at the top of the dialog | Text | No | Helps identify the purpose of the dialog |
Placeholder text | Enter placeholder text to display inside the input field when it's empty | Text | No | Provides visual guidance when the field is empty |
Set this field as required | Check this box to make this field mandatory | Checkbox | No | When checked, prevents submission of empty input |
Error handling
Parameter Name | Description |
Throw error & stop | When an error occurs, the action will trigger an error and stop the execution of the entire app. |
Retry command | If an error occurs, the action will retry the command in an attempt to resolve the issue and continue the process. |
Ignore error & continue | When an error occurs, the action will be ignored, and the workflow will continue without interruption. |
Variables produced
This command produces a variable that stores the input text entered by the user. The variable is named according to what you specify in the "Store result into" parameter.
Using Variables in Conditions
You can use the {x} notation to insert previously defined variables into parameter fields. For example, you could use a variable for the default value or dialog title. This allows for dynamic content in your input dialogs based on previous workflow steps.
When using the output variable in conditions, you can check if the user provided input or left the field empty, allowing your workflow to branch based on user responses.
Notes
The input dialog will pause workflow execution until the user enters text and confirms or cancels the dialog
If "Set this field as required" is enabled, the user must provide input before proceeding
For multi-line input, the dialog provides a larger text area that can accept multiple lines of text with line breaks
Consider using descriptive labels and help text to guide users on what information should be entered
The dialog title helps users understand the context of the input request