GetUserInput Activity

Purpose: This activity prompts the end user for input during workflow execution. It shows a popup/form to the user running the workflow to get their input. The workflow will pause execution until the user provides input or cancels the dialog.

Input Properties

Prompt Message

The prompt message to show to the user.

Type: string

Default: "Please enter a value:"

Dialog Title

The title of the input dialog.

Type: string

Default: "User Input Required"

Input Type

The type of input expected. Valid values:

  • text - Text input (default)
  • number - Numeric input
  • file - File selection dialog
  • folder - Folder selection dialog
  • yesno - Yes/No boolean input

Type: string

Default: "text"

Default Value

Default value to show in the input field.

Type: string

Default: "" (empty string)

Required

Whether the input is required (user must provide a value).

Type: bool

Default: true

File Filter

File filter for file input type (e.g., 'Excel Files|*.xlsx;*.xls'). Only applies when Input Type is "file".

Type: string

Default: "All Files|*.*"

Output Properties

User Input

The value entered by the user.

Type: string

Note: Will be empty if user cancelled or if validation failed.

User Responded

Whether the user provided input (true) or cancelled (false).

Type: bool

Error Message

Error message if input validation failed. Empty string if no error occurred.

Type: string

Usage Example

Scenario: Get a file path from the user

Configuration:
- Prompt Message: "Please select the file to process:"
- Dialog Title: "File Selection"
- Input Type: "file"
- File Filter: "Excel Files|*.xlsx;*.xls|All Files|*.*"
- Required: true

Result:
- UserInput: Contains the selected file path
- UserResponded: true if user selected a file, false if cancelled
- ErrorMessage: Empty if successful, contains error if validation failed

Important Notes

  • This activity will pause workflow execution until the user provides input or cancels
  • Use the Required property to enforce mandatory input
  • File and folder inputs allow users to browse and select from their system
  • For yesno input type, the user can enter "yes"/"y" or "no"/"n"
  • If the user cancels, UserResponded will be false and UserInput will be empty
  • Validation errors are returned in the ErrorMessage output