- 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
Invoke Workflow File
UiPath.Core.Activities.InvokeWorkflowFile
Synchronously invokes a specified workflow, optionally passing it a list of input arguments. Arguments can be imported from a specified workflow with this activity by using the Import Arguments button in the body of the activity.
- Importing arguments from a workflow auto-matches them to existing variables if they share the same name and data type.
- Unserializable data types cannot be passed between isolated workflows (e.g. UIBrowser, UIElement, etc).
- Antivirus policies that restrict PowerShell access may prevent the use of PowerShell-related activities. For example, you cannot use Invoke Workflow File and Invoke Power Shell when rule ID 6151 is enabled in McAfee Endpoint Security.
- After running an invoked workflow that adds custom log fields, the log fields are restored to the configuration of the parent workflow.
- Passing IN arguments to an Invoke Workflow File activity that is not isolated acts as if a reference is passed, which means any changes to the object inside the invoked workflow change the object in the main workflow.
- Variables and arguments are not supported for workflow file names in Windows and cross-platform projects. This will trigger an Expressions are currently not supported error notification.
- When invoking a workflow, make sure it does not contain persistence activities. These should only be used in the main workflow.
The workflow that is referenced in the WorkflowFileName property can be opened in the current project by using the Open Workflow button in the body of the activity.
.xaml
file whose title contains a dot (.
) has
all the text that is before the dot (including the dot) replaced with an underscore
(_
).
- Workflow File Name - The file path of the .xaml file to be invoked. The file path is relative to the current project folder. This field accepts only strings or string variables. String variables are not supported in Windows and cross-platform projects, All strings must be placed between quotes.
- Open Workflow - Opens the invoked workflow in a different tab of the same project.
Advanced options
Options
- Isolated - If this check box is selected, the invoked workflow runs in a separate Windows process. This helps with isolating a faulty workflow from the main workflow.
Log
- Log Entry - What type of information to automatically log when entering the invoked resource.
- Log Exit - What type of information to automatically log when exiting the invoked resource.
- LogLevel - The logging level applied to the messages generated by Log Entry and Log Exit.
Designer panel
You can find the following options in the body of the activity.
Importing Arguments
Clicking the Import Arguments button in the body of the activity opens an Arguments panel which features all of the arguments of the workflow referenced in the WorkflowFilePath property.
This panel enables you to choose which arguments you want to import from the invoked workflow by using the directional controls or the Delete button to reorganize the arguments. Clicking OK saves the changes.
- Creating arguments in the panel causes them to be discarded, as they do not match the data in the invoked workflow.
- Argument names are case sensitive in the panel.
Once the panel is closed, a counter next to the button shows how many arguments have been selected for importing. The counter is color coded, as follows:
- orange - If there is a mismatch between the selected arguments and the ones that exist in the invoked workflow.
- grey - If the selected arguments are found in the invoked workflow.
Open Workflow
The Open Workflow button In the body of the activity enables you to open the invoked workflow in a different tab of the same project.
Properties panel
Common
- DisplayName - The display name of the activity.
-
Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (
true
,false
). The default value isfalse
. 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. - Timeout - Specifies the
amount of time to wait for the activity to run before an error is thrown. This
field supports only
TimeSpan
variables. By default, this field is empty.
Input
- Arguments - The parameters that can be passed to the application at the time of invocation.
- ArgumentsVariable - The parameters that can be passed dynamically to the workflow using a dictionary.
- Isolated - If this check box is selected, the invoked workflow runs in a separate Windows process. This helps with isolating a faulty workflow from the main workflow.
-
WorkflowFileName - The file path of the .xaml file to be invoked. The file path is relative to the current project folder. This field accepts only strings or string variables. String variables are not supported in Windows and cross-platform projects, All strings must be placed between quotes.
Note: When using 2021.10 and older robots, business Exceptions are not supported in an isolated workflow, all exceptions return as System Exceptions.
Log
- Log Entry - What type of information to automatically log when entering the invoked resource.
- Log Exit - What type of information to automatically log when exiting the invoked resource.
- LogLevel - The logging level applied to the messages generated by Log Entry and Log Exit.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
-
Target Session - Specifies the session in which the workflow is started. Only isolated workflows can be started in a different session from the parent. You can choose one of the following options:
- Current - The child process opens in the same session as the parent one.
- Main - The child process starts in the main session regardless to where the parent process runs.
-
Picture in Picture - The child process starts in the Picture in Picture session regardless to where the parent process runs.
Note: When configuring theTarget Session
for the Invoke Workflow Activity, theIsolated
parameter has to be enabled.