通知を受け取る

UiPath 製品のインストールとアップグレード

UiPath 製品のインストールとアップグレード ガイド

⚙ UiPath.Orchestrator.dll.config

★削除★ UiPath.Orchestrator.dll.config file (C:\Program Files (x86)\UiPath\Orchestrator) defines the parameters, settings, and preferences applied to your Orchestrator deployment.

📘

注:

これらのパラメーターの値は管理者のみが変更してください。

It is recommended to manually restart the website after making changes to UiPath.Orchestrator.dll.config です。

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

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

アプリの設定

インストールの詳細設定


EncryptionKeyPerTenant.Enabled

Microsoft Azure Key Vault アカウントに基づき、テナントごとに異なる暗号化キーを使用できます。次の値を設定できます。

  • false - Orchestrator インスタンス全体で 1 つの暗号化キーを使用します。これが既定値です。
  • true - テナントごとに異なる暗号化キーを使用します。テナントのセキュリティを強化し、機密データをより適切に分離します。

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 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, this parameter is not used.

ここで行った暗号化の設定に対する変更は、Identity Server の appsettings.Production.json ファイルにも同様に反映させる必要があります。対応するフィールドの組み合わせは以下のとおりです。

Orchestrator UiPath.Orchestrator.dll.config

Identity Server appsettings.Production.json

EncryptionKeyPerTenant.Enabled

EncryptionKeyPerTenant

Azure.KeyVault.VaultAddress

AzureKeyVaultAddress

Azure.KeyVault.CertificateThumbprint

AzureKeyVaultCertificateThumbprint

Azure.KeyVault.ClientId

AzureKeyVaultClientId

Azure.KeyVault.DirectoryId

AzureKeyVaultDirectoryId

EncryptionKeyPerTenant.KeyProvider

MultiTenantEncryptionKeyProvider

キュー


📘

注:

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

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 UiPath.Orchestrator.dll.config, including in update scenarios.

Queue.MaxSchemaFileSizeInKilobytes

The maximum file size of the JSON schema against which queue item data and output is validated, in KB. This setting does not appear by default in the UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config です。

Queue.MaxSpecificDataSizeInKiloBytes

新しいキュー アイテムの固有データの内容の最大サイズ (KB)。Orchestrator のクリーン インストールの場合、このパラメーターは表示されず、既定値の 1024 (1MB) が設定されます。アップグレードのシナリオではこのパラメーターが表示され、値は 204800 (200MB) に設定されます。

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 afterward 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 UiPath.Orchestrator.dll.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 the 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 to reduce the email alerts' frequency. For example, this can be done by adding the following key in the UiPath.Orchestrator.dll.config file: <add key="SystemJobs.LicenseExpirationAlert.DaysBefore" value="90,30,14" /> です。

デプロイ


Orchestrator uses a composite repository. 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.

📘

注:

パッケージ専用のフォルダーでは、コピー/貼り付けコマンドを使用できません。

Storage.Type

パッケージまたは実行メディアが保存されるターゲットを定義します。次のターゲットで設定できます。

  • FileSystem - <add key="Storage.Type" value="FileSystem" /> です。
  • Azure - <add key="Storage.Type" value="Azure" /> です。
  • Amazon - <add key="Storage.Type" value="Amazon" /> です。
  • Minio - <add key="Storage.Type" value="Minio" /> です。

Storage.Location

パッケージと実行メディアが保存される実際の場所を定義します。

🚧

重要

★削除★ Storage.Location parameter is mandatory when:

  • Orchestrator の 2020.10 よりも前のバージョンからのアップグレードであり、かつ
  • the previous NuGet.Repository.Type was Legacy, and
  • the previous NuGet.Packages.Path did not use the default value.

Target

Location

FileSystem

Provide an absolute path using the following format: RootPath=C:\FolderName\AnotherFolderName.
Example: <add key="Storage.Location" value="RootPath=C:\FolderName\AnotherFolderName" />.

In the provided folder, the following folder structure gets created:
Orchestrator-Host\Libraries - One folder dedicated to the libraries stored in the host feed.
Orchestrator-[tenantKey] -One folder for each tenant. The tenant is identified by the tenant key as found in the database. For example Orchestrator-12ab1234-a567-456b-a12b-ab3456b123ab.
For each tenant folder, three other sub-directories are created:
\ExecutionMedia
\Packages
\Libraries

Files are saved in the dedicated folders at the specified location. By default, they are stored at the following path: C:\Program Files (x86)\UiPath\Orchestrator\Storage.

Azure

Provide a connection string.
Example: <add key="Storage.Location" value="DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" />.

Amazon

Provide a connection string.
Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=W/LOzDbI1qumvcwYs8iUf4pRwW6ltKos/paTLVYM;useHttp=false" />.

Minio

Provide a connection string.
Example: <add key="Storage.Location" value="host=localhost:9001;accessKey=YVKYFJ0ZY246KDKP0634;secretKey=bdBEk2ubhIFsTNPuQ80PjKL+oqZBj67HoSWBFnw1" />.

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

The license key of your NuGet account. If the activities and packages are stored in the same NuGet feed, this parameter's value 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.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 の使用を推奨します。

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 UiPath.Orchestrator.dll.config file.

Deployment.Libraries.AllowTenantPublish

ホスト フィードを使用するテナントにそのフィードへのライブラリのアップロードを許可するかどうかを指定できます。次の値を使用できます。

  • true - テナント レベルでアップロードされたライブラリは、ホスト フィードにプロパゲートされます。これは既定値です。
  • false - テナント レベルでアップロードされたライブラリは、ホスト フィードにプロパゲートされません。ただし、ユーザーはフィード内の既存のライブラリにはアクセスできます。

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

ストレージ バケット


Buckets.ContentSecurityPolicy

Used to indicate domains outside the trusted ones to which Orchestrator can make requests. Multiple values can be entered as a comma-separated list. This parameter overrides the corresponding Orchestrator settings regarding Azure and AWS, so make sure to add Azure and/or AWS as well, if needed. This parameter does not appear by default in the UiPath.Orchestrator.dll.config file.

Buckets.AvailableProviders

Used to control which providers can be used in creating storage buckets. The available providers are: Orchestrator Amazon Azure Minio, and FileSystem. Multiple values can be entered with a comma separator.
Note: By default, this key is not displayed in the UiPath.Orchestrator.dll.config file, and only the following providers are selected: Orchestrator Amazon Azure, and Minio. The default behavior is specific to both clean installations and upgrades. If the key is visible, the available providers are limited to those specified as Buckets.AvailableProviders values.
Example: To restrict the use of Minio, add the following key:

<add key="Buckets.AvailableProviders" value="Orchestrator,Amazon,Azure" />

Buckets.FileSystem.Allowlist

Provides a way to control the use of FileSystem buckets. The setting comes with no value configured by default. This, along with the fact that FileSystem is disabled by default on both new installations and upgrades, means that no FileSystem paths can initially be used. For security reasons, in order to use the FileSystem feature, an Administrator must first enable FileSystem, and then explicitly allow access to a list of folders or network shares by attributing values to Buckets.FileSystem.Allowlist です。
Multiple values, separated by the | character, can be entered. Note that the paths must be fully qualified, either rooted with a drive or a UNC path (e.g. c:\ c:\test \\servershare\shared), and each of them represents a prefix allowed to be used for any bucket. A bucket can be created on that particular path or any subpath.

🚧

重要

Considering that creating a FileSystem allowlist via the Buckets.FileSystem.Allowlist setting has a series of security implications, you are strongly advised to refer to Using the FileSystem Storage Allowlist Securely before proceeding.

認可


外部認証プロバイダーの設定についての説明は、Identity Server の「外部 ID プロバイダー」ページに移動しました。

📘

注:

★削除★ 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's user import functionality. To enable the authentication using Windows Active Directory, please configure the External Providers in Identity Server.

WindowsAuth.Domain

Active Directory ユーザーまたは Active Directory グループを追加する際に、ここで指定するドメインと双方向の信頼関係にあるフォレストのすべてのドメインとサブドメインを使用できるようになります。このパラメーターで指定できるドメインは 1 つだけです。

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 UiPath.Orchestrator.dll.config file, with the default value being set to 1 hour.

WindowsAuth.ConvertUsersAtLogin

If set to true, it converts each local AD 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 AD users that have logged in with AD credentials into directory users. This parameter is not displayed by default in the UiPath.Orchestrator.dll.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.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 UiPath.Orchestrator.dll.config file. For example, if you want to set it to 20 seconds, add the following key: <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: <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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config file.

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 UiPath.Orchestrator.dll.config file. The following values are available:

  • true - The user can make authenticated requests using an access token issued by Auth0. This is only considered 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://cloud.uipath.com, you need to add the following key: <add key="ExternalAuth.AccessTokenAuth.Audience" value="https://cloud.uipath.com" />. This setting is not displayed by default in the UiPath.Orchestrator.dll.config file.

ExternalAuth.ShowPII

Allow for Orchestrator PII display by adding the following key: <add key="ExternalAuth.ShowPII" value="true" />. The key is not displayed by default in UiPath.Orchestrator.dll.config, and the default behavior does not allow for PII display.

WindowsAuth.GroupMembershipCacheExpireHours

Enables you to configure the AD group membership cache. The default value is 1, meaning changes made to AD group membership are synced with Orchestrator once every hour for active user sessions. See Behavior section here.

RestrictBasicAuthentication

Moved to Identity Server appsettings.json.

EnableBasicAuthenticationForHostTenant

Moved to Identity Server appsettings.json.

ロード バランサー


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

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 the 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


Plugins.SecureStores

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

  • Single Store: <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll"/>
  • Multiple Stores: <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll,UiPath.Orchestrator.SecureStore.CyberArkCCP.dll,UiPath.Orchestrator.AzureKeyVault.SecureStore.dll"/>

📘

注:

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

Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath

Enables the CyberArk plugin to search for CLIPasswordSDK64.exe in a custom installation path. For example, if D:\CustomFolder\ is the CyberArk installation directory, you need to add the following key: <add key="Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath" value="D:\CustomFolder\CLIPasswordSDK64.exe"/>. The default value of this app setting is C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK64.exe です。

Plugins.SecureStores.CyberArk.UsePowerShellCLI

Enables retrieving credentials from a CyberArk vault when using Path authentication. The key is hidden by default. The default value is false. Add the following key to enable it: <add key="Plugins.SecureStores.CyberArk.UsePowerShellCLI" value="true"/> です。

Azure AD 認証


The configuration for Azure AD authentication has been moved to Identity Server's External Providers page.

ログ


Logs.RobotLogs.ReadTarget

Enables you to configure the source from which Orchestrator reads and populates logs (e.g., database または robotelasticbuffer など)。

RobotsLogs.Flush.Interval

This setting allows you to change the flush interval for the SubmitLogs endpoint. Note that it is not displayed by default in UiPath.Orchestrator.dll.config. Unless specified otherwise, its value is 0 seconds. The following example shows how to set a flush interval of 60 seconds, which means that the Robot sends logs to the server every 60 seconds.

<add key="RobotsLogs.Flush.Interval" value="60" />

🚧

重要

フラッシュ間隔が完了する前に Robot を切断した場合、次回 Orchestrator に接続されるときに前回のログのバッチが送信されます。

RobotsLogs.Flush.BatchSize

This setting's purpose is to adjust the flush size for the SubmitLogs endpoint. By default, it is not displayed in the UiPath.Orchestrator.dll.config. Unless specified otherwise, its value is 100 log message entries, which translates to the Robot sending batches of 100 logs to the server.

<add key="RobotsLogs.Flush.BatchSize" value="100" />

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

Logs.Elasticsearch.EnableFolderIdFilter

Control the visibility of logs generated prior to 2019.10 that cannot be filtered by the containing folder on the Logs page. The parameter is set to true by default, meaning logs are hidden. Set it to false to display them: <add key="Logs.Elasticsearch.EnableFolderIdFilter" value="false" />

Webhook


Webhooks settings have been moved to Webhooks Service's appsettings.json 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 sent 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)

このパラメーターは、データベースの初期シーディングで使用されます。インストール後に変更を加えるには、テナントまたはホスト レベルの [設定] ページを使用します。

Scalability.AzureSignalR.ConnectionString

各種ロボットと SignalR Service 間の直接通信を容易にするために Azure SignalR Service を有効化できるようにします。
Orchestrator no longer intermediates it. This option should be used only if you have an Azure-hosted Orchestrator instance. It 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 UiPath.Orchestrator.dll.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.

Scalability.SignalR.RequireStickySessions

Enable sticky sessions. If set to true, all transports are enabled, and Orchestrator assumes sticky sessions are enabled on the load balancer. Enabling sticky sessions in UiPath.Orchestrator.dll.config without enabling them on the load balancer will result in failed SignalR connections.

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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config file.

Insights.Ingestion.QueryTimeout

The SQLServer timeout for queries running against the Orchestrator database to populate the Insights database. The setting is not displayed by default in UiPath.Orchestrator.dll.config file. You should consider updating it if you encounter timeout errors on the background job that does ingestion for Insights from Orchestrator SQLServer.

分析


Telemetry.Enabled

Enables or disables the usage and performance data collection that UiPath uses to help diagnose problems and improve Orchestrator. For more details about UiPath’s privacy practices, please review the privacy statement. The following values are available:

  • true - テレメトリ機能は有効です。これが既定値です。
  • false - テレメトリ機能は無効です。

こちらの説明にあるように、パフォーマンスや使用状況のデータ収集オプションのオン/オフは、Orchestrator インスタンスをインストールまたは更新するときにも設定できます。

メディア レコーディング


MediaRecording.Enabled

Set it to false to disable the recording feature. By default, it is set to true, meaning the feature is enabled. The storage is defined using the Storage.Type and Storage.Location parameters.

ページネーション


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 など)。

トリガー


Triggers.DisableWhenFailedCount

You can configure a trigger to get disabled automatically after a certain number of failed launches and no successful runs occurring in a specific number of days. In this context, Triggers.DisableWhenFailedCount allows you to adjust the number of failed runs whereas Triggers.DisableWhenFailingSinceDays enables you to change the number of days. By default, the Triggers.DisableWhenFailedCount value is 10, and the Triggers.DisableWhenFailingSinceDays value is 1, which means that the trigger is disabled after 10 unsuccessful attempts to launch if there were no successful runs in the past day.
To stop triggers from being disabled when they fail, you must set Triggers.DisableWhenFailedCount to 0.

Triggers.JobsCountStrategy

トリガーを通じて開始されたジョブのカウント方法を選択できます。既定では非表示です。次のオプションを使用できます。

  • PerProcess - A trigger launches the required number of jobs taking into account any pending jobs for the specified process. E.g., two triggers defined for the same process launch 3 and 5 jobs, respectively. If the first trigger launches 3 jobs at a given point in time, when the second trigger is set off, 2 jobs are launched so as to reach the 5 required jobs. Add the following key in the config file to use this strategy: <add key="Triggers.JobsCountStrategy" value="PerProcess" />. This is the default value.
  • PerTrigger - A trigger launches the required number of jobs taking into account any existing jobs previously launched by that same trigger. E.g., a trigger is defined to launch 9 jobs at a given point in time. If 2 jobs have been successfully completed by the time this trigger is set off again, Orchestrator launches another 2 jobs so as to reach the 9 required jobs. Add the following key in the config file to use this strategy: <add key="Triggers.JobsCountStrategy" value="PerTrigger" /> です。
  • NoLimit - The trigger launches the required number of jobs irrespective of any existing, pending jobs. E.g., a trigger is defined to launch 5 jobs at a given point in time. The second time the trigger is set off, another 5 jobs are launched. Add the following key in the config file to use this strategy: <add key="Triggers.JobsCountStrategy" value="NoLimit" /> です。

その他


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.

QueueActivation.TriggerCache.Expiration.Minutes

キュー トリガーが関連付けられているキューに対する、簡易 Quartz トリガーの生成方法を制御します。

  • If set to 0, a quartz trigger is generated for each item added in a queue.
  • If set to a value larger than 0, the system checks if there’s already a quartz trigger created for that queue and prevents it from creating another one. The restriction is removed when the Queue Trigger conditions are met. If the Queue Trigger fails to do this, the restriction is removed according to the value set for the QueueActivation.TriggerCache.Expiration.Minutes parameter. The default value is 5 です。

DefaultFolderIsClassic

Control if the classic folders model is enabled. By default, it is set to false meaning classic folders are disabled, and only modern folders are available.

Jobs.TerminatingJobsTimeout

Configure the time elapsed until Terminating jobs become fit to be marked as Failed. The default value is 1440, meaning jobs can't be marked as Failed unless they have been in a Terminating state for at least one day. This parameter is hidden by default.

Jobs.TerminatingJobsCleanupCron

Configure a cron expression that controls the frequency of the background job marking Terminating jobs as Failed. Jobs can't be marked as Failed unless they have been in a Terminating state for at least the duration set in the Jobs.TerminatingJobsTimeout parameter. The default values are 0 0 0/3 1/1 * ? * for Jobs.TerminatingJobsCleanupCron, and 1440 for Jobs.TerminatingJobsTimeout, meaning the background job runs once every three hours and only transitions to Failed the jobs that have been in a Terminating state for at least one day. This parameter is hidden by default.

PW.StopExploringCron

Configure a cron expression that controls the frequency of a background job that checks if the users exploring personal workspaces still have the required permissions (View and Edit on Folders) to explore them. The default value is 0 25 * ? * * meaning the background job runs at minute 25 of every hour. If they do not have the required permissions, the explore sessions are terminated. This parameter is hidden by default.

Features.LongRunning.Enabled

Configure whether long running workflows are supported in your instance or not. Add the following key to enable it: <add key="Features.LongRunning.Enabled" value="true" /> です。

Tasks.ModuleEnabled

Configure whether the Actions feature is enabled in your instance. Add the following key to enable it: <add key="Tasks.ModuleEnabled" value="true" />. This setting makes the feature available at the 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 for this setting to take effect.

Features.SmartCardAuthentication.Enabled

Configure whether smartcard authentication is enabled in your instance or not. Add the following key to enable it: <add key="Features.SmartCardAuthentication.Enabled" value="true" /> です。

ActiveDirectory.SearchInputMinimumLength

The minimum query size which triggers the search. The default value is 2, meaning the search is performed after filling in a minimum of 2 characters. This parameter is not displayed by default in the UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config file. Example: <add key="ActiveDirectory.SearchResultsSizeLimit" value="30" /> です。

ActiveDirectory.SearchResultsTimeLimitSeconds

The maximum allowed search time of a query, meaning that searching is interrupted whenever this limit is exceeded, 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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config です。

Upload.Queues.MaxNumberOfItems

Enables you to lower the maximum number of items that 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 UiPath.Orchestrator.dll.config です。

Processes.FilterOutDeleted

Orchestrator によるプロセスの取得方法を最適化できます。最適化は、関連するパッケージが削除された孤立プロセスに対する不要な検証を排除することで実現します。これにより、特に大規模デプロイにおいて、インスタンスの全体的なパフォーマンスが向上します。次の値を使用できます。

  • false - パッケージの取得を最適化し、孤立したプロセスに対する検証を実行しません。
  • true - パッケージ取得を最適化しません

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

CertificatesStoreLocation

Specify the certificate for your Orchestrator instance is installed on the local machine certificate store using the following setting: <add key="CertificatesStoreLocation" value="LocalMachine" />. Make sure that AzureKeyVaultCertificateStoreLocation in appsettings.Production.json has the same value.

ProxyIntegration.Enabled

Provides a way to control the proxy integration. By default, the parameter is not displayed in UiPath.Orchestrator.dll.config, and its value is set to true, which means that proxy integration is enabled unless otherwise specified. Use to disable proxy integration.

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


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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.config file. Example: <add key="Azure.KeyVault.VaultAddress" value="https://CustomVaultName.vault.azure.net/" /> です。

Azure.KeyVault.DirectoryId

Indicate the directory ID of your organization as displayed in the Azure portal. Mandatory if you store per-tenant encryption keys in Azure Key Vault. Example: <add key="Azure.KeyVault.DirectoryId" value="c9d0e174-684e-469e-84ea-d32c863ad534" /> です。

Identity Server の設定

このセクションには、SSO ログイン、S2S アクセス トークン、およびロボットのプロビジョニングのアクセス トークンの設定が含まれます。

シングル サインオン


次のパラメーターにより、Identity Server を介した SSO ログインを設定できます。

ExternalAuth.System.OpenIdConnect.Enabled

Enables/disables the connection of Orchestrator to an external authentication system. By default, the value is set to true です。

ExternalAuth.System.OpenIdConnect.Authority

Enables you to set the location of the external authentication system. By default, the value is set to https://Orchestrator/Identity: Orchestrator is the installation address of your Orchestrator.

ExternalAuth.System.OpenIdConnect.ClientId

Identity Server 内で登録されている Orchestrator アプリケーション ID (クライアント ID) を設定できます。この値はインストール時に生成され、Identity Server に保存されます。

ExternalAuth.System.OpenIdConnect.ClientSecret

Orchestrator アプリケーションが外部認証システムで認識されるように、クライアント シークレットを設定できます。この値はインストール時に生成され、Identity Server に保存されます。

ExternalAuth.System.OpenIdConnect.RedirectUri

Specifies the redirect URL to Orchestrator after authenticating to Identity Server. This URL is automatically preconfigured inside Identity Server and Orchestrator, and you shouldn't change it. Its default value is http://Orchestrator/signinsystemopenidconnect です。

ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri

ユーザーが Orchestrator からログアウトした後に、Identity Server がリダイレクトするアドレスです。この値にはお使いの Orchestrator URL が自動的に設定されます。

For example, UiPath.Orchestrator.dll.config should contain these keys:

<add key="ExternalAuth.System.OpenIdConnect.Enabled" value="true" />
<add key="ExternalAuth.System.OpenIdConnect.Authority" value="https://Orchestrator/Identity" />
<add key="ExternalAuth.System.OpenIdConnect.ClientId" value="orchestrator" />
<add key="ExternalAuth.System.OpenIdConnect.ClientSecret" value="49C1A7E1-0C79-4A89-A3D6-A37998FB86B0" />
<add key="ExternalAuth.System.OpenIdConnect.RedirectUri" value="https://Orchestrator/signinsystemopenidconnect" />
<add key="ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri" value="https://Orchestrator/" />

連携


To securely propagate data to Identity Server, Orchestrator needs an access token for token authentication. This token is fetched from Identity Server via client credential flow (S2S). The following keys should be added to UiPath.Orchestrator.dll.config:

IdentityServer.Integration.Enabled

Enables/disables the integration of Identity Server to Orchestrator. By default, the value is set to true です。

IdentityServer.Integration.Authority

Enables you to set the location of the Identity Server. By default, the value is set to https://Orchestrator/Identity: Orchestrator is the installation address of your Orchestrator.

IdentityServer.Integration.ClientId

Identity Server 内で登録されている S2S アクセス トークンを生成するために使用するアプリケーション ID (クライアント ID) を設定できます。この値はインストール時に生成されます。

IdentityServer.Integration.ClientSecret

Orchestrator S2S アプリケーションが Identity Server で認識されるよう、クライアント シークレットを設定できます。この値はインストール時に生成されます。

IdentityServer.Integration.AccessTokenCacheBufferInSeconds

Enables you to set the time in seconds before the cache buffer of the access token expires. By default, the value is set to 50 です。

IdentityServer.Integration.UserOrchestratorApiAudience

The Identity Server can generate multiple access tokens with different audiences. Orchestrator API requests can be authorized using user access tokens that have this audience. By default, the value is set to OrchestratorApiUserAccess です。

<add key="IdentityServer.Integration.Enabled" value="true" />
<add key="IdentityServer.Integration.Authority" value="https://Orchestrator/Identity" />
<add key="IdentityServer.Integration.ClientId" value="orchestratorapiaccess" />
<add key="IdentityServer.Integration.ClientSecret" value="a5d57b1d-5b25-49ba-bff7-33aa57f96a58" />
<add key="IdentityServer.Integration.AccessTokenCacheBufferInSeconds" value="50" />
<add key="IdentityServer.Integration.UserOrchestratorApiAudience" value="OrchestratorApiUserAccess" />

To consume client credential (S2S) access tokens generated by Identity Server, Orchestrator needs the following keys to be added to UiPath.Orchestrator.dll.config:

IdentityServer.S2SIntegration.Enabled

Enables/disables the consumption of S2S access tokens. It has no default value in UiPath.Orchestrator.dll.config です。

IdentityServer.Integration.S2SOrchestratorApiAudience

Enables you to set the audience that Orchestrator will check when validating an S2S access token. By default, the value is set to OrchestratorApiS2SAccess です。

Make sure UiPath.Orchestrator.dll.config also contains the following pre-existent keys with their values set to true:

MultiTenancy.AllowHostToAccessTenantApi

When set to true, it allows the host users to access other tenants' specific data. By default, the value is set to true です。

MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled

When Orchestrator receives an API call authorized using S2S access token, a true setting allows Orchestrator to identify the tenant by reading the tenant global id from the API's request header.

<add key="IdentityServer.S2SIntegration.Enabled" value="true" />
<add key="IdentityServer.Integration.S2SOrchestratorApiAudience" value="OrchestratorApiS2SAccess" />
<add key="MultiTenancy.AllowHostToAccessTenantApi" value="true" />
<add key="MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled" value="true" />

ロボットのプロビジョニングのアクセス トークン

Orchestrator は、ロボットのトークン ジェネレーターとして機能します。ロボットは Orchestrator エンドポイントを呼び出して、アクセス トークンを生成します。その後、アクセス トークンは、AI Fabric などの異なるリソースを呼び出すことのできるアクティビティに渡されます。ID サービスと Orchestrator の連携により、ID サービスはアクセス トークンの生成を引き継ぎます。

ログの構成

ロボット ログ

This is the corresponding UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 UiPath.Orchestrator.dll.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 use the same index regardless of the tenant. In this case, logs are generated per day. To use a shared index, you are also required to add the following key in UiPath.Orchestrator.dll.config: <add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" />. Make 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 UiPath.Orchestrator.dll.config file, add a new NLog target:
<target xsi:type="Database" connectionString="${ui-connection-strings:item=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 を使用して、ローカル ファイル、イベント ログ、メール、データベースなど、任意の数の事前定義済みターゲットやカスタム ターゲットに、ログ データを格納したり、渡したりすることができます。

Custom NLog targets are not automatically migrated during an upgrade. You need to migrate them to Identity Server and Webhooks services manually. See NLog documentation in Identity Server.

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 UiPath.Orchestrator.dll.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 年前に更新


⚙ UiPath.Orchestrator.dll.config


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

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