Configuration files

Once you edit configuration files, you need to restart the relevant Robot components for changes to take effect. The following table 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.

Component	Service Mode installation	User Mode installation
Robot Service	Open Task Manager > Services. Look for the UiPathRobotSvc service. Right-click the service and select Restart.	Quit, then relaunch the Assistant or Open Task Manager > Details. Select the UiPath.Service.UserHost.exe process. Select End task.
Update Service	Open Task Manager > Services. Look for the UiPath.UpdateService.Agent service. Right-click the service and select Restart.
UiPath RobotJS ServiceHost	Open Task Manager > Services. Look for the UiPath.RobotJS.ServiceHost service. 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

The 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.

Note:

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

When you install your Robot, the system creates the UiPath.config file.

To access it, navigate to C:\Program Files\UiPath\Studio\UiPath.config.

Customizable settings

The UiPath.config file consist of the following parameters:

Config section	Data type + parameter name	Description	Default	Example
connectionSettings	string DefaultServiceUrl	Sets the default address the Robot uses to connect to Orchestrator.	NA	string DefaultServiceUrl = "https://cloud.uipath.com"
	bool AutoSignIn	Enables the auto sign-in feature for Assistant.	false	bool AutoSignIn = true.
	bool EnforceDefaultServiceUrl	Enforces the address provided as DefaultServiceUrl to all users.	false	bool EnforceDefaultServiceUrl = true.
communicationSettings	byte MaxMessageSizeInMegabytes	Sets the maximum size of a message the system can send or receive, in MB. This is used to prevent overload or process crashes due to handling messages too large.	10 MB	byte MaxMessageSizeInMegabytes = 10;
	TimeSpan InstallPackageTimeout	Sets the time limit for package installations. If a package installation takes longer than the defined time, the system aborts the installation. Expressed as TimeSpan.	20 minutes	TimeSpan InstallPackageTimeout = TimeSpan.FromMinutes(20);
	TimeSpan RequestTimeout	Defines how long the system waits for a communication response. If the system does not receive a response in the set period, it stops and moves forward. This prevents system hang-ups. Expressed as TimeSpan.	40 seconds	TimeSpan RequestTimeout = TimeSpan.FromSeconds(40);
packageSettings	string PackagesInstallationFolder	Sets the default directory where packages are installed.	C:\UiPath\Packages
	bool SkipHttpConfigurationSources	Enables the system to ignore package sources configured over HTTP, such as NuGet feeds. This means the system does not retrieve packages from these sources, which is useful when the sources are not reliable or secure.	false
	bool DisableSecureXaml	Allows the Robot to run potentially unsafe workflows.	false
	bool DirectDownload	Allows direct download of packages, without prompting the user.	false
	bool PackageSaveWithoutNupkg	Allows saving the packages without the .nupkg file. This is helpful to reduce the download size.	false
analyticsSettings	bool Telemetry.Enabled	Allows UiPath to collect and send usage data for analysis.	false
webProxySettings	string ScriptAddress	Sets the address of the script that determines how and when to use the proxy.
	string ProxyAddress	Sets the address of the proxy server, either IP or domain name.
	string BypassList	Contains the list of addresses that connect directly to the internet, bypassing the proxy server.
	bool BypassLocalAddresses	Allows direct connection for local addresses, bypassing the proxy server.	false
	string UserName	Sets the username credential for proxy server authentication.
	string Password	Sets the password associated with the username for proxy server authentication.
	string Domain	Sets the domain where the proxy server resides, required for authentication.
robotCacheSettings	TimeSpan SessionCacheDuration	Defines how long the data from a specific session should be retained in the cache before being discarded. This is useful for reusing data such as variable values or details of operations,instead of recreating or refetching it. Expressed as TimeSpan.	30 seconds	TimeSpan SessionCacheDuration = TimeSpan.FromSeconds(30);
	TimeSpan GetResourceUrlCacheDuration	Defines how long the URLs for resources, such as APIs or webpages, are stored in cache. This is useful for optimizing performance in scenarios where your robots need to access certain resources regularly. Expressed as TimeSpan.	1 hour	TimeSpan GetResourceUrlCacheDuration = TimeSpan.FromHours(1);
robotJsSettings	int ListenerPort	Sets the port number on which the Robot.js listens for incoming connections. This allows the robot service to interact with web applications running on local or remote servers.	2323	int ListenerPort = 2323;
	int TokenExpiryInDays	Sets the validity period, in days, of authentication tokens generated by the robot service. The robot service uses these tokens to authenticate itself when interacting with other software components or services.	30 days	int TokenExpiryInDays = 30;
	string AllowUrlList	Sets the list of URLS that the robot service can access. This helps ensure your robot service only interacts with approved services.		string AllowUrlList = "https://cloud.uipath.com";

Important:

• Always create a backup of the original UiPath.config file before making any changes. This can help restore the original settings if something goes wrong.
• To apply the updates made to the UiPath.config file, restart the UiPath service or the system.
• Local settings in the UiPath.config file take precedence over settings configured in Orchestrator.
• Sensitive data in UiPath.config file can be encrypted for additional security.

UiPath Robot system variables

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:

System variable	Usage	Example
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.	UIPATH_SESSION_TIMEOUT=75
UIPATH_SESSION_LEGACY
UIPATH_PIP_SESSION_TIMEOUT	Changes the default 180-second timeout for starting a process in a Robot session.	UIPATH_PIP_SESSION_TIMEOUT=60
UIPATH_USER_SERVICE_PATH	Sets the installation path of the user service.	UIPATH_USER_SERVICE_PATH=C://installation/folder/UiPath.Service.UserHost.exe
UIPATH_LANGUAGE	Sets the language the Robot operates in. The order to determine the language is: UIPATH_LANGUAGE value The machine environment variable The current thread UI culture Default UiPath language (English)	UIPATH_LANGUAGE=French
UIPATH_DISABLE_MARKETPLACE_WIDGET	Required by Assistant, disables the Marketplace widget.	// On Windows OS UIPATH_DISABLE_MARKETPLACE_WIDGET=True //On Mac OS, run the following command: launchctl setenv UIPATH_DISABLE_MARKETPLACE_WIDGET TRUE
UIPATH_HEADLESS_WITH_USER	Uses the credentials of a specific user, which was previously configured in Orchestrator.	UIPATH_HEADLESS_WITH_USER=True
UIPATH_PRE_LOADED_EXECUTOR	By default, a preloaded executor is launched when the Robot starts. This variable overwrites the default behavior, and a preloaded executor starts when the first process runs. Options are: Windows Legacy Portable None	UIPATH_PRE_LOADED_EXECUTOR=None
UIPATH_DISABLE_PRE_LOADED_EXECUTOR	Disables the preloaded executor feature.	UIPATH_DISABLED_PRE_LOADED_EXECUTOR=True
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. If non-standard ports are used, ensure to include the port numbers.
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.	UIPATH_DNS_MACHINENAME=True
UIPATH_PROXY_USE_DEFAULT_CREDENTIALS	Enables the Robot to handle proxy configurations that use Windows Credentials for authentication.	UIPATH_PROXY_USE_DEFAULT_CREDENTIALS=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 the Nuget.config file.
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 the NUGET_SCRATCH variable should use the the configured temporary folder.	NUGET_SCRATCH=C:\NuGetTempFolder
UIPATH_PRESERVE_CREDENTIALS_CASE	Preserves the original casing of logging credentials (domain\username).	UIPATH_PRESERVE_CREDENTIALS_CASE = True