通知を受け取る

UiPath Orchestrator

UiPath Orchestrator ガイド

Web.Config

★削除★ web.config file (C:\Program Files (x86)\UiPath\Orchestrator) 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.

📘

注:

これらのパラメーターの値の変更は管理者のみが行うことが推奨されます。

Additionally, it is recommended that you shut down the IIS site in order to modify web.config settings under any circumstances.

このページに記載されていないパラメーターは、変更してはならないものであるか、または [設定] ページに対応するものが記載されています。

すべてのパラメーターは、大文字と小文字を区別します

アプリの設定

インストールの詳細設定

  • 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 NuGet.Packages.ApiKey, and NuGet.Packages.Path as described below. The default value is used in the initial seeding of the database.
  • Logs.RobotLogs.ReadTarget - Enables you to configure the source from which Orchestrator reads and populates logs (e.g. database または robotelasticbuffer など)。
  • EncryptionKeyPerTenant.Enabled -Microsoft Azure Key Vault アカウントに基づき、テナントごとに異なる暗号化キーを使用できます。次の値を設定できます。
    • false - Orchestrator インスタンス全体で 1 つの暗号化キーを使用します。これが既定値です。
    • true - Uses a different encryption key for each tenant, enhancing your tenant security and providing a better segregation of sentive data. If you enable this feature, you must also fill in the EncryptionKeyPerTenant.KeyProvider parameter, as well as the ones in the SecureAppSettings section.
  • EncryptionKeyPerTenant.KeyProvider - Enables you to indicate in which key management application to store the encryption keys generated per tenant from Orchestrator. Set it to AzureKeyVault to use a preconfigured Microsoft Azure Key Vault. We do not provide Azure Key Vault licenses. Please note that you also have to configure the parameters described in the SecureAppSettings section. If EncryptionKeyPerTenant.Enabled is set to false, the parameter is not used.

📘

注:

In order for changes concerning cron jobs to take effect, the Database.EnableAutomaticMigrations parameter must be set to true beforehand.

キュー

  • autogenerateStatistics - Automatically generates transaction charts. By default, this parameter is set to true です。
  • inProgressMaxNumberOfMinutes - キュー アイテムが [処理中] のステータスを保てる最長時間です。この時間が経過した後は、キュー アイテムのステータスが [破棄済み] に変わります。既定では、この値は 1,440 分 (24 時間) に設定されています。
  • QueuesStatisticsScheduleCron - [ダッシュボード] ページ、[トランザクション] ページ、および [チャート] ウィンドウでキュー アイテムの統計を更新する時間です。既定では、毎分更新されます。
  • UpdateUncompletedItemsJobCron - ステータスを [破棄済み] に移行する必要があるキューについてデータベースを検索する時間です。既定では、このパラメーターは毎時で設定されています。
  • Queue.MaxSlaInMinutes - The maximum value the SLA can be set to, expressed in minutes. By default, the value is 129600 minutes (90 days), and it is displayed by default in web.config, including in update scenarios.
  • Queue.MaxSchemaFileSizeInKilobytes - The maximum file size, in KB, of the JSON schema against which queue item data and output is validated. This setting does not appear by default in the web.config file.
  • Queue.SlaReadaheadTimeLimitHours - The amount of time in which queue item deadlines must fall for the items to be taken into account when making predictions. The default value is 24 hours. This parameter is not displayed by default in web.config です。
  • Queue.ProcessActivationSchedule - 未処理のキュー アイテムのチェック間隔です。既定では、この値は 30 分に設定されています。チェック間隔を調整するには、0 ~ 59 の値を指定し、IIS を再起動します。その後、既存のキュー トリガーを削除してから、再作成します。

アラート

  • DailyAlertMailJobCron - 毎日のメール アラートの送信時刻を制御する cron 式を設定できます。これはメール アラートが有効な場合にのみ機能します。レポートには前日に生成された重要度が Fatal および Error のすべてのアラートが含まれます。既定では、毎日午前 7 時に送信されます。
  • Alerts.Email.Enabled - Enable or disable email alerts for Fatal and Error messages. This parameter corresponds to the Enable Alerts Email check box from the Settings page. By default, it is set to false. For it to work, you also have to configure the email related settings, from the Settings page. The default value is used in the initial seeding of the database. Changing the value afterwards does not toggle email alerts.
  • NotificationDistributerJobCron - アラート通知がインターフェイスに送信される頻度です。既定では、アラートは 10 秒ごとに送信されます。
  • PeriodicErrorMailJobCron - 定期的なメール アラートの送信頻度を制御する cron 式を設定できます。これはメール アラートが有効な場合にのみ機能します。既定値は 10 分ごとです。これは、過去 10 分間に生成された、重要度が Fatal および Error のアラートがレポートに含まれることを意味します。アラートが 1 つも生成されなかった場合、レポートは送信されません。
  • PasswordComplexity - パスワードの複雑さの検証ルールを制御し、正規表現で表されます。既定では、複雑さはすべてのパスワード (host admin のパスワードも含む) に適用されていますが、テナントは [設定] ページの [セキュリティ] タブでログイン パスワードの複雑さをカスタマイズできます。既定では、パスワードは 8 文字以上にする必要があり、1 文字以上の英字および 1 文字以上の数字を含める必要があります。
  • SystemJobs.DetectNotRespondingRobots.MaxAlertCount - Enables you to limit the number of alerts that are sent when Robots become unresponsive. This parameter can be useful if your Orchestrator instance deals with a very large number of Robots and most of them become unresponsive often. Please note that it is not displayed in the configuration file by default. For example, if you want to limit the number of alerts you receive for unresponsive Robots to 10, add <add key="SystemJobs.DetectNotRespondingRobots.MaxAlertCount" value="10" /> in the web.config file, under all the other alerts parameters. If you apply this setting, please note that a warning is raised in the Event Viewer when the total number of alerts is higher than that of the one configured, such as: Alerts not published: total number of unresponsive sessions (21) is bigger than configured max allowed (10). です。
  • SystemJobs.LicenseExpirationAlert.DaysBefore - Enables you to define the time intervals before the license expiry date when you receive email alerts. The default value is 180,90,30,14,7,1, meaning you receive email alerts 6 times: 180, 90, 30, 14, 7 and 1 day before your license expires. You can define fewer values in order to reduce the email alerts' frequency. For example, this can be done by adding the following key in the web.config file: <add key="SystemJobs.LicenseExpirationAlert.DaysBefore" value="90,30,14" /> です。

デプロイ

  • NuGet.Repository.Type - NuGet パッケージの保存場所を指定します。次のように設定できます。
    • Legacy - Uses FileSystem for package sync. This is the default value in update scenarios. Packages and activities are saved in the locations specified in the NuGet.Packages.Path and NuGet.Activities.Path parameters, respectively. Can be used with either NuGet.EnableRedisNodeCoordination または NuGet.EnableFileSystemMonitoring. Example: <add key="NuGet.Repository.Type" value="Legacy" /> です。
    • Composite - Package metadata is saved to the SQL database for faster search and filtering. Packages are saved to the location specified through the Storage.Type and Storage.Location parameters. Example: <add key="NuGet.Repository.Type" value="Composite" />. This parameter with Storage.Type set to FileSystem is the default in clean installs.

📘

The use of copy-paste commands in the packages-dedicated folder is not supported if NuGet.Repository.Type is set to Composite です。

  • Storage.Type - 複合シナリオのパッケージと実行メディアが保存されるターゲットを定義します。次のターゲットで設定できます。
    • FileSystem - such as <add key="Storage.Type" value="FileSystem" /> です。
    • Azure - such as <add key="Storage.Type" value="Azure" /> です。
    • Amazon - such as <add key="Storage.Type" value="Amazon" /> です。
    • Minio - such as <add key="Storage.Type" value="Minio" /> です。
  • Storage.Location - 複合シナリオのパッケージが保存される実際の場所と実行メディアが保存される場所を定義します。個別の詳細:
    • FileSystem - provide an absolute path in the RootPath=C:\FolderName\AnotherFolderName format, such as <add key="Storage.Location" value="RootPath=C:\FolderName\AnotherFolderName" />. In the provided folder, three other sub-directiories are created: ExecutionMedia Packages, and Libraries. Files are saved according to their type in dedicated folders, at the specified location. By default, they are stored at the following path: C:\Program Files (x86)\UiPath\Orchestrator\Storage\Orchestrator-tenantKey: Orchestrator-tenantKey is the key of your tenant as found in the database. For example C:\Program Files (x86)\UiPath\Orchestrator\Storage\Orchestrator-12ab1234-a567-456b-a12b-ab3456b123ab です。
    • Azure - provide a connection string, such as <add key="Storage.Location" value="DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" /> です。
    • Amazon - provide a connection string, such as <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false" /> です。
    • Minio - provide a connection string, such as <add key="Storage.Location" value="host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" /> です。

例:

<add key=\"NuGet.Repository.Type\" value=\"Composite\" />
<add key=\"Storage.Type\" value=\"Azure\" />
<add key=\"Storage.Location\" value=\"DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net\" />

上記の設定は、Orchestrator に次のことを実行するように命令します。

  • パッケージのメタデータを SQL サーバーのデータベースに格納する。
  • to keep the actual files in the Azure Blob storage at the location indicated by the DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net connection string;
  • to use the default naming convention for the Azure container name - Orchestrator-tenantKey です。

📘

重要

Orchestrator のテナント数 99 を上回る場合には、既定の AWS S3 バケットアカウントの制限値をテナント数に合わせて増やしてください。バケットはテナントごとに個別に作成されるため、この手順が必要です。

  • NuGet.Packages.Path - The NuGet path to the packages folder in the Legacy scenario. By default, this is ~/NuGetPackages. This can be a virtual or physical path.
  • NuGet.Packages.ApiKey - The license key of your NuGet account. If the activities and packages are stored in the same NuGet feed, the value of this parameter has to be identical to the NuGet.Activities.ApiKey one. The default value is used in the initial seeding of the database. Please note that arbitrary strings are also accepted.
  • NuGet.Activities.Path - The NuGet path to the activities folder in the Legacy scenario. By default, this is ~/NuGetPackages/Activities です。
  • NuGet.Activities.ApiKey - The license key of your NuGet account. If the activities and packages are stored in the same NuGet feed, the value of this parameter has to be identical to the NuGet.Packages.ApiKey one. Please note that arbitrary strings are also accepted.
    複数の Orchestrator ノードとインターフェイス間のパッケージ同期は、ファイル システムを監視するか、Redis を使用することで実行できます。これは、以下の設定を使用して構成できます。Redis の使用を推奨します。
  • NuGet.EnableFileSystemMonitoring - If set to true, constant file system monitoring is used to reflect the updates and changes from the packages folder. If set to false, the sync of cache files on all nodes (cluster environment) or the sync between the packages directory and the Orchestrator interface (single-node environment) is done every 60 minutes. By default, this parameter is set to true です。
  • NuGet.EnableRedisNodeCoordination - If set to true, then the synchronization of the package cache between Orchestrator nodes is done using Redis, instead of File System Monitoring. The sync is triggered whenever a package is uploaded or removed from Orchestrator through the interface, API or Studio publishing functionality. Please note that if you manually copy and paste package files (.nupkg) in the Orchestrator packages folder, the sync of cache files of all nodes is done every 60 minutes. If this setting is used, the Redis component is mandatory. Please note that if you use this parameter, you have to set NuGet.EnableFileSystemMonitoring to false. By default, this parameter is set to false です。
  • Processes.AllowUpdateWithRunningJobs - プロセスと関連付けのあるジョブが実行中または保留中である場合に、プロセスの削除を可能にするかどうかを指定します。このパラメーターは既定では非表示です。次の値を使用できます。
    • true - プロセスと関連付けのあるジョブが実行中または保留中である場合でも、プロセスを削除できます。
    • false - 実行中または保留中のジョブに関連付けられているプロセスは削除できません。この場合、プロセスを削除しようとすると、「アクティブなジョブが関連付けられているため、このプロセスを変更することはできません。(#1666)」というエラー メッセージが表示されます。これは既定値です。
      For example, if you want to be able to remove your processes while having an associated job running, add <add key="Processes.AllowUpdateWithRunningJobs" value="true" /> in the web.config file.
  • Deployment.Libraries.AllowTenantPublish - ホスト フィードを使用するテナントにそのフィードへのライブラリのアップロードを許可するかどうかを指定できます。次の値を使用できます。
    • true - テナント レベルでアップロードされたライブラリは、ホスト フィードにプロパゲートされます。これが既定値です。
    • false - テナント レベルでアップロードされたライブラリは、ホスト フィードにプロパゲートされません。ただし、ユーザーはフィード内の既存のライブラリにはアクセスできます。

これはユーザー インターフェイスからも設定できます。対応するオプション [テナント ユーザーによるフィードへのアップロードを許可] は、ホスト レベルの [設定] ページにあります。詳細についてはこちらをご覧ください。

認可

📘

注:

Google 認証は、Orchestrator がトップレベルドメインで設定されている場合にのみ機能します。

  • 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 です。

📘

注:

★削除★ 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. It is automatically set according to what you chose during the installation process. By default, it is set to false です。
  • WindowsAuth.Domain - Active Directory ユーザーまたは Active Directory グループを追加するとき、ここで指定されているドメインと双方向の信頼関係にあるフォレストのすべてのドメインとサブドメインを使用できます。このパラメーターで指定できるドメインは 1 つだけです。
  • WindowsAuth.AutoLogin.Enabled - Windows 自動ログインを有効化または無効化します。このパラメーターの値は、インストールまたはアップグレード処理中に設定されます。
  • WindowsAuth.GroupMembershipCacheExpireHours - The amount of time (in hours) after which the cache of AD groups added to Orchestrator expires. This setting is not displayed by default in the web.config file, with the default value being set to 1 hour.
  • WindowsAuth.ConvertUsersAtLogin - If set to true it converts each local user into a directory user after the first login with AD credentials. As an alternative, you can use the script documented here to convert all the local users that have logged in with AD credentials into directory users. This parameter is not displayed by default in the web.config file. It is set to false by default.
  • AcceptedRootUrls - Enables you to add a list of trusted URLs. If no value is attributed to this setting, then no one can access Orchestrator. If you want to add multiple URLs, do it without spaces and separate items through commas (,), such as "https://server1,https://server2" です。
  • Auth.Cookie.Expire - 自動的にログオフになるまでの時間 (分) です。既定では、この値は 30 分に設定されています。
  • Auth.Bearer.Basic.Expire - ベアラー トークンの期限が切れるまでの時間です。既定では、この値は 30 分に設定されています。
  • Auth.Bearer.Robot.Expire - ロボットのベアラー トークンの期限が切れるまでの時間です。既定では、この値は 30 分に設定されています。
  • Auth.Cookie.ValidateInterval - The amount of time (in seconds) until you are logged out after a password reset or after a new session is detected. By default, this is set to 60 seconds. This parameter is not displayed by default in the web.config file. For example, if you want to set it to 20 seconds, add the following key in web.config: <add key="Auth.Cookie.ValidateInterval" value="20"/> です。
  • Auth.DisabledPermissions - Enables you to configure permissions to be disabled from the user interface and ignored when using API. Note that this parameter is hidden by default. The permissions need to be added as they are used in API, and they have to be separated by commas. For example, if you want to disable Delete permissions on Libraries and Machines you need to add the following key in web.config: <add key="Auth.DisabledPermissions" value="Machines.Delete,Libraries.Delete" /> です。
  • Auth.RememberMe.Enabled - Enables you to configure whether the Remember Me check box on the Login page is displayed or not. By default, the parameter is set to true, meaning the check box is displayed. Set it to false to hide it. This setting is not displayed by default in the web.config file.
  • Auth.AllowChangePassword - Enables you to configure whether a user can change his password from the Security section, in the Profile page. This setting is not displayed by default in the web.config file. The following values are available:
    • true - ユーザーは、[プロファイル] ページでパスワードを変更できます。これが既定値です。
    • false - ユーザーは、[プロファイル] ページでパスワードを変更できません。
  • Auth.AllowSelfEmailUpdate - Enables you to configure whether a user can change his email address from the General section, in the Profile page. By default, the parameter is set to true, meaning you can update it. Set the parameter to false to make the field read-only. This setting is not displayed by default in the web.config file.
  • Auth.RestrictBasicAuthentication - Enables you to configure if a user can make an authenticated API request to an Orchestrator instance using basic authentication credentials. This setting is not displayed by default in the web.config file. The following values are available:
    • true - ユーザーは、基本認証資格情報を使用して認証済み要求を行うことはできません。
    • false - ユーザーは、基本認証資格情報を使用して認証済み要求を行うことができます。これが既定値です。
  • Auth.EnableBasicAuthenticationForHostTenant - Enables you to configure if a host admin can make an authenticated API request to the host tenant of an Orchestrator instance using basic authentication credentials. This setting is not displayed by default in the web.config file. The following values are available:
    • true - ホスト管理者は、基本認証資格情報を使用して認証済み要求を行うことができます。これが既定値です。
    • false - ホスト管理者は、基本認証資格情報を使用して認証済み要求を行うことはできません。

This parameter bypasses the Auth.RestrictBasicAuthentication parameter, meaning that if you set Auth.EnableBasicAuthenticationForHostTenant to true and Auth.RestrictBasicAuthentication to true, you can only log in with basic authentication credentials at host level.

  • ExternalAuth.AccessTokenAuth.Enabled - Enables you to configure if you can authenticate to Orchestrator using a bearer access token issued by Auth0. This setting is not displayed by default in the web.config file. The following values are available:
    • true - The user can make authenticated requests using an access token issued by Auth0. This is only taken into account if you set a valid audience for the ExternalAuth.AccessTokenAuth.Audience parameter.
    • false - ユーザーは、Auth0 によって発行されたアクセス トークンを使用して認証済み要求を行うことはできません。これが既定値です。
  • ExternalAuth.AccessTokenAuth.Audience - Enables you to control the target audience of the access token. This parameter needs to be set to a valid audience which is used to check against the Auth0 token audience. For example, if you want to set the audience to https://platform.uipath.com, you need to add the following key in web.config: <add key="ExternalAuth.AccessTokenAuth.Audience" value="https://platform.uipath.com" />. This setting is not displayed by default in the web.config file.
  • WindowsAuth.GroupMembershipCacheExpireHours - Active Directory グループ メンバーシップ キャッシュを構成できます。既定値は 1 で、Active Directory グループ メンバーシップに加えられた変更は、アクティブなユーザー セッションに対して 1 時間ごとに Orchestrator と同期されます。こちらの「動作」セクションをご覧ください。

マルチテナント

  • Tenant.Registration.Enabled - Enables the creation of tenants, from the Login page, so that data can be isolated according to teams. By default, this is set to false. The default value is used in the initial seeding of the database. Changing the value afterwards does not toggle the tenant creation options.

ロード バランサー

この設定は、ロード バランサーを使用している場合にのみ変更してください。

  • 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.ConnectionString - Can only be used if LoadBalancer.UseRedis is set to true. A connection string that enables you to set up your Redis server, which contains the URL of the server, the password, and port used with Redis. It is also possible to enable SSL encrypted connections between the Orchestrator nodes and the Redis service. For more information, please click here. Examples:
    • SSL が有効な場合 <add key="LoadBalancer.Redis.ConnectionString" value="DOCWREDIS02:6379,password=12345678,ssl=true" />
    • SSL が有効でない場合 <add key="LoadBalancer.Redis.ConnectionString" value="DOCWREDIS02:6379,password=12345678" />

Password Vault

These settings should be updated to include the plugins of any credential stores you are using, such as CyberArk or Azure Key Vault. The credential stores plugins are located in the \Orchestrator\Plugins folder of your installation directory. For example:

  • <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll"/>

📘

注:

既存の CyberArk 連携を使用して Orchestrator インスタンスをアップグレードする場合、この設定には CyberArk プラグインが事前に入力されています。他のすべてのインストールでは、設定値は既定で空です。

If multiple credential stores are supported, separate each entry using , または ;. For example:

  • <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll,UiPath.Orchestrator.AzureKeyVault.SecureStore.dll"/>

Azure AD 認証

  • ExternalAuth.AzureAD.Enabled - When set to true, it enables you to use the Azure Active Directory for authentication. By default, it is set to false です。
  • ExternalAuth.AzureAD.ApplicationId - Azure Active Directory に登録された Orchestrator に関連付けられたアプリケーション ID。
  • ExternalAuth.AzureAD.RedirectUri - https://platform.uipath.com など、Azure Active Directory で Orchestrator を登録する際に使用すべき Web アプリ URL です。

📘

重要

同じ Orchestrator インスタンスで Microsoft Azure AD と Windows AD を使用することは推奨していません。

  • ExternalAuth.Saml2.Enabled - When set to true, it enables you to authenticate using SAML 2.0. By default, it is set to false です。

ログ

  • Logs.RequestAbortedLogBehavior - 実行中の操作のキャンセル時にスローされるキャンセル例外のログ動作を指定します。ボタンをクリックして操作が実行される前に別のボタンをクリックしたときなどに、これらは生成されます。このパラメーターは既定では非表示です。次の値を使用できます。
    • Ignore - すべてのキャンセル例外は、対応する要求が中止されると無視されます。これが既定値です。
    • Info - キャンセル例外は、Info 重要度レベルでログされます。
    • None - キャンセル例外は、Error 重要度レベルでログされます。

For example, if you don't want any cancellation exceptions to be logged, add <add key="Logs.RequestAbortedLogBehavior" value="Ignore" /> in the web.config file.

  • Logs.Elasticsearch.SharedIndex - Enables you to log to the same index for all tenants. It must be set to the same value as used for the index parameter in the NLog target. For example, <add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" />. Details here. Note that this parameter is hidden by default.

Webhook

  • Webhooks.Enabled - By default, it is set to true. This setting enables you to enable or disable the webhooks feature. If set to <add key="Webhooks.Enabled" value="false" />, the feature is disabled.
  • Webhooks.Quotas.MaxCountPerTenant - This setting is not displayed by default in the web.config file. The maximum number of webhooks that can be enabled per tenant. By default, they are set to 100. To change the max count to 150 you can, for example, add the following: <add key="Webhooks.Quotas.MaxCountPerTenant" value="150" /> です。
  • Webhooks.Requests.Timeout - This setting is not displayed by default in the web.config file. The amount of time after which each HTTP request is canceled. Please note that each request that times out is retried, according to the Webhooks.Requests.RetryAfter parameter. By default, the timeout time is set to 15 seconds.
  • Webhooks.Requests.RetryAfter - This setting is not displayed by default in the web.config file. The amount of time, in seconds, after each failed request is retried. It is populated as a comma-separated list of integers, and is, by default set to 0, 15, 60, meaning that there are a maximum of 3 retries as follows:
    • 1 回目のリトライは、最初の試行が失敗した直後に実行されます。
    • 2 回目のリトライは、1 回目のリトライが失敗してから 15 秒後に実行されます。
    • 3 回目のリトライは、2 回目のリトライが失敗してから 60 秒後に実行されます。
      It is possible to change the number of delays. For example, if you write <add key="Webhooks.Requests.RetryAfter" value="0,10" />, you have only two retries, the first being immediate, while the second after 10 seconds. We recommend that you always set the first retry to 0, and never set time amounts greater than 300 seconds (5 minutes).
  • Webhooks.Quotas.MaxPayloadSize - This setting is not displayed by default in the web.config file. It represents the maximum number of bytes a JSON payload (UTF-8) can have, 1048576 being the default value. Any webhook event whose payload size is greater than the limit is dropped.
  • Webhooks.Quotas.MaxParallelRequests - The maximum number of webhooks a single CPU core should handle. By default, it is set to 100 per CPU core. This setting is not displayed by default in the web.config file.

スケーラビリティ

  • Scalability.Heartbeat.PeriodSeconds - The time interval, expressed in seconds, at which the Robot sends a heartbeat to Orchestrator, letting the latter know its status. By default, it is set to 30 seconds.
  • Scalability.Heartbeat.FailureThreshold - The number of successively failed heartbeats send by a Robot until it is marked as unresponsive in Orchestrator. By default, it is set to 4, meaning that after 2 minutes of failed heartbeats (4 x 30 seconds = 2 minutes) a Robot is flagged as unresponsive.
  • Scalability.SignalR.Enabled - Specifies if the Robot service should subscribe to Orchestrator's SignalR channels. By default, it is set to true. This parameter is used in the initial seeding of the database. To make changes after installation, use the Settings page, at tenant or host level.
  • Scalability.SignalR.Transport - Orchestrator の SignalR チャネルに使用するトランスポート プロトコルをを指定します。これに属するのは次の値です (任意の組み合わせ - 論理和):
    • WebSocketTransport = 1
    • ServerSentEventsTransport = 2
    • LongPollingTransport = 4
    • 既定値: 7 (WebSocketTransport | ServerSentEventsTransport | LongPollingTransport)
      This parameter is used in the initial seeding of the database. To make changes after installation, use the Settings page, at tenant or host level.
  • Scalability.SignalR.AuthenticationEnabled - If set to true, enables the Robot SignalR authentication method, a method that ensures a secure communication between Orchestrator and Robot. This feature is disabled by default - set to false. Please note that if you enable this feature, you cannot execute jobs on Robots with a version lower than 2018.4.4.
  • Scalability.AzureSignalR.ConnectionString - Helps you enable Azure SignalR Service, facilitating a direct communication between your Robot fleet and the SignalR Service - Orchestrator no longer intermediates it. This option should be used only if you have an Azure-hosted Orchestrator instance. Can be used in conjunction with the Scalability.AzureSignalR.ConnectionCount key. This parameter is enabled in our Cloud offering. It is not displayed by default in the web.config file.
    Please note that, if enabled, Robots with a version lower than 2019.2 rely only on the Heartbeat protocol to communicate to Orchestrator, meaning that any command given from Orchestrator is picked up by a Robot only every 30 seconds. To enable this parameter, populate its value with the connection string to Azure Service. Example: <add key="Scalability.AzureSignalR.ConnectionString" value="Endpoint=https://test.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;" /> です。
  • Scalability.AzureSignalR.ConnectionCount - Enables you to change the number of connections (per hub) between the server and Azure SignalR Service. The default value is 5. Example: <add key="Scalability.AzureSignalR.ConnectionCount" value="7" />. This setting is not displayed by default, and cannot be used without the Scalability.AzureSignalR.ConnectionString key.

Insights

  • Insights.TableCreationRetryCount - Enables you to set the maximum number of retry attempts for new table creation. By default the value is set to 3 です。
    Note: This setting is optional and not displayed by default in the web.config file.
  • Insights.TableCreationRetryBackoffSeconds - The amount of time, in seconds, between retry attempts. By default the value is set to 60 です。
    Note: This setting is optional and not displayed by default in the web.config file.

分析

  • Telemetry.Enabled - UiPath が問題の診断および Orchestrator の改善を目的として行う使用状況とパフォーマンスに関するデータの収集を有効化/無効化します。UiPath プライバシー ポリシーのプラクティスについては、プライバシー ステートメントをご覧ください。次の値を使用できます。
    • true - テレメトリ機能は有効です。これが既定値です。
    • false - テレメトリ機能は無効です。
      It is also possible to opt in or out of the performance and usage data collection when you install or update your Orchestrator instance, as described here.

メディア レコーディング

  • MediaRecording.Enabled - Set it to true to enable the recording feature. By default, it is set to false, meaning the feature is disabled. File storage is impacted by the NuGet.Repository.Type parameter, and configured using the Storage.Type and Storage.Location parameters when NuGet.Repository.Type is set to Composite です。

ページネーション

  • Pagination.Limits.Enabled - Set to true by default for Cloud Platform and clean installs of on-premise Orchestrator instances. Adds a default $top value for all calls to API endpoints with pagination parameters (e.g. odata/Users など)。

セキュリティで保護されたアプリ設定

  • EncryptionKey - 資格情報アセットのパスワードの保護に使用される暗号化キーです。ネットワーク ロード バランサーのある環境を使用している場合は、すべてのサーバーでこのキーを同一にする必要があります。

The following parameters enable you to set up your Azure Key Vault, where you can store your tenant-based encryption keys. Please note that these parameters can be used only if EncryptionKeyPerTenant.Enabled is set to true, and EncryptionKeyPerTenant.KeyProvider set to AzureKeyVault. Additionally, ensure that you provide all key, secret, and certificate permissions to your Orchestrator instance, in the Access policies of your Azure Key Vault. For the full procedure, please see this page.

  • Azure.KeyVault.ClientId - The application ID of your Orchestrator instance. This can be found in Azure in App Registrations and should have the ae11aa1a-1234-1234-a123-a12a12aaa1aa format. This setting is not displayed by default in the web.config file. Example: <add key="Azure.KeyVault.ClientId" value="ae11aa1a-1234-1234-a123-a12a12aaa1aa" /> です。
  • Azure.KeyVault.CertificateThumbprint - The thumbprint generated by Azure for the Orchestrator certificate. You can find this value in Azure in App Services > Your instance > SSL Settings > Private Certificates (or Public Certificates). This setting is not displayed by default in the web.config file. Example: <add key="Azure.KeyVault.CertificateThumbprint" value="1234123412341234123412341234124312341234" /> です。
  • Azure.KeyVault.VaultAddress - The DNS name of your Azure Key Vault. This can be found in the Overview of your vault, in the DNS Name field, and should have the https://CustomVaultName.vault.azure.net/ format. This setting is not displayed by default in the web.config file. Example: <add key="Azure.KeyVault.VaultAddress" value="https://CustomVaultName.vault.azure.net/" /> です。

その他

  • PreventAutoRefresh.Enabled - Control whether or not the Jobs page under the Monitoring menu auto-refreshes for each newly created job. The <add key="PreventAutoRefresh.Enabled" value="true" /> key can be added to restrict auto-refreshing of the page when jobs are running. The key is not displayed by default and the default value is false meaning Orchestrator auto-refreshes the page for each new job.
    The page is updated when filters are applied or job states change, irrespective of the PreventAutoRefresh.Enabled parameter.
  • Features.LongRunning.Enabled - Enables you to configure whether long running workflows are supported in your instance or not. Add the following key in web.config to enable it: <add key="Features.LongRunning.Enabled" value="true" /> です。
  • Tasks.ModuleEnabled - Enables you to configure whether the Tasks feature is enabled in your instance. Add the following key in web.config to enable it: <add key="Tasks.ModuleEnabled" value="true" />. This setting makes the feature available at instance level. To configure it on a per-tenant basis, follow the steps here. The Features.LongRunning.Enabled parameter needs to be set to true in order for this setting to take effect.
  • ActiveDirectory.SearchInputMinimumLength - The minimum query size which triggers the search. The default value is 2, meaning the search is performed after you fill in a minimum of 2 characters. This parameter is not displayed by default in the web.config file. Example: <add key="ActiveDirectory.SearchInputMinimumLength" value="4" /> です。
  • ActiveDirectory.SearchResultsSizeLimit - The maximum number of results returned when searching for AD users or groups. It is by default set to 20. This parameter is not displayed by default in the web.config file. Example: <add key="ActiveDirectory.SearchResultsSizeLimit" value="30" /> です。
  • ActiveDirectory.SearchResultsTimeLimitSeconds - The maximum allowed search time of a query, meaning that whenever this limit is exceeded, searching is interrupted and the results found until then are returned. It is by default set to 30 seconds. This parameter is not displayed by default in the web.config file. Example: <add key="ActiveDirectory.SearchResultsSizeLimit" value="40" /> です。
  • OData.BackwardsCompatible.Enabled - Enables you to control how special characters are parsed in the Orchestrator API. If set to true, special characters in the body of requests and responses are parsed. By default, this parameter is hidden and set to false です。
  • NotRespondingRobotsJobStartDelay - Enables you to set a delay, in seconds, of the first check performed on your Robots' status after an upgrade. This parameter is not displayed by default in web.config です。
  • Upload.Queues.MaxNumberOfItems - Enables you to lower the maximum number of items which can be uploaded at once using the bulk upload functionality. The default value is 15000. Please note that this parameter is not displayed by default in web.config です。
  • Processes.FilterOutDeleted - Orchestrator によるプロセスの取得方法を最適化できます。最適化は、関連するパッケージが削除された孤立プロセスに対する不要な検証を排除することで実現します。これにより、特に大規模デプロイにおいて、インスタンスの全体的なパフォーマンスが向上します。次の値を使用できます。
    • false - パッケージ取得を最適化し、孤立したプロセスに対する検証を実行しません。
    • true - パッケージ取得を最適化しません

Note that this parameter is hidden and set to true by default, meaning process retrieval is not optimized.

system.webServer

HTTP 圧縮

The element below enables the compression of dynamic content, respectively large downloadable .csv reports, in Orchestrator. By default, this feature is enabled - set to true. To disable it change the value of the enabled attribute to false です。

<httpCompression>
  <dynamicTypes>
    <remove mimeType="text/csv" />
    <add mimeType="text/csv" enabled="true" />
  </dynamicTypes>
</httpCompression>

ログの構成

ロボット ログ

This is the corresponding web.config key: <logger name="Robot.*" writeTo="database,robotElasticBuffer" final="true" />. It is used to configure log messages generated by Robots. The following parameters have to be configured:

  • writeTo - ロボットが生成したログ メッセージが書き込まれる場所です。次の値を使用できます。
    • database - ログは Orchestrator の SQL データベースに送られます。これは既定値の 1 つです。
    • robotElasticBuffer - Logs are sent to Elasticsearch. This is the second default value. Please remember this requires additional settings. Details here.
      Orchestrator の SQL データベースと Elasticsearch の両方にログを送信することで、否認不可のログを保持できます。この場所へのログの送信を停止するには、これらの値のいずれかを削除します。
  • final - A flag that indicates what to do when a match between a logged message and the logger name is found. When set to true, it does not look for another match. When set to false, other rules matching the same source are checked. By default, it is set to true です。

スケジュールログ

This is the corresponding web.config key: <logger name="Quartz.*" minlevel="Info" writeTo="eventLogQuartz" final="true" />. It is used to configure log messages generated by schedules.

📘

注:

To ensure a smooth run for schedules in an Orchestrator setup with a load balancer you should also set the quartz.jobStore.clustered parameter to true です。

ログの監視

This is the corresponding web.config key: <logger name="Monitoring.*" writeTo="monitoring" minlevel="Warn" final="true" />. It is used to configure the error logs displayed on the Monitoring page. Please note if you remove this rule or alter the target, no error logs will display on the Monitoring page.

ビジネス例外ログ

This is the corresponding web.config key: <logger name="BusinessException.*" minlevel="Info" writeTo="businessExceptionEventLog" final="true" />. It is used to configure the logs for thrown business exceptions. For example validation issues (e.g Invalid username) or business conflicts (e.g. License expired など)。

他のログ

This is the corresponding web.config key: <logger name="*" minlevel="Info" writeTo="eventLog" />. It is used to configure all other logs besides the ones described above, including those generated by Orchestrator.

📘

注:

SQL データベース内に 200 万を超えるログを保持すると、パフォーマンスの問題が発生する場合があります。そのことも考慮し、Elasticsearch を使用することをお勧めします。

その他の設定

Elasticsearch

Elasticsearch の設定に従って、次の NLog ターゲットの情報を読み込む必要があります。

<target xsi:type="ElasticSearch" name="robotElastic" uri="<elasticSearch_url_1>,<elasticSearch_url_2>, <elasticSearch_url_3>" index="${event-properties:item=indexName}-${date:format=yyyy.MM}" documentType="logEvent" includeAllProperties="true" disablePing="true" layout="${message}" excludedProperties="agentSessionId,tenantId,organizationUnitId,indexName" />
  • uri - the Elasticsearch URL; note that you have to include the protocol and port, such as http://elastic_server:9200. You can remove the need for a load balancer by populating this parameter with the Elasticseach URL of each node, such as uri="http://elastic-node1:9200,http://elastic-node2:9200,http://elastic-node3:9200" です。
  • excludedProperties - Elasticsearch に保存しないデータです。
  • index - ログ インデックスの形式。テナントごとに一意にすることも、すべてのテナントで共有することもできます。以下の詳細をご覧ください。

インデックスの構成

  • Individual Index - index="${event-properties:item=indexName}-${date:format=yyyy.MM}" - A separate index is used for each tenant, meaning that logs specific to one tenant are generated and retrieved based on a unique tenant identifier, in this case, indexName which defaults to the name of the tenant. This is the default configuration. In this case, logs are generated per month.

  • Shared Index - index="robotlogs-${date:format=yyyy.MM.dd}" - One index is used for all tenants, meaning that all logs, regardless of tenant, use the same index. In this case, logs are generated per day. To use a shared index, you are also required to add the following key in web.config: <add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" />. Mare sure to set it to the same value as for the index parameter in the NLog target.

🚧

重要

共有インデックスに移行すると、個々のインデックスを使用して生成されたログが保持されます。ただし、個別のインデックスに移行すると、共有インデックスを使用して生成されたログは失われます。

データベースのイベントのログ記録

システム イベント ログをイベント ビューアーではなくデータベースに保存するには、次の手順を実行します。

  1. 新しいデータベース テーブルを作成します。例:
CREATE TABLE [dbo].[EventLogs](
    [Id] [bigint] IDENTITY(1,1) NOT NULL,
    [Timestamp] [datetime] NOT NULL,
    [Level] [int] NOT NULL,
    [Message] [nvarchar](max) NULL,
    [Exception] [nvarchar](max) NULL)

In the above query, we create a table named EventLogs with the following columns:

  • Id - to hold an ID number for each log, here starting with 1 and incrementing the value with each log added;
  • Timestamp - 各イベントがログ記録された時間を保持します。
  • Level - 各イベントの数値ログ レベルを保持します。
  • Message - 該当する場合、各イベントのメッセージを保持します。
  • Exception - 該当する場合、各イベントに対してログに記録された例外を保持します。

📘

注:

表に任意の名前を使用し、上記のクエリから列を削除するか、ニーズに合わせて他の列を追加できます。

  1. In the web.config file, add a new NLog target:
<target xsi:type="Database" connectionStringName="Default" name="eventLogDatabase" keepConnection="true">
        <commandText>
          INSERT INTO dbo.EventLogs (Timestamp, Level, Message, Exception)
          VALUES (@timestamp, @level, @message, @exception)
        </commandText>
        <parameter name="@timestamp" layout="${date:format=yyyy-MM-dd HH\:mm\:ss.fff}" />
        <parameter name="@level" layout="${event-properties:item=levelOrdinal}" />
        <parameter name="@message" layout="${message}" />
        <parameter name="@exception" layout="${onexception:${exception:format=tostring:maxInnerExceptionLevel=5:innerFormat=tostring}}" />
</target>

Defining a corresponding parameter for the data to be added in each database column, in this example @timestamp @level @message, and @exception です。

  1. 最後に、次を追加して、新しく作成されたターゲットを、上記のすべての Orchestrator メッセージの NLog ロガー分類に関連付けます。
<logger name="*" minlevel="Info" writeTo="eventLog,eventLogDatabase" />

NLog のデバッグを有効化する

NLog は、設定が簡単で拡張性のあるオープンソースのログ プラットフォームで、さまざまな .NET プラットフォームに使用できます。NLog を使用して、ローカル ファイル、イベント ログ、メール、データベースなど、任意の数の事前定義済みターゲットやカスタム ターゲットに、ログ データを格納したり、渡したりすることができます。

Though there exists some overlap, NLog and Orchestrator have several differentiating logging levels. For NLog you can select either Trace Debug Info Warn Error Fatal, or Off. See Logging Levels for a description of the available levels in Orchestrator.

You can enable debugging in NLog to ensure that it is functioning properly. By default NLog is set to Off, it is enabled by configuring the following section of the web.config file:

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" throwExceptions="false" internalLogLevel="Off" internalLogFile="">

次の属性の設定が必須です。

  • internalLogLevel - 望ましいログ レベル
  • internalLogFile - ログ ファイルの場所

例:

<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" autoReload="true" throwExceptions="false" internalLogLevel="Debug" internalLogFile="C:\logs.txt">

📘

注:

The user profile under which Orchestrator is running must have access to the path specified in the internalLogFile 属性の時間単位です。

1 年前に更新



Web.Config


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。