Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

App Settings

The Web.config file (C:\inetpub\UiPathOrchestrator) contains multiple settings that enable you to configure Orchestrator to your liking. Most of the parameters that interest you can be found under appSettings, but there might be some logging configurations that can be changed after install.

📘

Note:

It is recommended that only administrators change the values of these parameters.

Advanced Installation Settings

  • DeploymentUrl - The address of a web app that uses the NuGet protocol (NuGet, MyGet), so that you can store your packages. By default, this is empty as Orchestrator provides a default NuGet package manager. This value should be changed only if you install Orchestrator in a cluster. For this to work properly, you also have to configure the following parameters: requireApiKey, apiKey, and packagesPath as described below.
  • MonitoringUrl - The URL where you set up the Monitoring service. By default, this value is blank as Orchestrator comes with its own monitoring endpoint.This value should be changed only if you install Orchestrator in a cluster.
  • NotificationHubUrl - The URL where the SignalR channel is located. By default, this value is blank as Orchestrator comes with its own notification endpoint. This value should be changed only if you install Orchestrator in a cluster.
  • LoggingUrl - The URL where you want to save logs. By default, this value is blank as Orchestrator comes with its own logging endpoint. This value should be changed only if you install Orchestrator in a cluster.
  • QueuesSvcUrl - The URL address of the Queues service. By default, this value is blank as Orchestrator comes with its own queues endpoint. This value should be changed only if you install Orchestrator in a cluster.
  • EncryptionKey - The encryption key used to secure passwords from credential assets. If you are using an environment with a network load balancer, this key should be the same for all machines.

Queues

  • autogenerateStatistics - Automatically generates transaction charts. By default, this parameter is set to true.
  • inProgressMaxNumberOfMinutes - The maximum amount of time queue items can have the In Progress status. After this time, the status of the queue items changes to Abandoned. By default, this is set to 1440 minutes (24 hours).
  • ArchiveItemsScheduleCron - The amount of time after which to archive queue items that have been successfully processed, as a cron expression. By default, they are archived at 00:00 a.m. every day.
  • QueuesStatisticsScheduleCron - The amount of time at which to update queue items statistics in the Dashboard and Transactions page, and the Chart window. By default, they are updated every minute.

Alerts

  • Alerts.Email.Enabled - Enable or disable e-mail alerts for Fatal and Error messages. By default, it is set to false. For it to work, you also have to configure the e-mail related settings, from [the Settings page]doc:settings-description).
  • DailyAlertMailJobCron - If e-mail alerts are enabled, a report (with all Fatal and Error messages that were received during the previous day) is sent every day at 7 a.m.

Deployment

  • requireApiKey - Indicates if an API key is required for the deployment web app specified in the DeploymentUrl parameters. By default, this is set to true.
  • apiKey - The license key of your NuGet account.
  • packagesPath - The path to the packages folder. The default is ~/NuGetPackages. This can be a virtual or physical path.
  • allowOverrideExistingPackageOnPush - Enables users to override certain packages. The default value is true.
  • enableDelisting - Enables users to hide specific packages from the NuGet feed. By default, it is set to false.
  • enableFrameworkFiltering - Enables filtering packages according to the .NET framework they support. By default, it is set to false.

Authorization

📘

Note:

Google authentication only works if Orchestrator is set up on a top-level domain.

  • ExternalAuth.Google.Enabled - Enables or disables Google authentication. By default, this is set to false.
  • ExternalAuth.Google.ClientId - A Google API code required for Google authentication. This cannot work without the ExternalAuth.Google.ClientSecret.
  • ExternalAuth.Google.ClientSecret - A Google API code required for Google authentication. This cannot work without the ExternalAuth.Google.ClientId.

📘

Note:

The WindowsAuth.Enabled, WindowsAuth.Domain and AcceptedRootUrls parameters have to be configured before you can import Active Directory groups.

  • WindowsAuth.Enabled - Enables or disables Windows Active Directory authentication. By default, it is set to false.
  • WindowsAuth.Domain - The Windows domain that the users from the Active Directory that you want to import are connected to.
  • WindowsAuth.AutoLogin.Enabled - Enables or disables Windows automatic login. By default, this is set to false.
  • AcceptedRootUrls - Enables you to add a list of trusted URLs. If no value is attributed to this setting, then no one can access Orchestrator.
  • Auth.Cookie.Expire - The amount of time after which you are automatically logged off, in minutes. By default, this is set to 60 minutes. Starting with v2016.2.6274, this is set to 30 minutes by default.

Multi-tenancy

  • Tenant.Registration.Enabled - Enables users to create tenants when set to true so that data can be isolated according to teams. By default, this is set to false.

Load Balancer

These settings should only be modified if you are using a load balancer.

  • LoadBalancer.UseSqlServer - Use the default SQL database to distribute messages to and from all the machines connected through your load balancer. By default, it is set to false.
  • LoadBalancer.UseRedis - Use Redis as a database to distribute messages and cache to and from all the machines connected through your load balancer. By default, it is set to false.
  • LoadBalancer.Redis.Server - The URL of your Redis server.
  • LoadBalancer.Redis.Port - The Redis server port.
  • LoadBalancer.Redis.Password - The password for your Redis server.

Updated 4 years ago



App Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.