Skip to main content

Input Box

Shows an input dialog box

Common Properties​

  • Name - The custom name of the node.
  • Color - The custom color of the node.
  • Delay Before (sec) - Waits in seconds before executing the node.
  • Delay After (sec) - Waits in seconds after executing node.
  • Continue On Error - Automation will continue regardless of any error. The default value is false.
info

if ContinueOnError property is true, no error is caught when the project is executed even if Catch node is used.

Input​

  • Title - Title of the input box
  • Text - Default text displayed in the input box

Output​

  • Text - The text entered by the user in the input box

Options​

  • Default Value - Default text that appears in the input box

How It Works​

The Input Box node performs the following steps:

  1. Pauses Execution - Stops the automation flow and waits for user input
  2. Displays Dialog - Shows a modal dialog box with the specified title
  3. Shows Default Text - Displays the default value in the input field (if provided)
  4. Waits for Input - The dialog remains open until the user enters text and clicks OK or Cancel
  5. Captures Response - Retrieves the text entered by the user
  6. Resumes Flow - Returns the entered text and continues automation execution

Requirements​

  • Desktop Environment - Must run in an environment where dialog boxes can be displayed
  • User Interaction - Requires a user to be present to provide input
  • Display Availability - Needs an active display/screen to show the dialog
  • Attended Automation - This is an attended automation node, not suitable for unattended scenarios

Error Handling​

Error CodeDescriptionSolution
DIALOG_CANCELEDUser clicked Cancel or closed the dialogHandle empty or null response in your flow
DISPLAY_NOT_AVAILABLENo display available to show the dialogEnsure automation runs in a desktop environment
DIALOG_TIMEOUTDialog was not responded to within timeout periodIncrease timeout or ensure user responds promptly
INVALID_TITLETitle contains invalid charactersUse plain text for title

Usage Examples​

Example 1: Request Customer Name​

Prompt user to enter a customer name for processing:

Input:
- Title: "Customer Information"
- Text: "Please enter the customer name:"
- Default Value: ""

User enters: "John Smith"
Output:
- Text: "John Smith"

Example 2: Confirm File Path​

Ask user to confirm or modify a file path:

Input:
- Title: "Output File Location"
- Text: "Specify the output file path:"
- Default Value: "C:\Reports\output.xlsx"

User modifies to: "D:\Reports\monthly_output.xlsx"
Output:
- Text: "D:\Reports\monthly_output.xlsx"

Example 3: Get Reference Number​

Request a reference number to start processing:

Input:
- Title: "Transaction Reference"
- Text: "Enter the transaction reference number:"
- Default Value: "TRX-"

User completes to: "TRX-2025-001"
Output:
- Text: "TRX-2025-001"

Usage Notes​

  • Blocking Operation - The automation pauses completely until the user responds to the input box.
  • Cancel Handling - If the user clicks Cancel or closes the dialog, the output may be empty or null.
  • Default Value Purpose - Default values help guide users and reduce typing for common inputs.
  • Single Input Only - This dialog accepts only one text input. For multiple inputs, use multiple Input Box nodes.
  • No Validation - The node doesn't validate input format. Add validation logic after receiving the response.
  • Modal Dialog - The dialog appears on top of other windows and requires user action before continuing.
  • Platform Appearance - Dialog appearance varies by operating system (Windows, macOS, Linux).

Tips​

  • Clear Instructions - Use the Text property to provide clear instructions about what input is expected.
  • Provide Examples - Include example formats in the Text or Default Value to guide users.
  • Validate Input - After receiving input, use conditional logic to validate the format and content.
  • Handle Cancellation - Check if the output is empty or null to detect when users cancel the dialog.
  • Use Descriptive Titles - Title should clearly indicate the purpose of the input request.
  • Pre-fill When Possible - Use Default Value to save users time when you have a good guess for the input.
  • Consider Alternatives - For unattended automation, consider using configuration files or database lookups instead.
  • Error Recovery - If input is invalid, use loops to re-prompt the user until valid input is provided.
  • Message Box - Display information or get Yes/No confirmation from users
    • Log the captured input for debugging and audit trails
    • Validate user input before proceeding
    • Re-prompt user if input validation fails