activities
latest
false
- 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
- Create Form
- Start Form Activity
- Trigger Form Button
- 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
Workflow Activities
Last updated Nov 18, 2024
Create Form
UiPath.Form.Activities.FormActivity
Use this activity to create a custom form. The form you configure retrieves all the data the end user inputs and stores it in variables, which can be further used in the automation process. The Do block in the activity enables you to perform additional actions when the form opens or while the form is running.
Designer panel
- Open Form Designer - opens the UiPath Form Designer.
Properties panel
Common
The properties in this category refer to common activity settings.
- Display Name (String) - Sets the name for this activity. For example,
"User Registration Form". - ExecuteDoBlockFirst (Boolean) - To execute the activities in the Do block before opening the form, check this box. By default, the checkbox is
cleared (set to
false). - FormTitle (String) - Sets the title for your form, seen by the business users. For example,
"Registration Form". - Isolated (Boolean) - To run the form in a separate Windows process, check this box. Selecting this check box enables Validation Station
and Callouts to run seamlessly from the same process. By default, the checkbox is cleared (set to
false). - Timer (Int32) - Sets the amount of time in seconds until the form is automatically closed. For example,
50. By default, no value is provided, meaning the form must be closed manually.
Data Bindings
The properties in this category refer to data that is linked to the automation process.
-
FormFieldsCollection (Dictionary<String, Argument>) - Binds workflow variables to the form Field Keys. Use In or In/Out directions for input form fields. Use Out or In/Out directions for output form fields. For example, in the Name field add the string
First Name, set the Direction toIn/Out, and set the Type toString. - GenerateInputFields (Boolean) - To add the fields defined in the collection to the form, check this box. By default, the checkbox is selected
(set to
true).
Data Table
The property in this category refers to table data in forms.
- MaxColumnsForSchemaGeneration (Int32) - Sets the maximum number of generated columns for DataTable schemas. The default value is 6.
Debug
The property in this category refers to debugging forms and experimenting with CSS styles.
- Dev Tools - Enables the developer tool for debugging and troubleshooting forms, called Dev Tools. Developers can use Dev Tools to experiment with CSS styles. When checked, the property opens the Dev Tools window at runtime.
Form Options
The property in this category refers to accessibility inside forms.
- Enable Accessibility - Enables accessibility in conformance with USWDS (United States Web Design System). When this property is enabled, the styling of the form might be impacted.
Format
The properties in this category refer to the form appearance and format.
- DisableMaximize (Boolean) - To deactivate the Maximize, and Restore buttons on forms, check this box. By default, the checkbox is cleared
(set to
false). - DisableMinimize (Boolean) - To deactivate the Minimize and Restore buttons on forms, check this box. By default, the checkbox is cleared
(set to
false). - DisableSanitize (Boolean) - To deactivate final checks on the form components, and improve performance, check this box. By default, the checkbox
is cleared (set to
false).
Warning: If your form contains unknown URLs or it is using external sources, keep the checkbox cleared.
- FormHeight (Int32) - Sets the desired height for the form, in pixels. The default height is 400.
- FormWidth (Int32) - Sets the desired width for the form, in pixels. The default width is 800.
Note: To open the form in a maximized window, leave the FormHeight and FormWidth fields empty.
- IconPath (String) - Sets the local relative path to the icon file. The icon is displayed on the taskbar and in the form window. Accepts
.icoor image formats . (for example,"C:/Users/Icons/myIcon.ico").
Note: You may use a path relative to the process, as long as the
.ico file is published as a resource within the process (for example, "myIcon.ico").
Warning: You need to select the Isolated checkbox (Common properties). Otherwise, the icon doesn't get displayed.
- IsReadOnly (Boolean) - To prevent form fields from being edited, check this box. Fields marked as Always Enabled are not affected by
this option. By default, the checkbox is cleared (set to
false). - LocalCSSFilePath (String) - Sets the path to a local CSS file (for example,
"/file://C:\C:\User heCssFile.css"). - Start Form As Minimized (Boolean) - To generate the form in a minimized window on the taskbar, check this box. By default, the checkbox is cleared
(set to
false). - WindowPositionX (Int32) - Sets the form left margin position, in pixels.
- WindowPositionY (Int32) - Sets the form top margin position, in pixels.
Input
The property in this category refers to the JSON input data.
- FormFieldsInputData (String) - Passes
JSONinput data to the form and overwrites the values defined in the FormFieldsCollection field. For Data Grid components, structure, the JSON as an array.
Misc
The property in this category refers to miscellaneous settings.
- Private (Boolean) - To skip logging variables and arguments at Verbose level, check this box. By default, the checkbox is cleared
(set to
false).
Output
The properties in this category refer to the output object data.
- Dismissed (Boolean) - Outputs
truewhen the end user closes the form without providing any input. For example,"isDismissed". - FormFieldsOutputData (String) - The
JSONdata that results from the form upon completion. For example,"userData". - SelectedButton (String) - Outputs the form UI elements the end user interacts with. For example,
"selectedButton".
Start Form
The properties in this category bind the form to the Start Form Activity, so the form can be opened in the background.
- Folder Path (String) - Enter the path where you want to save the form data to.
-
Form Name (String) - Enter a name for your form data.
Warning: To bind every Create Form to the corresponding Start Form Activity, the
Folder Path and Form Name values must match with the values set in Start Form Activity > Create Form properties.
