orchestrator

2020.10

false

Getting Started
- About this guide
Requirements
- Hardware Requirements
- Software Requirements
- Prerequisites for Installation
  - Configuring the Firewall
  - Finding the .NET Framework Version
  - Creating an Index Pattern to Connect to Elasticsearch
  - Server Roles and Features
- About Deployment
  - Web Server on a Single Machine
  - Multi-Node Deployment
  - High Availability
  - Disaster Recovery - Active/Passive
  - Disaster Recovery - Two Active Data Centers
  - Deployment in the Cloud
- Certificate Considerations
  - Using a Certificate for the HTTPS Protocol
Best Practices
- Security Best Practices
  - Deployment and Configuration Considerations
  - Encrypting the SQL Server
  - Disabling the HTTP Method Override Request
  - Using the FileSystem Storage Allowlist Securely
- Performance Best Practices
  - Maintenance Considerations
Installation
- Installation Considerations
- About Installation
- The Windows Installer
  - Command Line Parameters
- Azure App Service Installation
  - Orchestrator Scripts
  - Identity Server Scripts
  - Webhooks Scripts
- Azure Marketplace Deployment
- AWS Deployment
- Platform Configuration Tool
- UiPath.Orchestrator.dll.config
  - Encrypting UiPath.Orchestrator.dll.config Sections
  - Overriding Configuration Via Environment Variables
- Web.Config
  - Unlocking Web.Config Sections
- Webhooks AppSettings.json
- About Troubleshooting
  - Orchestrator Installation Troubleshooting
- Opting Out of Telemetry
Updating
- About Updating and Migrating
  - Migrating Elasticsearch Indices
  - Changing the Orchestrator / Identity Server URL
- Updating Using the Windows Installer
- Updating Using the Azure Script
- Backup and Restore
  - Orchestrator Backup and Restore
  - Backup Configuration Files and NuGet Packages
Identity Server
- Hardware and Software Requirements
- Prerequisites for Installation
- Installation
- Identity Server AppSettings.json
  - Encrypting AppSettings.Production.json
- Maintenance Considerations
- About Troubleshooting
  - Identity Server Troubleshooting
High Availability Add-on
- Release Notes
- Hardware and Software Requirements
- Installation
  - Alerts and Monitoring
  - Active/Active Disaster Recovery Installation
- Upgrading

OUT OF SUPPORT

Orchestrator Installation Guide

DELIVERY:

Last updated Dec 12, 2023

Webhooks AppSettings.json

The appsetting.json file (C:\Program Files (x86)\UiPath\Orchestrator\Webhooks) contains the out-of-the-box settings for the Webhooks Service. It is recommended to configure your custom settings in the appsetting.Production.json. This file overrides any pre-existing settings within appsetting.json after each installation process.

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

Additionally, it is recommended that you shut down the IIS server in order to modify appsetting.Production.json settings under any circumstances.

Parameters that are not documented in this page should not be changed.

All parameters are case sensitive.

Settings Priority

Settings can be configured in multiple places. Here are the priorities used by Webhooks Service when determining the value of a setting, listed from high (1) to low (3):

Value within the appsettings.Production.json file
Value within the appsettings.json file
Default value setting within the code. Used only if a specific setting can't be found within appsettings.Production.json or appsettings.json.

Settings

The appsettings.json file has an internal structure composed of multiple json sections separated by a comma.

Orchestrator SQL Client Settings

"OrchestratorSqlClientSettings": {
    "ConnectionString": "<OrchestratorConnectionString>",
    "Enabled": true
  },"OrchestratorSqlClientSettings": {
    "ConnectionString": "<OrchestratorConnectionString>",
    "Enabled": true
  },

`ConnectionString`

The connection string as generated by the Orchestrator instance you want to connect to.

Webhook Service Config

"WebhookServiceConfig": {
    "MaxWorkerCount": 10,
    "HttpClientUserAgent": "UiPath-WebhookService/Webhooks",
    "RequestTimeout": "0.00:01:00",
    "RetryAfter": [
      "0.00:00:0",
      "0.00:00:45",
      "0.00:02:30",
      "0.00:05:00"
    ],
    "MaxRetryRequests": 2
  },"WebhookServiceConfig": {
    "MaxWorkerCount": 10,
    "HttpClientUserAgent": "UiPath-WebhookService/Webhooks",
    "RequestTimeout": "0.00:01:00",
    "RetryAfter": [
      "0.00:00:0",
      "0.00:00:45",
      "0.00:02:30",
      "0.00:05:00"
    ],
    "MaxRetryRequests": 2
  },

`RequestsTimeout`

The amount of time after which each HTTP request is canceled. Please note that each request that times out is retried, according to the RetryAfter value. By default, the timeout time is set to 1 minute.

`RetryAfter`

The amount of time, in seconds, after each failed request is retried. By default, there are 4 retries defined as follows:

The first request retry is executed immediately after the first attempt failed;
The second retry is executed 45 seconds after the first retry failed;
The third retry is executed 2 minutes and 30 seconds after the second one fails.
The fourth retry is executed 5 minutes after the third one fails.

It is possible to change the number of delays, if you list fewer entries or if you set the value of MaxRetryRequests to a smaller value. We recommend that you always set the first retry to 0, and never set time amounts greater than 300 seconds (5 minutes) in between retries.

`MaxRetryRequests`

The maximum number of retries to be performed on a failed request.

`MaxWorkerCount`

The maximum number of webhooks that can be enabled per tenant. By default, it is set to 10.

Ledger Configuration

"LedgerConfiguration": {
    "Enabled": true,
    "Subscribers": [
      {
        "LedgerComponentType": 0,
        "ComponentId": "WebhookSubscriber",
        "Topics": null,
        "ConnectionString": "<OrchestratorConnectionString>",
        "EstablishNewConnection": false,
        "LedgerSubscriberDeliveryType": 1,
        "LedgerSubscriberReliability": 1,
        "Enabled": true,
        "LedgerComponentClassType": 2,
        "Context": "{\"BatchSize\": 500, \"DeliveriesBatchSize\": 500}"
      }
    ]
  },"LedgerConfiguration": {
    "Enabled": true,
    "Subscribers": [
      {
        "LedgerComponentType": 0,
        "ComponentId": "WebhookSubscriber",
        "Topics": null,
        "ConnectionString": "<OrchestratorConnectionString>",
        "EstablishNewConnection": false,
        "LedgerSubscriberDeliveryType": 1,
        "LedgerSubscriberReliability": 1,
        "Enabled": true,
        "LedgerComponentClassType": 2,
        "Context": "{\"BatchSize\": 500, \"DeliveriesBatchSize\": 500}"
      }
    ]
  },

`ConnectionString`

The connection string as generated by the Orchestrator instance you want to connect to.

"ApplicationInsights": {
    "InstrumentationKey": "<AI_InstrumentationKey>"
  },"ApplicationInsights": {
    "InstrumentationKey": "<AI_InstrumentationKey>"
  },

`InstrumentationKey`

Required if you're using Application Insights.

Click here for the official Application Insights documentation.

On this page

Settings Priority
Settings
Orchestrator SQL Client Settings
Webhook Service Config
Ledger Configuration

Was this page helpful?

PREVIOUSUnlocking Web.Config Sections

NEXTAbout Troubleshooting