- Overview
- Callout
- Complex Scenarios
- Credentials
- Data Service
- Form
- 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
- FTP
- IPC
- Persistence
- Release notes
- Project compatibility
- About the Persistence activity 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
- Get App Tasks
- Add Task Comment
- Update Task Labels
- Create App Task
- Wait For App Task And Resume
- Configure task timer
- Working with App tasks
- 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
- Dynamically expanding form components at runtime
- Aligning the content of a form component from left to right using JSON attributes
- Sample Workflows
- Automation Ops Pipelines
- System
- Release notes
- About the System activity package
- Project compatibility
- Supported character encoding
- RegEx Builder Wizard
- Add Data Column
- Add Data Row
- Add Log Fields
- Add or Subtract from Date
- Add Transaction Item
- Add Queue Item
- Append Item to Collection
- Append Item to List
- Append Line
- Beep
- Break / Exit Loop
- Browse for File
- Browse for Folder
- Build Collection
- Build Data Table
- Bulk Add Queue Items
- Change Case for Text
- Change Type
- Check False
- Check True
- Clear Data Table
- Collection to Data Table
- Comment
- Compress/Zip Files
- Copy File
- Copy Folder
- Combine text
- Comment Out / Disabled Activities
- Continue / Skip Current
- Create File
- Create Folder
- Create List
- Custom Input
- Delete
- Delete File
- Delete Folder
- Delete Storage File
- Delete Queue Items
- Disable Local Trigger
- Do While
- Download file from URL
- Download Storage File
- Enable Local Trigger
- Evaluate Business Rule
- Exists in Collection
- Extract/Unzip Files
- Extract Date and Time from Text
- Extract Text
- File Change Trigger
- File Exists
- Filter Collection
- Filter Data Table
- Folder Exists
- For Each
- For Each File in Folder
- File Change Trigger V3
- Find and Replace
- Find Matching Patterns
- For Each Folder in Folder
- For Each Row in Data Table
- Format Date as Text
- Format Value
- Generate Data Table From Text
- Get Asset
- Get Credential / Get Orchestrator Credential
- Get Current Job Info
- Get Environment Folder
- Get Environment Variable
- Get File Info
- Get Folder Info
- Get Jobs
- Get Processes
- Get Row Item
- Get Transaction Item
- Get Username/Password
- Get Queue Items
- Global Variable Changed Trigger
- Input Dialog
- Invoke Code
- Invoke Com Method
- Invoke Power Shell
- Invoke Process
- Invoke VBScript
- Invoke Workflow File
- Is Text Matching
- Join Data Tables
- Kill Process
- Launch Workflow Interactive
- List Storage Files
- Log Message
- Lookup Data Table
- Manual Trigger
- Merge Collections
- Merge Data Table
- Message Box
- Modify Date
- Modify Text
- Move File
- Move Folder
- Multiple Assign
- New Item Added to Queue
- Notify Global Variable Changed
- Orchestrator HTTP Request
- Output Data Table
- Path Exists
- Postpone Transaction Item
- Process End Trigger
- Process Start Trigger
- Raise Alert
- Read List Item
- Read Text File
- Read Storage Text
- Remove Data Column
- Remove Data Row
- Remove Duplicate Rows
- Remove From Collection
- Remove Log Fields
- Replace Matching Patterns
- Repeat Number of Times
- Repeat Trigger
- Rename File
- Rename Folder
- Report Status
- Reset Timer
- Resume Timer
- Retry Scope
- Return
- Run Local Triggers
- Run Parallel Process
- Set Asset
- Set Credential
- Set Environment Variable
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Split Text
- Sort Data Table
- Start Timer
- Start Job
- Stop Job
- Stop Local Triggers
- Stop Timer
- Text to Left/Right
- Text to Upper/Lowercase
- Time Trigger
- Trigger Scope
- Timeout Scope
- Update Row Item
- Update List Item
- Upload Storage File
- Wait for Download
- Wait Queue Item
- While
- Workflow Placeholder
- Write Storage Text
- Write Text File
- 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
- Testing
- Release notes
- About the Testing activity package
- Project compatibility
- Project Settings
- Add Test Data Queue Item
- Address
- Attach Document
- Bulk Add Test Data Queue Items
- Create Comparison Rule
- 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 Documents Equivalence
- Verify Expression
- Verify Expression With Operator
- Verify Range
- Verify Text Equivalence
- Address
- AddTestDataQueueItem
- AttachDocument
- BulkAddTestDataQueueItems
- DeleteTestDataQueueItems
- GetTestDataQueueItem
- GetTestDataQueueItems
- GivenName
- LastName
- RandomDate
- RandomNumber
- RandomString
- RandomValue
- VerifyAreEqual
- VerifyAreNotEqual
- VerifyContains
- VerifyExpression
- VerifyExpressionWithOperator
- VerifyIsGreater
- VerifyIsGreaterOrEqual
- VerifyIsLess
- VerifyIsLessOrEqual
- VerifyIsRegexMatch
- VerifyRange
- Workflow Events
- Workflow Foundation
Getting Started
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 UiPath 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, select Open Form Designer inside the Create Form activity.
A Form component provides you with 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 Label/Header File/Folder 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. |
Hidden Container Data Grid Edit Grid 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.
Check the About form components page to learn more about each form component and how to configure them.
Comparison between grid control components
The table below compares the capabilities of the grid controls available in the Form Designer. The table also describes the recommended scenarios for using each grid control component: Grid, Data Grid, and Edit Grid.
Legend: = Available
= Not
available.
|
Capability |
Grid |
Data Grid |
Edit Grid |
|---|---|---|---|
|
Recommended scenarios |
Displaying large number of data for read-only purposes (read-only capability) |
Displaying a small set of data that need to be edited by the user (inline edit capability) |
Displaying a small set of data that need to be edited by the user (sub-form inline edit capability) |
|
Recommended number of rows |
Unlimited (100 rows pagination support) |
Not more than 100 rows. Risk of performance reduction beyond recommended numbers |
Not more than 100 rows. Risk of performance reduction beyond recommended numbers |
|
Recommended number of columns |
Unlimited |
Maximum 7 columns for 100 rows. Risk of performance reduction |
Maximum 7 columns for 100 rows. Risk of performance reduction |
|
Editable |
|
|
|
|
Pagination |
|
|
|
|
Sortable |
|
|
|
|
Filterable |
|
|
|
|
Column resizable at runtime |
|
|
|
|
Row grouping |
|
|
|
|
Logic & Conditions |
|
|
|
|
Extensive customization using templates |
|
| |
|
Global search |
|
|
|
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, select 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 conditions for the component. |
You can set advanced conditions, such as Javascript or JSON. |
|
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 headers and rows of your edit grid data. |
To reopen the configuration wizard, hover over the form component and select Edit.
To rearrange the form components, select Move and drag the form component to another location inside your form.
To edit the form component using its JSON settings, select Edit JSON. This opens the component JSON, displaying all the available settings.
To copy a component inside the form, select Copy and then select 
Paste below on the same component or on another one.
To remove a component from your form, select Remove.
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.
Customizing Themes
To customize a premade theme to your preference:
- In the Preview mode, navigate to the Themes panel.
- Select a premade theme.
- Select Customize Current Theme.
- Customize the form and the primary button using the available options.
- Select Save Customization.
