- 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 Parallel Process
- Set Asset
- Set Credential
- Set Environment Variable
- Set Transaction Progress
- Set Transaction Status
- Should Stop
- Split Text
- Sort Data Table
- Run Local Triggers
- 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
Invoke Workflow File
UiPath.Core.Activities.InvokeWorkflowFile
Synchronously invokes a specified workflow, optionally passing it a list of input arguments.
- 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. Disregarding this notice triggers 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. To open the workflow in a different tab of the same project, select Open workflow at the right side of the field.
-
Arguments - Default option. Opens the arguments dictionary, where you can see the arguments of the invoked workflow. You can also define a variable to hold a dictionary of arguments by selecting Use an expression at the right side of the field. This converts the Arguments field to Arguments variable. To retrieve the latest list of workflow arguments, select Refresh arguments at the right side of the field.
-
Arguments variable - Activated by the Use an expression option from the Arguments field. You can use a predefined variable, or you can create a new one either by using VB expressions or prompting the Autopilot to generate one for you. Use this variable to hold the dictionary of arguments for the invoked workflow. Switch back to the Arguments option by selecting Use Static Names at the right side of the field. To open the arguments list and edit their attributes, select the Arguments field box.
-
If the value of Arguments variable is null at runtime, the activity falls back to the Arguments property.
-
Switching between the Arguments and Arguments variable properties reveals the previous value.
-
The value of Arguments variable is lost upon closing the Expression Editor.
Additional properties
Common
-
Timeout - Specifies the amount of time to wait for the invoked workflow to run before an error is thrown and the workflow is aborted. This field supports only
TimeSpan
variables. By default, this field is empty. -
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 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.
Options
-
Target session (exclusively for Windows projects) - Specifies the session in which the workflow is started. Only isolated workflows can be started in a different session from the parent, so make sure to set the Isolated property to True. 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.
- Isolated - Select True to run the invoked workflow in a separate Windows process. This helps with isolating a faulty workflow from the main workflow. False by default.
Log
- Log Entry - Specify the type of information to automatically log when entering the invoked resource.
- Log Exit - Specify the type of information to automatically log when exiting the invoked resource.
- LogLevel - Specify the logging level applied to the messages generated by Log Entry and Log Exit.
Designer panel
You can find the following properties in the body of the activity:
-
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 supported. All strings must be placed between quotes.
-
Importing Arguments - Opens an Arguments panel which features all of the arguments of the workflow referenced in the Workflow file name 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.Note: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:- 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.
- 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 - Enables you to open the invoked workflow in a different tab of the same project.
Properties panel
Common
-
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. -
DisplayName - The display name of the activity.
- 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.
-
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 supported. 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 - Specify the type of information to automatically log when entering the invoked resource.
- Log Exit - Specify the type of information to automatically log when exiting the invoked resource.
- LogLevel - Specify 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 (exclusively for Windows projects) - Specifies the session in which the workflow is started. Only isolated workflows can be started in a different session from the parent, so make sure to set the Isolated property to True. 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.