Configuration files

UiPath.Settings File Description

The UiPath.Settings file contains all the necessary details regarding how the Robot performs processes. You can modify these settings by directly editing the file and the corresponding fields. On the other hand, you can modify them via Orchestrator. This is done from the Settings tab.

Note:

Please note that local system and administrator rights are required to modify these settings. You should restart the UiPath Robot service (admin rights are required to do this), and close the Robot tray for changes to take effect.

The UiPath.Settings file is stored in the %localappdata%\UiPath\ folder when the Robot is deployed in user mode, and %programdata%\UiPath\ when the Robot is deployed in service mode. It is created the first time the UiPath Robot service starts. It contains the following parameters:

Parameter	Description
NuGetApiKey	The API key of the NuGet feed. When not connected to Orchestrator, if you are using a local feed, it does not require an API key. If you use a private MyGet feed, please note that this parameter is required. When connected to Orchestrator, this value is not taken into account.
NuGetServerUrl	The location where projects are pushed and from where they are retrieved. This can be either a local feed, such as a file system path, or a web feed that uses the NuGet protocol (NuGet, MyGet etc.). When not connected to Orchestrator, the default value is %ProgramData%\UiPath\packages (user mode) or `%. If you use a private MyGet feed, please use the URL provided under Your pre-authenticated V2 URL (no basic authentication). Please note that this is not a free service from MyGet. When connected to Orchestrator, this value is not taken into account.
ActivitiesFeed	The address where the activities are stored. This field is only populated if you are not connected to Orchestrator. By default, the value is ~/NuGetPackages/Activities. If you connect to Orchestrator, this field is not taken into account. Find out more about the activities feeds on this page, as well as where packages are installed based on the Robot deployment type.
UiPathServerUrl	The address of your instance of Orchestrator. When not connected to Orchestrator, this parameter is empty. When connected to Orchestrator, it is automatically filled in with the URL you provided in the Orchestrator Settings window.
TracingLevel	The level at which the Robot should log information. The following options are available: Verbose,Trace,Information,Warning,Error,Critical and Off. This can also be changed from the Orchestrator Settings window, from the Level drop-down list.
LowLevelTracing	Indicates whether or not to log information at a trace level, to help you with troubleshooting crashes and errors. By default, this parameter is set to false. To start low level tracing, set the value of this parameter to true. You can also change this value from the command line.
SecureLicenseKey	The Machine Key that is used to connect to Orchestrator. The key is encrypted in the UiPath.settings file using DPAPI. This value can also be filled in and modified from the Orchestrator Settings window. If not connected to Orchestrator, this parameter should be empty.
LoginToConsole	Enables the Robot to connect to the console session of the machine where it is installed. Additionally, it indicates if you can connect multiple Robots to Orchestrator using multiple users (High-Density Robots) or not. By default, the value is true. To enable High-Density Robots, set the value to false.
ResolutionWidth	The machine's display resolution width. This option is set to 0 by default, which means that it automatically retrieves and uses the detected resolution width. You can use a custom value, as long as it is supported by the workstation.
ResolutionHeight	The machine's display resolution height. This option is set to 0 by default, which means that it automatically retrieves and uses the detected resolution height. You can use a custom value, as long as it is supported by the workstation.
ResolutionDepth	The machine's display resolution depth. This option is set to 0 by default, which means that it automatically retrieves and uses the detected resolution depth. You can use a custom value, as long as it is supported by the workstation.
FontSmoothing	Enhances text recognition. If is set to True, the Font Smoothing option over RDP connections is turned on. This means that the target machine will have ClearType turned on.
ConnectionString	A string generated from Orchestrator that enables you to register your Robot to it, without providing the Machine Name and Machine Key.
DisableWorkflowExecution	Disables the possibility to execute processes from the command line when enabled. By default, this feature is hidden and disabled.
webProxySettings	Parameter used to configure Proxy Settings for the Robot. Find out more in the Redirecting Robots Through a Proxy document.

UiPath Robot system variables

Further custom behavior can be configured through system environment variables.

Important:

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_PIP_SESSION_TIMEOUT	Changes the default 180-second timeout for starting a process in a Robot session.	UIPATH_PIP_SESSION_TIMEOUT=60
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_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. To change this behavior and launch the preloaded executor only when the first process runs, set this variable to 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. Include the port number in the URL if it differs from the standard ports (80 or 443).	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.	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. 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

Restarting Robot Components

Remember to save any ongoing work before you restart to avoid losing any unsaved progress.

• Robot Service
  • Service Mode installation
    1. Open Task Manager > Services.
    2. Look for the UiPathRobotSvc service.
    3. Right-click the service and select Restart.
  • User Mode installation - Quit, then relaunch the Assistant, or:
    1. Open Task Manager > Details.
    2. Select the UiPath.Service.UserHost.exe process.
    3. Select End task.
• Update Service
  1. Open Task Manager > Services.
  2. Look for the UiPath.UpdateService.Agent service.
  3. Right-click the service and select Restart.
• UiPath RobotJS ServiceHost
  1. Open Task Manager > Services.
  2. Look for the UiPath.RobotJS.ServiceHost service.
  3. Right-click the service and select Restart.
• UiPath Assistant
  1. In Assistant, select Preferences, then Quit.
  2. Relaunch the Assistant.
• Widgets - Restart the Assistant, or:
  1. Right-click the Assistant icon in the taskbar.
  2. Select Reload Widgets