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
- 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
- Add Task Comment
- Update Task Labels
- Create App Task
- Wait for App Task and Resume
- 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
- Sample Workflows
- Automation Ops Pipelines
- System
- Release notes
- About the System activity 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
- Testing
- Release notes
- Project compatibility
- About the Testing activity 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
- 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 Apr 22, 2024
APIs
APIs allow you to access and interact with the services offered in the
Manage Packages menu. You can use these APIs when you design coded
automations. Visit Coded Automations to learn about coded automations and how
to design them using APIs.
Note: Using Go to Definition
(
F12) allows you to access the definition of UiPath APIs for a
certain service. We recommend relying only on the directly exposed APIs when you
implement coded automations. Other APIs that are not directly exposed with a service
are subject to change without prior notification.
APIs often have overloads, which means they provide multiple versions of the same method with different parameter options. Overloads allow you to customize the behavior of the API based on your specific requirements. For example, a UI Automation API may have an overload that accepts a timeout parameter to specify the maximum time to wait for a UI element to appear before ending execution.
By using the APIs with their respective overloads, you can easily achieve your desired automation logic and behavior.
| API | Description |
|---|---|
| AddDataRow | Adds a DataRow to a specified DataTable. |
| AddQueueItem | Adds a new item in an Orchestrator queue. |
| AddTransactionItem | Adds a new item in the queue and starts a transaction. |
| AppendLine | Appends the specified string to a file, creating the file if it does not already exist. |
| BulkAddQueueItems | Adds a collection of items from a specified
DataTable to a specified queue in
Orchestrator.
|
| ClearDataTable | Clears all the data in the specified DataTable. |
| CompressZipFiles | Adds the specified files or folders to a compressed (zip) file archive. |
| CopyFile | Copies a file from a specified location to another. |
| CreateFile | Creates an empty file in the specified location. If a file already exists at that location, |
| CreateFolder | Creates a folder in the specified location. |
| DeleteFileOrFolder | Deletes a specified file or folder. |
| DeleteQueueItems | Enables you to delete items with the New state from a specified Orchestrator queue. |
| DeleteStorageFile | Deletes a file from a specified Storage Bucket in Orchestrator. |
| DownloadStorageFile | Downloads a copy of a file in an Orchestrator storage bucket locally. |
| ExtractUnzipFiles | Extracts all the contents of a zip file archive to a specified folder. |
| FilterDataTable | Filters a DataTable by specifying conditions in the Filter widget. |
| GetAsset | Gets a specified Orchestrator asset by using a provided AssetName. |
| GetCredential | Gets a specified credential asset by using a provided Asset Name. |
| GetJobs | Retrieves a list of Orchestrator jobs according to a custom filter, using the Orchestrator API. |
| GetQueueItem | The method gets an item from the queue so that you can process it (start the transaction) and sets its status to In Progress. |
| GetQueueItems | Enables you to retrieve a list of up to 100 transactions from an indicated Orchestrator queue, according to multiple filters, such as creation date, priority, state, and reference. |
| GetResourceForLocalPath | Build a resource from the local path of the file or folder. |
| GetRowItem | Retrieves a value from a row in a DataTable according to a specified column. |
| GetTransactionItem | Gets an item from the Orchestrator queue so that you can process it (start the transaction) and sets its status to In Progress. |
| InvokeProcess | Executes a UiPath process that is available for the local machine. |
| JoinDataTables | Combines rows from two tables by using values common to each
other, according to a Join rule, which is specified in the
JoinType parameter.
|
| ListStorageFiles | Lists files matching a given pattern from a specified Storage Bucket in Orchestrator. |
| LookUpDataTable | This method emulates the behaviour of the VLOOKUP Excel formula.
It enables you to search for a provided value in a specified
DataTable and returns the RowIndex at
which it was found.
|
| MergeDataTable | Merges the Destination with the Source, indicating whether to preserve changes and how to handle missing schema in the Source. |
| MoveFile | Moves a file from a specified location to another. |
| OrchestratorHTTPRequest | Performs HTTP requests to the Orchestrator API by authenticating under the Robot it is executed on. |
| OutputDataTable | Writes a DataTable to a string using the CSV format. |
| PathExists | Checks if the specified path exists. The path can represent a file path or a directory path. |
| PostponeTransactionItem | Adds time parameters between which an Orchestrator transaction must be processed (not before Postpone and no later than Deadline). |
| ReadStorageText | Downloads a file from a specified Storage Bucket in Orchestrator and stores it in a string variable. |
| ReadTextFile | Reads all characters from a specified file and stores it in a String variable. |
| RemoveDataColumn | Removes a DataColumn from a specified DataTable. |
| RemoveDuplicateRows | Removes the duplicate rows from a specified
DataTable variable, keeping only the first
occurrence.
|
| Replace | Within a specified input string, replaces strings that match a regular expression pattern with a specified replacement string. |
| SetAsset | Enables you to update the value of an indicated asset, which is already available in Orchestrator, be it a global or a Per Robot asset. |
| SetCredential | Enables you to update the value of an indicated credential asset, that is already available in Orchestrator, be it a global or a Per Robot asset. |
| SetTransactionProgress | Helps you create custom progress statuses for your In ProgressOrchestrator transactions. |
| SetTransactionStatus | Sets the status of an Orchestrator transaction item to Failed or Successful. |
| SortDataTable | Sorts an entire DataTable by ascending or
descending order, based on the values of a specified column.
|
| StartJob | Enables you to start a job on Orchestrator on a specified number of Robots. |
| StopJob | Enables you to stop or kill a job on Orchestrator. |
| UpdateRowItem | Assigns a specified value to the indicated column of a DataTable row. |
| UploadStorageFile | Uploads a file to a specified Storage Bucket in Orchestrator. |
| WaitQueueItem | Retrieves an Orchestrator queue item from a specified queue and
stores it in a QueueItem variable.
|
| WriteStorageText | Uploads a string into a specified Storage Bucket in Orchestrator. |
| WriteTextFile | Writes the specified text into a file. If the file already exists, the pre-existing text is overwritten. |
