- Release Notes
- Project compatibility
- Real Time Forms
- Updating form data
- Running forms using JavaScript
- Customizing Forms Using CSS
- Conditional components
- Adding multiple components on the same row in Columns
- Using the Data Table component
- Get File/Folder path
- Reading cell values from a Data Grid component
- Displaying PDF files
- Displaying images in forms
- Scrolling through Data Grids
- Using Dev Tools with forms
- Calculate form component values
- Managing dates in forms
- Opening hyperlinks inside forms
- Displaying a default tab in forms
- Displaying the full label of a component
- Searching long strings in drop-down lists
- About the pre 23.4 Form experience
- Project Compatibility
- Real Time Forms
- Dynamic Checkboxes
- Conditional Dropdowns
- Displaying a Default Tab
- Displaying Images
- Displaying PDF Files
- Displaying the Full Label
- Dynamic HTML Elements
- Managing Dates
- Searching Long Strings in Drop-downs
- Customizing Forms Using Local CSS Files
- Executing Do Block On Checkbox Change
- Customizing Columns Width
- Updating Form Data
- Resetting Collection Data
- Advanced Logic
- Executing Do Block on Dropdown Option Change
- Reading Cell Values From a Data Grid Component
- Conditional Components
- Scrolling Through Data Grid Components
- Using the Grid Component
- Dev Tools
- Calculated Value
- Dynamic Dropdowns
- Switching Tabs With Button Click
- Opening Hyperlinks Inside Form
- Release Notes
- Project Compatibility
- About the Persistence Activities Package
- Bulk Form Designer
- Start Job And Get Reference
- Wait for Job and Resume
- Add Queue Item And Get Reference
- Wait For Queue Item And Resume
- Wait for Form Task and Resume
- Resume After Delay
- Assign Tasks
- Create External Task
- Wait For External Task and Resume
- Complete Task
- Forward Task
- Get Form Tasks
- Get Task Data
- Add Task Comment
- Update Task Labels
- Building Your First Form Action
- Advanced Controls for Drop-downs
- Embedding Objects in Form Actions
- Allowing Users to Upload Files to the Storage Bucket
- Adding Advanced Logic Using Java Script
- Setting a Default Tab
- Removing the Delete button from Edit Grid using custom CSS
- Customizing Edit Grid templates
- Using buttons to trigger custom logic
- Using an External Form Layout
- Sample Workflows
- Release Notes
- About the System Activities Package
- Project Compatibility
- RegEx Builder Wizard
- Is Text Matching
- Find Matching Patterns
- Modify Text
- Modify Date
- Replace Matching Patterns
- Text to Left/Right
- Add Data Column
- Add Data Row
- Build Data Table
- Clear Data Table
- Get Row Item
- Update Row Item
- Merge Data Table
- Output Data Table
- Remove Data Column
- Remove Data Row
- For Each Row in Data Table
- Generate Data Table From Text
- Create List
- Append Item to List
- Read List Item
- Update List Item
- Add Log Fields
- Comment Out / Disabled Activities
- Comment
- Change Type
- Log Message
- Remove Log Fields
- Invoke Com Method
- Format Value
- Lookup Data Table
- Filter Data Table
- Sort Data Table
- Remove Duplicate Rows
- Join Data Tables
- Report Status
- Append Line
- Compress/Zip Files
- Copy File
- Copy Folder
- Create Folder
- Create File
- Delete
- File Exists
- Folder Exists
- Extract/Unzip Files
- Wait for Download
- File Change Trigger
- For Each File in Folder
- For Each Folder in Folder
- Delete File
- Delete Folder
- Move File
- Move Folder
- Rename Folder
- Rename File
- Path Exists
- Read Text File
- Write Text File
- Get File Info
- Get Folder Info
- Get Processes
- Get Username/Password
- Kill Process
- Beep
- Get Environment Folder
- Get Environment Variable
- Invoke Power Shell
- Input Dialog
- Message Box
- Browse for File
- Browse for Folder
- Invoke VBScript
- Process End Trigger
- Process Start Trigger
- File Change Trigger V3
- Trigger Scope
- Repeat Number of Times
- Text to Upper/Lowercase
- Set Environment Variable
- For Each
- Break / Exit Loop
- Retry Scope
- Check True
- Check False
- Workflow Placeholder
- Invoke Workflow File
- Launch Workflow Interactive
- Invoke Code
- Continue / Skip Current
- Multiple Assign
- Invoke Process
- Run Parallel Process
- While
- Do While
- Repeat Number Of Times
- Raise Alert
- Orchestrator HTTP Request
- Get Asset
- Get Credential / Get Orchestrator Credential
- Set Asset
- Set Credential
- Get Jobs
- Get Current Job Info
- Start Job
- Stop Job
- Add Queue Item
- Add Transaction Item
- Delete Queue Items
- Get Queue Items
- Get Transaction Item
- Postpone Transaction Item
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Wait Queue Item
- Bulk Add Queue Items
- Write Storage Text
- Upload Storage File
- List Storage Files
- Read Storage Text
- Download Storage File
- Delete Storage File
- Custom Input
- Append Item to Collection
- Build Collection
- Collection to Data Table
- Exists in Collection
- Filter Collection
- Merge Collections
- Remove From Collection
- Reset Timer
- Resume Timer
- Start Timer
- Stop Timer
- Timeout Scope
- Manual Trigger
- When New Item Added to Queue
- Stop Local Triggers
- Run Local Triggers
- Repeat Trigger
- Time Trigger
- Disable Local Trigger
- Enable Local Trigger
- Notify Global Variable Changed
- Global Variable Changed Trigger
- Extract Text
- Find and Replace
- Return
- Extract Date and Time from Text
- Change Case for Text
- Add or Subtract from Date
- Download file from URL
- Format Date as Text
- Split Text
- Combine text
- AddDataRow
- AddQueueItem
- AddTransactionItem
- AppendLine
- BulkAddQueueItems
- ClearDataTable
- CompressZipFiles
- CopyFile
- CreateFile
- CreateFolder
- DeleteFileOrFolder
- DeleteQueueItems
- DeleteStorageFile
- DownloadStorageFile
- ExtractUnzipFiles
- FilterDataTable
- GetAsset
- GetCredential
- GetJobs
- GetQueueItem
- GetQueueItems
- GetResourceForLocalPath
- GetRowItem
- GetTransactionItem
- InvokeProcess
- JoinDataTables
- ListStorageFiles
- LookUpDataTable
- MergeDataTable
- MoveFile
- OrchestratorHTTPRequest
- OutputDataTable
- PathExists
- PostponeTransactionItem
- ReadStorageText
- ReadTextFile
- RemoveDataColumn
- RemoveDuplicateRows
- Replace
- SetAsset
- SetCredential
- SetTransactionProgress
- SetTransactionStatus
- SortDataTable
- StartJob
- StopJob
- UpdateRowItem
- UploadStorageFile
- WaitQueueItem
- WriteStorageText
- WriteTextFile
- Release Notes
- Project Compatibility
- About the Testing Activities Package
- Project Settings
- Add Test Data Queue Item
- Address
- Attach Document
- Bulk Add Test Data Queue Items
- Delete Test Data Queue Items
- Get Test Data Queue Item
- Get Test Data Queue Items
- Given Name
- Last Name
- Random Date
- Random Number
- Random String
- Random Value
- Verify Control Attribute
- Verify Expression
- Verify Expression With Operator
- Verify Range
- Testing how-to guides
Getting Started With Form Actions
UiPath Form Designer is a customized implementation of the form.io engine that provides a drag-and-drop form builder experience in UiPath Studio.
As an RPA Developer, you use the Form Designer to build form interfaces that are required in an attended or unattended automation. You set the definition, behavior, and validation for every form field.
To interact with the Form Designer, click Open Form Designer inside the Create Form Task activity.
Form Components
A Form component provides you the ability to collect user data.
The UI components are grouped into categories, based on their functionality, as follows:
Form Component Category |
Description |
Form Component |
---|---|---|
Basic |
Contains the most used form fields. |
Text Field Text Area Number Password Checkbox Select Boxes Drop-down List Radio Button |
Advanced |
Contains personal or time-related data. |
HTML Element Content Phone Number Date / Time Day Time Currency Survey |
Layout |
Contains elements that alter the layout of the form. |
Columns Panel Table Tabs |
Data |
Contains grids and containers specialized for harvesting data. |
Container Data Grid Edit Grid |
To create a custom form, drag the desired UI components, drop them to the right side panel, and arrange them to the logic of your use-case.
About form components page to learn more about each form component and how to configure them.
Component Tabs
Once you select a form component, a wizard opens displaying several configuration tabs, to allow further customization for different functionality. Check progress in the preview pane of the wizard.
When you are satisfied with a component design, click Save.
The table below describes the settings available for the common wizard tabs.
Wizard Tab |
Description |
Special Mentions |
---|---|---|
Display |
Configure the way the form component is displayed. |
The name you set in the mandatory Label field is passed as the PropertyName in the Field Key tab. |
Data |
Configure a default value that end users see in the text field. |
Components that may hold multiple items (e.g., Selectboxes, Tab) can be defined here. |
Validation |
Configure validation requirements to enable other UI components. |
|
Field Key |
Configure the component name you want to use further in the workflow. |
By default, this value is passed from the Label field of the Display tab. |
Conditional |
Configure simple conditions for the component. |
|
Logic |
Configure the logic that triggers the conditions. |
Check the About Form Designer controls page to learn more about each wizard tab.
Some form components have specific tabs, for example:
Component |
Wizard Tab |
Description |
---|---|---|
Date / Time |
Date |
Configure the minimum and maximum dates available for selection. |
Time |
Configure the incremental step for hours and minutes. |
|
Day |
Day |
Configure the way the business user selects the day (incremental or from a drop-down list). |
Month |
Configure the way the business user selects the month (incremental or from a drop-down list). |
|
Year |
Configure the way the business user selects the year (incremental or from a drop-down list), and also the minimum and maximum year available for selection. |
|
Edit Grid |
Templates |
Customize the footer of your Edit Grid. |
Managing Form Components
To reopen the configuration wizard, hover over the form component and click Edit.
To rearrange the form components, click
Move and drag the form component to another location inside your form.
To edit the form component using its JSON settings, click Edit JSON. This opens the component JSON, displaying all the available settings.
To copy a component inside the form, click
Copy and then click
Paste below on the same component or on another one.
To remove a component from your form, click Remove.
Managing Forms
The Form Designer ribbon has the following options:
- Save—Saves the form you have designed.
- Save As Template—Enables you to export the form you have designed as a template that can be reused in future automation processes.
- Insert Template—Lets you browse for existing form templates and add them to the current project.
- Clear Form—Deletes all components in the current form.
- Preview—Enters a preview mode that shows you how the form looks like at runtime. This section also enables you to resize the display size of the form, or select a premade theme.