Activities
latest
false
Banner background image
Workflow Activities
Last updated Feb 23, 2024

Invoke Process

UiPath.Core.Activities.InvokeProcess

Description

Executes a UiPath process that is available for the local machine. Can be used to run local packages, as well as processes in Orchestrator, if a connection is available.

For more information on how to find the list of available processes on a machine, go here

The Invoke Process activity runs in Synchronous mode, meaning that the parent process waits for the child process to complete before resuming.

Logs generated by the child processes only contain the outcome of the execution and errors, and are written in the same place as the ones from the parent and can be differentiated by the ProcessName field in local logs and Process column in Orchestrator.

When using the Invoke Process activity, even though the project contains multiple processes, a single job is created for running them as opposed to the Run Parallel Process activity which creates separate jobs for each process in the project.

If there are multiple processes added, the active version on the current folder is the one that will be used.

Note:
  • Unserializable data types cannot be passed between workflows (e.g. UIBrowser, UIElement, etc).
If a child process is invoked but not found, an error is logged containing the name of the child process, the path where Robot searched for it and additional details such as WindowsIdentity and machineName.
Note: When using a version of the UiPath.System.Activities that is higher than v20.4, Invoke Process supports multiple entry points. If a workflow is created with this version and then the UiPath.System.Activities pack is downgraded to an older version that only supports a single entry point, the Invoke Process activities in the workflow suffer validation errors and must be manually replaced to work.
Note: This activity is only compatible with Studio v19.6 and above.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Windows, Cross-platform configuration

  • FolderPath - The path of the Orchestrator folder where the specified process is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".
    Note: The Folder Path parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.
  • Process Name - The name of the process that you want to run. This field supports only strings and String variables. Process Name should contain the name of the Package, as that is being used by the Robot.
Advanced options
  • 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.
  • Timeout - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. Leaving this property empty waits for an infinite amount of time before throwing an exception. By default, this property field is empty.
  • Log Entry - Specifies the type of information to automatically log when entering the invoked resource.
  • Log Exit - Specifies the type of information to automatically log when exiting the invoked resource.
  • Level - Specifies the logging level applied to the messages generated by the LogEntry and LogExit options.
  • Entry Point Path - The path of the workflow file that is run at the start of the process, relative to the package root. If left empty, the default entry point is Main.xaml. This field supports only strings and String variables.
  • Target Session - Specifies the session in which the child process is started:

    • Current- The child process opens in the same session as the parent one.
    • Process Default - The child process uses the Process Settings.
    • 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.

Windows - Legacy configuration

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 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.
  • Timeout (milliseconds) - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. Leaving this property empty waits for an infinite amount of time before throwing an exception. By default, this property field is empty.

    Note: When using 2021.10 and older robots, business Exceptions are not supported in an isolated workflow, all exceptions return as System Exceptions.
Input
  • Arguments - A list of IN arguments that you can pass to the process you want to run from Orchestrator. If an argument has an unknown type, it is converted to JSON.
  • ArgumentsVariable - The argument variables passed to the invoked process.
  • Process Name - The name of the process that you want to run. This field supports only strings and String variables. Process Name should contain the name of the Package, as that is being used by the Robot.

Log

  • Log Entry - Specifies the type of information to automatically log when entering the invoked resource.
  • Log Exit - Specifies the type of information to automatically log when exiting the invoked resource.
  • LogLevel - Specifies the logging level applied to the messages generated by the LogEntry and LogExit options.
Misc
  • Entry Point - The path of the workflow file that is run at the start of the process, relative to the package root. If left empty, the default entry point is Main.xaml. This field supports only strings and String variables.
  • Folder Path - The path of the Orchestrator folder where the specified process is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".
    Note: The Folder Path parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.
  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  • Target Session - Specifies the session in which the child process is started:

    • Current- The child process opens in the same session as the parent one.
    • Process Default - The child process uses the Process Settings.
    • 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.
  • Use Package - Indicates whether the process should be identified by its package name (selected) or process name (not selected). By default this option is not selected.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.