Activities
latest
false
- Overview
- Automation Ops Pipelines
- 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 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
- 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
- System
- 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
- Testing
- 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
- 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 Feb 23, 2024
Add Queue Item And Get Reference
UiPath.Persistence.Activities.Queue.AddQueueItemAndGetReference
Adds an Orchestrator Queue Item with parameters and retrieves the corresponding Queue Item Object, stored in a
QueueItemData
variable, in order to wait for transaction completion at any time during the execution of the workflow.
Designer panel
- Queue Name - The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was
defined as "MyFirstQueue", it matches "myfirstqueue". The maximum number of characters is
50
. - Priority - The priority level of the Queue Item that is added. This property is a criterion for the prioritization of queue items, alongside Due Date and Defer Date.
- ItemInformation - A collection of additional information about the specific QueueItem that is to be added. The information is stored in the
item and is used during a transaction processing. It is recommended to use only primitive values of the following types: Number,
Boolean, String and DateTime. The value of string arguments cannot contain the following characters:
[
and" "
. Argument names cannot contain the following characters::
,.
,,
,@
,"
. - Queue Item (Output) - The queue object that is returned from Orchestrator as a
QueueItemData
object after the queue is created. This object can be passed to the Wait for Queue Item and Resume activity in order to suspend the execution of the workflow until the transaction is completed.
Properties panel
Common
- ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- DisplayName - The display name of the activity.
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Input
- Deadline - The timestamp before which the queue item should be processed. This property can be filled in with relative timestamps
such as
DateTime.Now.AddHours(2)
,DateTime.Now.AddDays(10)
andDateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0))
. Additionally, you can use the US notation to add an exact time, such as12/10/2017 07:40:00
. Automatically correcting this date is available. For example, if you write8 9 2018 9:0
, it is automatically transformed to08/09/2018 09:00:00
. - Orchestrator Folder Path - The path to an Orchestrator
Folder different to the one the current process operates in,
where you want to create the queue item. To read more on Orchestrator Folders,
go here. For
Classic folders, this property can only be used with Floating
Robots and only if the current user has the correct task privilege in
the target folder. For Modern folders, folder path overriding is not
supported. This field supports only strings and
String
variables.
Note: The FolderPath property must be used only if the queue item must be created or queried from a folder different than the current one. If the user performing this action
does not have the required permissions for the target folder, queue item creation fails and throws a critical error. You can
view more info on Folder Permissions here.
- ItemInformation - A collection of additional information about the specific QueueItem that is to be added. The information is stored in the
item and is used during a transaction processing. It is recommended to use only primitive values of the following types: Number,
Boolean, String and DateTime. The value of string arguments cannot contain the following characters:
[
and" "
. Argument names cannot contain the following characters::
,.
,,
,@
,"
. - ItemInformationCollection - Enables importing an entire dictionary of information for a queue item. This field accepts
Dictionary<string, object>
variables only. - Postpone - The timestamp after which the queue item may be processed. This property is a criterion for the prioritization of queue
items, alongside Priority and Due Date. This property can be filled in with relative timestamps such as
DateTime.Now.AddHours(2)
,DateTime.Now.AddDays(10)
andDateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0))
. Additionally, you can use the US notation to add an exact time, such as 12/10/2017 07:40:00
. Automatically correcting this date is available. For example, if you write8 9 2018 9:0
, it is automatically transformed to08/09/2018 09:00:00
. - Priority - The priority level of the Queue Item that is added. This property is a criterion for the prioritization of queue items, alongside Due Date and Defer Date.
- Queue Name - The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was
defined as "MyFirstQueue", it matches "myfirstqueue". The maximum number of characters is
50
. - Reference - The reference of the Queue Item that is added. The reference can be used to link your transactions to other applications used within an automation project. Additionally, this feature enables you to search for certain transactions, in Orchestrator, according to the provided string.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- Queue Item (Output) - The queue object that is returned from Orchestrator as a
QueueItemData
object after the queue is created. This object can be passed to the Wait for Queue Item and Resume activity in order to suspend the execution of the workflow until the transaction is completed.
- Queue Name - The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was
defined as "MyFirstQueue", it matches "myfirstqueue". The maximum number of characters is
50
. - Priority - The priority level of the Queue Item that is added. This property is a criterion for the prioritization of queue items, alongside Due Date and Defer Date.
- ItemInformation - A collection of additional information about the specific QueueItem that is to be added. The information is stored in the
item and is used during a transaction processing. It is recommended to use only primitive values of the following types: Number,
Boolean, String and DateTime. The value of string arguments cannot contain the following characters:
[
and" "
. Argument names cannot contain the following characters::
,.
,,
,@
,"
. - Queue Item (Output) - The queue object that is returned from Orchestrator as a
QueueItemData
object after the queue is created. This object can be passed to the Wait for Queue Item and Resume activity in order to suspend the execution of the workflow until the transaction is completed.
Advanced options
Common
- ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed.
- DisplayName - The display name of the activity.
- TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
Input
- Deadline - The timestamp before which the queue item should be processed. This property can be filled in with relative timestamps
such as
DateTime.Now.AddHours(2)
,DateTime.Now.AddDays(10)
andDateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0))
. Additionally, you can use the US notation to add an exact time, such as12/10/2017 07:40:00
. Automatically correcting this date is available. For example, if you write8 9 2018 9:0
, it is automatically transformed to08/09/2018 09:00:00
. - Orchestrator FolderPath - The path to an Orchestrator
Folder different to the one the current process operates in,
where you want to create the queue item. To read more on Orchestrator Folders,
go here. For
Classic folders, this property can only be used with Floating
Robots and only if the current user has the correct task privilege in
the target folder. For Modern folders, folder path overriding is not
supported. This field supports only strings and
String
variables.
Note: The FolderPath property must be used only if the queue item must be created or queried from a folder different than the current one. If the user performing this action
does not have the required permissions for the target folder, queue item creation fails and throws a critical error. You can
view more info on Folder Permissions here.
- ItemInformationCollection - Enables importing an entire dictionary of information for a queue item. This field accepts
Dictionary<string, object>
variables only. - Postpone - The timestamp after which the queue item may be processed. This property is a criterion for the prioritization of queue
items, alongside Priority and Due Date. This property can be filled in with relative timestamps such as
DateTime.Now.AddHours(2)
,DateTime.Now.AddDays(10)
andDateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0))
. Additionally, you can use the US notation to add an exact time, such as 12/10/2017 07:40:00
. Automatically correcting this date is available. For example, if you write8 9 2018 9:0
, it is automatically transformed to08/09/2018 09:00:00
. - Priority - The priority level of the Queue Item that is added. This property is a criterion for prioritizing queue items, alongside Due Date and Defer Date.
- Queue Name - The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was
defined as "MyFirstQueue", it matches "myfirstqueue". The maximum number of characters is
50
. - Reference - The reference of the Queue Item that is added. The reference can be used to link your transactions to other applications used within an automation project. Additionally, this feature enables you to search for certain transactions, in Orchestrator, according to the provided string.