- Getting started
- Understanding UiPath Robot
- Installation requirements
- Installing robots for unattended automations
- Configuring robots for unattended automations
- Deploying unattended automations
- Connecting robots for unattended automations to Orchestrator
- Setting up Windows Server for High-Density Robots
- Redirecting robots through a proxy server
- Implementing authentication with credential providers
- Configuring package signature verification
- Setting up package folders and network paths
- Configuring activity feeds
- Using EntraID users with multifactor authentication (MFA) for unattended robots
- Installing robots for attended automations
- Configuring robots for attended automations
- Integrations
- Governance
- Troubleshooting

Robot admin guide
Once you edit configuration files, you need to restart the relevant Robot components for changes to take effect. The following list summarizes how to restart several components, based on the Robot installation mode.
Remember to save any ongoing work before you restart to avoid losing any unsaved progress.
- Robot Service
- Service Mode installation
- Open Task Manager > Services.
- Look for the
UiPathRobotSvcservice. - Right-click the service and select Restart.
- User Mode installation - Quit, then relaunch the Assistant, or:
- Open Task Manager > Details.
- Select the
UiPath.Service.UserHost.exeprocess. - Select End task.
- Service Mode installation
- Update Service
- Open Task Manager > Services.
- Look for the
UiPath.UpdateService.Agentservice. - Right-click the service and select Restart.
- UiPath RobotJS ServiceHost
- Open Task Manager > Services.
- Look for the
UiPath.RobotJS.ServiceHostservice. - Right-click the service and select Restart.
- UiPath Assistant
- In Assistant, select Preferences, then Quit.
- Relaunch the Assistant.
- Widgets - Restart the Assistant, or:
- Right-click the Assistant icon in the taskbar.
- Select Reload Widgets
UiPath.config file contains essential configuration parameters for the Robot. As an admin, you can customize the behavior of your robots
by editing the list of parameters in the config file.
Each environment might need specific notices, so UiPath allows you to apply different configurations based on the current environment of the robot, whether it's Development, Staging, or Production. Always be careful when editing this file, as inaccurate configuration may cause application issues.
Accessing the file
UiPath.config file.
C:\Program Files\UiPath\Studio\UiPath.config.
Customizable settings
TheUiPath.config file consist of the following parameters:
- In the
connectionSettingsconfig section-
DefaultServiceUrl(string) - Sets the default address the Robot uses to connect to Orchestrator. Example:string DefaultServiceUrl = "https://cloud.uipath.com"string DefaultServiceUrl = "https://cloud.uipath.com" -
AutoSignIn(bool) - Enables the auto sign-in feature for Assistant. Default value isfalse. Example:bool AutoSignIn = true.bool AutoSignIn = true. -
EnforceDefaultServiceUrl(bool) - Enforces the address provided asDefaultServiceUrlto all users. Default value isfalse. Example:bool EnforceDefaultServiceUrl = true.bool EnforceDefaultServiceUrl = true.
-
- In the
communicationSettingsconfig section-
MaxMessageSizeInMegabytes(byte) - Sets the maximum size of a message the system can send or receive, in MB. Default value is10.This is used to prevent overload or process crashes due to handling messages too large. Example:
byte MaxMessageSizeInMegabytes = 10;byte MaxMessageSizeInMegabytes = 10; -
InstallPackageTimeout(TimeSpan) - Sets the time limit for package installations. Default value is 20 minutes.If a package installation takes longer than the defined time, the system aborts the installation. Example:
TimeSpan InstallPackageTimeout = TimeSpan.FromMinutes(20);TimeSpan InstallPackageTimeout = TimeSpan.FromMinutes(20); -
RequestTimeout(TimeSpan) - Defines how long the system waits for a communication response. Default value is 40 seconds.If the system does not receive a response in the set period, it stops and moves forward. This prevents system hang-ups. Example:
TimeSpan RequestTimeout = TimeSpan.FromSeconds(40);TimeSpan RequestTimeout = TimeSpan.FromSeconds(40);
-
- In the
packageSettingsconfig sectionPackagesInstallationFolder(string) - Sets the default directory where packages are installed. Default value isC:\UiPath\Packages.-
SkipHttpConfigurationSources(bool) - Enables the system to ignore package sources configured over HTTP, such as NuGet feeds. Default value isfalse.This means the system does not retrieve packages from these sources, which is useful when the sources are not reliable or secure.
DisableSecureXaml(bool) - Allows the Robot to run potentially unsafe workflows. Default value isfalse.DirectDownload(bool) - Allows direct download of packages, without prompting the user. Default value isfalse.-
PackageSaveWithoutNupkg(bool) - Allows saving the packages without the.nupkgfile. Default value isfalse.This is helpful to reduce the download size.
- In the
analyticsSettingsconfig sectionTelemetry.Enabled(bool) - Allows UiPath to collect and send usage data for analysis. Default value isfalse.
- In the
robotCacheSettingsconfig section-
SessionCacheDuration(TimeSpan) - Defines how long the data from a specific session should be retained in the cache before being discarded. Default value is 30 seconds.This is useful for reusing data such as variable values or details of operations, instead of recreating or refetching it. Example:
TimeSpan SessionCacheDuration = TimeSpan.FromSeconds(30);TimeSpan SessionCacheDuration = TimeSpan.FromSeconds(30); -
GetResourceUrlCacheDuration(TimeSpan) - Defines how long the URLs for resources, such as APIs or webpages, are stored in cache. Default value is one (1) hour.This is useful for optimizing performance in scenarios where your robots need to access certain resources regularly. Example:
TimeSpan GetResourceUrlCacheDuration = TimeSpan.FromHours(1);TimeSpan GetResourceUrlCacheDuration = TimeSpan.FromHours(1);
-
-
In the
robotJsSettingsconfig section-
ListenerPort(int) - Sets the port number on which the Robot.js listens for incoming connections. Default value is2323.This allows the robot service to interact with web applications running on local or remote servers. Example:
int ListenerPort = 2323;int ListenerPort = 2323; -
TokenExpiryInDays(int) - Sets the validity period, in days, of authentication tokens generated by the robot service. Default value is 30 days.The robot service uses these tokens to authenticate itself when interacting with other software components or services. Example:
int TokenExpiryInDays = 30;int TokenExpiryInDays = 30; -
AllowUrlList(string) - Sets the list of URLS that the robot service can access. This helps ensure your robot service only interacts with approved services. Example:string AllowUrlList = "https://cloud.uipath.com";string AllowUrlList = "https://cloud.uipath.com";
-
-
Always create a backup of the original
UiPath.configfile before making any changes. This can help restore the original settings if something goes wrong. -
To apply the updates made to the
UiPath.configfile, restart the UiPath service or the system. -
Local settings in the
UiPath.configfile take precedence over settings configured in Orchestrator. -
Sensitive data in
UiPath.configfile can be encrypted for additional security.
Further custom behavior can be configured through system environment variables.
After modifying any of the system variables, restart the Robot Service.
The following list summarizes the most common use cases:
-
UIPATH_SESSION_TIMEOUT- Changes the default 60-second timeout for creating an interactive session. Adjust this value to adapt the Robot behavior based on the performance and load times of the system it interacts with.Example:
UIPATH_SESSION_TIMEOUT=75UIPATH_SESSION_TIMEOUT=75 -
UIPATH_PIP_SESSION_TIMEOUT- Changes the default 180-second timeout for starting a process in a Robot session.Example:
UIPATH_PIP_SESSION_TIMEOUT=60UIPATH_PIP_SESSION_TIMEOUT=60 UIPATH_LANGUAGE- Sets the language the Robot operates in. The order of precedence is:UIPATH_LANGUAGEvalue- Machine environment variable
- Current thread UI culture
- Default UiPath language (English)
Example:
UIPATH_LANGUAGE=FrenchUIPATH_LANGUAGE=French-
UIPATH_HEADLESS_WITH_USER- Uses the credentials of a specific user, which was previously configured in Orchestrator.Example:
UIPATH_HEADLESS_WITH_USER=TrueUIPATH_HEADLESS_WITH_USER=True -
UIPATH_PRE_LOADED_EXECUTOR- By default, a preloaded executor is launched when the Robot starts. To change this behavior and launch the preloaded executor only when the first process runs, set this variable toNone.Example:
UIPATH_PRE_LOADED_EXECUTOR=NoneUIPATH_PRE_LOADED_EXECUTOR=None -
UIPATH_DISABLE_PRE_LOADED_EXECUTOR- Disables the preloaded executor feature.Example:
UIPATH_PRE_LOADED_EXECUTOR=NoneUIPATH_PRE_LOADED_EXECUTOR=None -
UIPATH_ROBOTJS_ALLOWLIST- Automatically accepts the robot consent dialog, when establishing the connection between the Robot JS SDK and the Robot Executor.The variable accepts custom application URLs, separated by semicolons. Include the port number in the URL if it differs from the standard ports (80 or 443).
Example:
UIPATH_ROBOTJS_ALLOWLIST=cloud.uipath.com;mydomain.com;UIPATH_ROBOTJS_ALLOWLIST=cloud.uipath.com;mydomain.com; -
UIPATH_DNS_MACHINENAME- Allows using the DNS host name for Localhost when creating RDP sessions. To execute unattended jobs in environments with Kerberos authentication for RDP, set this value to True.Example:
UIPATH_DNS_MACHINENAME=TrueUIPATH_DNS_MACHINENAME=True -
NUGET_FALLBACK_PACKAGES- Configures the paths to fallback packages folders. Use semicolons to separate multiple paths.In the absence of this variable, the Robot searches for fallback packages folders in theNuget.configfile. -
NUGET_SCRATCH- Allows multiple User Mode robots on the same machine to share a local path for storing packages.The value must be a path different to the Nuget installation folder, and it acts as a temporary folder for NuGet.
Note: Only theNUGET_SCRATCHvariable should use the configured temporary folder.Example:
NUGET_SCRATCH=C:\NuGetTempFolderNUGET_SCRATCH=C:\NuGetTempFolder -
UIPATH_PRESERVE_CREDENTIALS_CASE- Preserves the original casing of logging credentials (domain\username).Example:
UIPATH_PRESERVE_CREDENTIALS_CASE = TrueUIPATH_PRESERVE_CREDENTIALS_CASE = True -
UIPATH_SESSION_BEHAVIOR- Configures the way the session restore behaves after a job completes. The following options are available:TryReuseAndRestoreSession—Default option. Attempts to reuse the session and restore it to its previous state after a job completes. If there is no initial session to reuse, it logs off on restore.ForceNew—Creates a completely new session, regardless of the previous session state. Always logs off on restore.LeaveSessionActive—Prevents restoration of the initial session state.LeaveSessionDisconnected—Always disconnects the session on restore.
UIPATH_SESSION_BEHAVIOR = LeaveSessionDisconnectedUIPATH_SESSION_BEHAVIOR = LeaveSessionDisconnected