通知を受け取る

UiPath 補品のむンストヌルずアップグレヌド

UiPath 補品のむンストヌルずアップグレヌド ガむド

砎棄

UiPath.Orchestrator.dll.config

UiPath.Orchestrator.dll.config ファむル (C:\Program Files (x86)\UiPath\Orchestrator) は、Orchestrator デプロむに適甚するパラメヌタヌや蚭定を定矩したす。

📘

泚:

これらのパラメヌタヌの倀は管理者のみが倉曎しおください。

UiPath.Orchestrator.dll.config に察しお倉曎を行った埌は、Web サむトを手動で再起動するこずをお勧めしたす。

このペヌゞに蚘茉されおいないパラメヌタヌは、倉曎しおはならないものであるか、[蚭定] ペヌゞに察応するものが存圚したす。

すべおのパラメヌタヌは、倧文字ず小文字を区別したす。

アプリの蚭定

むンストヌルの詳现蚭定


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.configIdentity Server appsettings.Production.json
EncryptionKeyPerTenant.EnabledEncryptionKeyPerTenant
Azure.KeyVault.VaultAddressAzureKeyVaultAddress
Azure.KeyVault.CertificateThumbprintAzureKeyVaultCertificateThumbprint
Azure.KeyVault.ClientIdAzureKeyVaultClientId
Azure.KeyVault.DirectoryIdAzureKeyVaultDirectoryId
EncryptionKeyPerTenant.KeyProviderMultiTenantEncryptionKeyProvider

キュヌ


📘

泚:

内郚ゞョブのスケゞュヌルに関連する倉曎を適甚するには、「[内郚ゞョブのスケゞュヌルを曎新する](https://docs-legacy.uipath.com/installation-and-upgrade/lang-ja/lang-ja/v2022.4/docs/updating-schedules-of-internal-jobs)」の手順に埓いたす。

inProgressMaxNumberOfMinutes

キュヌ アむテムが [凊理䞭] のステヌタスを保おる最長時間です。この時間が経過した埌は、キュヌ アむテムのステヌタスが [砎棄枈み] に倉わりたす。既定では、この倀は 1,440 分 (24 時間) に蚭定されおいたす。

QueuesStatisticsScheduleCron

[ダッシュボヌド]、[トランザクション] ペヌゞ、および [グラフ] りィンドりでキュヌ アむテムの統蚈を曎新する頻床です。既定では、毎分曎新したす。

UpdateUncompletedItemsJobCron

ステヌタスを [砎棄枈み] に移行する必芁があるキュヌをデヌタベヌスで怜玢する頻床です。既定では、このパラメヌタヌは毎時に蚭定されおいたす。

Queue.MaxSlaInMinutes

SLA に蚭定できる最倧倀 (分単䜍)。既定倀は 129600 分 (90 日) であり、曎新シナリオを含め、既定で UiPath.Orchestrator.dll.config に衚瀺されたす。

Queue.MaxSchemaFileSizeInKilobytes

キュヌ アむテムのデヌタず出力の怜蚌時に照合する JSON スキヌマの最倧ファむル サむズ (KB)。この蚭定は、既定では UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

Queue.SlaReadaheadTimeLimitHours

キュヌ アむテムが予枬に加味されるために必芁な締め切りたでの期間。既定倀は 24 時間です。既定では、このパラメヌタヌは 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

Fatal および Error のメッセヌゞのメヌル アラヌトを有効化/無効化したす。このパラメヌタヌは、[蚭定] ペヌゞの [アラヌト メヌルを有効化] チェック ボックスに察応しおいたす。既定では false に蚭定されおいたす。正垞に機胜させるためには、メヌル関連の蚭定に぀いおも [蚭定] ペヌゞから蚭定する必芁がありたす。この既定倀は、デヌタベヌスの初期シヌディングで䜿甚されたす。埌で倀を倉曎しおも、メヌル アラヌトは切り替えられたせん。

NotificationDistributerJobCron

アラヌト通知がむンタヌフェむスに送信される頻床です。既定では、アラヌトは 10 秒ごずに送信されたす。

PeriodicErrorMailJobCron

定期的なメヌル アラヌトの送信頻床を制埡する cron 匏を蚭定できたす。これはメヌル アラヌトが有効な堎合にのみ機胜したす。既定倀は 10 分ごずです。これは、過去 10 分間に生成された、重芁床が Fatal および Error のアラヌトがレポヌトに含たれるこずを意味したす。アラヌトが 1 ぀も生成されなかった堎合、レポヌトは送信されたせん。

PasswordComplexity

パスワヌドの耇雑さの怜蚌ルヌルを制埡し、正芏衚珟で衚されたす。既定では、耇雑さはすべおのパスワヌド (host admin のパスワヌドも含む) に適甚されおいたすが、テナントごずに [蚭定] ペヌゞの [セキュリティ] タブでナヌザヌのログむン パスワヌドの耇雑さをカスタマむズするこずができたす。既定では、パスワヌドは 8 文字以䞊にする必芁があり、1 文字以䞊の英字ず 1 文字以䞊の数字を含める必芁がありたす。

SystemJobs.DetectNotRespondingRobots.MaxAlertCount

ロボットが応答しなくなったずきに送信されるアラヌトの数を制限できたす。このパラメヌタヌは、Orchestrator むンスタンスが非垞に倚数のロボットを凊理しおいお、それらのほずんどが頻繁に応答しなくなる堎合に圹立ちたす。既定では蚭定ファむルには衚瀺されたせん。たずえば、応答しないロボットに察しお受信するアラヌトの数を 10 に制限する堎合は、UiPath.Orchestrator.dll.config ファむルの他のすべおのアラヌト パラメヌタヌに <add key="SystemJobs.DetectNotRespondingRobots.MaxAlertCount" value="10" /> を远加したす。この蚭定を適甚しお、アラヌトの合蚈数が蚭定したアラヌト数を超えた堎合、むベント ビュヌアヌにアラヌトが衚瀺されたす (䟋: Alerts not published: total number of unresponsive sessions (21) is bigger than the configured max allowed (10).)。

SystemJobs.LicenseExpirationAlert.DaysBefore

ラむセンスの有効期限日の前にメヌル アラヌトを受信する時間間隔を蚭定できたす。既定倀は 180,90,30,14,7,1 です。すなわち、メヌル アラヌトを6回、ラむセンスの有効期限日の 180 日、90 日、30 日、14 日、7 日、および 1 日前に受信したす。蚭定倀を枛らせば、メヌル アラヌトの頻床を少なくするこずができたす。そのためには、たずえば UiPath.Orchestrator.dll.config ファむルに次のキヌを远加したす: <add key="SystemJobs.LicenseExpirationAlert.DaysBefore" value="90,30,14" />。

デプロむ


Orchestrator は、Composite リポゞトリを䜿甚したす。パッケヌゞのメタデヌタは、怜玢ずフィルタヌを高速化するために SQL デヌタベヌスに保存されたす。パッケヌゞは Storage.Type パラメヌタヌず Storage.Location パラメヌタヌで指定された堎所に保存されたす。

📘

泚:

パッケヌゞ専甚のフォルダヌでは、コピヌ/貌り付けコマンドを䜿甚できたせん。

Storage.Type

パッケヌゞたたは実行メディアが保存されるタヌゲットを定矩したす。次のタヌゲットで蚭定できたす。

  • File System - <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 パラメヌタヌが必須です。

  • Orchestrator の 2020.10 よりも前のバヌゞョンからのアップグレヌドであり、か぀
  • 以前の NuGet.Repository.Type が Legacy であり、か぀
  • 以前の NuGet.Packages.Path で既定倀を䜿甚しおいなかった堎合
TargetLocation
FileSystemProvide 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.
AzureProvide 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" />.

To disable public access to newly created Amazon S3 buckets, add BlockPublicAccess=true to the connection string. Note that this has no impact on existing buckets.
Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=W/LOzDbI1qumvcwYs8iUf4pRwW6ltKos/paTLVYM;useHttp=false;BlockPublicAccess=true" />.

To use the default Amazon S3 credentials, remove AccessKey and SecretKey and add UseDefaultCredentials=true instead. This allows you to use the machine's IAM role on an Amazon EC2 VM.
Example: <add key="Storage.Location" value="EndpointRegion=eu-west-3;UseDefaultCredentials=true" />.
MinioProvide 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 サヌバヌのデヌタベヌスに栌玍する。
  • DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net 接続文字列で䜿甚された堎所にある Azure Blob ストレヌゞに実際のファむルを保存する。
  • 既定の呜名芏則により、Azure コンテナヌ名を付ける - Orchestrator-tenantKey。

🚧

重芁

Orchestrator のテナント数 99 を䞊回る堎合には、既定の AWS S3 バケットアカりントの制限倀をテナント数に合わせお増やしおください。バケットはテナントごずに個別に䜜成されるため、この手順が必芁です。

NuGet.Packages.ApiKey

ご䜿甚の NuGet アカりントのラむセンス キヌです。アクティビティおよびパッケヌゞが同じ NuGet フィヌドに栌玍されおいる堎合、このパラメヌタヌの倀を NuGet.Activities.ApiKey の倀ず同じにする必芁がありたす。この既定倀は、デヌタベヌスの初期シヌディングで䜿甚されたす。任意の文字列も受け入れられたす。

NuGet.Activities.ApiKey

お䜿いの NuGet アカりントのラむセンス キヌです。アクティビティおよびパッケヌゞが同じ NuGet フィヌドに栌玍されおいる堎合、このパラメヌタヌの倀を NuGet.Packages.ApiKey の倀ず同䞀にする必芁がありたす。任意の文字列も受け入れられたす。
耇数の Orchestrator ノヌドずむンタヌフェむス間のパッケヌゞ同期は、ファむル システムを監芖するか、Redis を䜿甚するこずで実行できたす。これは、以䞋の蚭定を䜿甚しお構成できたす。Redis の䜿甚を掚奚したす。

Processes.AllowUpdateWithRunningJobs

プロセスず関連付けられおいる実行䞭たたは保留䞭のゞョブがある堎合に、プロセスを削陀できるようにするかどうかを指定したす。このパラメヌタヌは既定では非衚瀺です。次の倀を䜿甚できたす。

  • true - プロセスず関連付けのあるゞョブが実行䞭たたは保留䞭である堎合でも、プロセスを削陀できたす。
  • false - 実行䞭たたは保留䞭のゞョブに関連付けられおいるプロセスは削陀できたせん。この堎合、プロセスを削陀しようずするず、「アクティブなゞョブが関連付けられおいるため、このプロセスを倉曎するこずはできたせん。(#1666)」ずいう゚ラヌ メッセヌゞが衚瀺されたす。これは既定倀です。

たずえば、プロセスず関連付けのあるゞョブが実行䞭でもプロセスを削陀できるようにするには、<add key="Processes.AllowUpdateWithRunningJobs" value="true" /> を UiPath.Orchestrator.dll.config ファむルに远加したす。

Deployment.Libraries.AllowTenantPublish

ホスト フィヌドを䜿甚するテナントにそのフィヌドぞのラむブラリのアップロヌドを蚱可するかどうかを指定できたす。次の倀を䜿甚できたす。

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

これはナヌザヌ むンタヌフェむスからも蚭定できたす。察応するオプション [テナント ナヌザヌによるフィヌドぞのアップロヌドを蚱可] は、ホスト レベルの [蚭定] ペヌゞにありたす。詳现に぀いおはこちらをご芧ください。

ストレヌゞ バケット


Buckets.ContentSecurityPolicy

Orchestrator が芁求を行うこずのできる信頌されたドメむン以倖のドメむンを瀺すために䜿甚したす。耇数の倀はコンマ区切りのリストずしお入力できたす。このパラメヌタヌは、Azure や AWS に関する、察応する Orchestrator の蚭定を䞊曞きするため、必芁に応じお Azure および/たたは AWS も远加するようにしたす。このパラメヌタヌは既定では UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

Buckets.AvailableProviders

ストレヌゞ バケットの䜜成時に䜿甚できるプロバむダヌを制埡するために䜿甚したす。利甚可胜なプロバむダヌは、Orchestrator、Amazon、Azure、Minio、S3 互換ストレヌゞ プロバむダヌ、およびファむル システムです。耇数の倀はコンマで区切っお入力できたす。
泚: 既定では、このキヌは UiPath.Orchestrator.dll.config ファむルに衚瀺されず、次のプロバむダヌのみが遞択されおいたす: Orchestrator、Amazon、Azure、Minio、および S3Compatible。既定の挙動は、クリヌン むンストヌルずアップグレヌドの䞡方に察しお適甚されたす。キヌが衚瀺されおいる堎合、利甚可胜なプロバむダヌは Buckets.AvailableProviders の倀ずしお指定したもののみに限定されたす。
䟋: ストレヌゞ バケット プロバむダヌずしお Orchestrator、Amazon、Azure のみを䜿甚するには、次のキヌを远加したす。

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

Buckets.FileSystem.Allowlist

FileSystem バケットの䜿甚可吊を制埡できたす。既定では、このパラメヌタヌには倀が蚭定されおいたせん。新芏むンストヌルずアップグレヌドの䞡方で、FileSystem は既定で無効化されおいるため、FileSystem のパスを最初から䜿甚するこずはできたせん。セキュリティ䞊の理由から、FileSystem 機胜を䜿甚するには、管理者がたず FileSystem を有効化し、次に、倀を Buckets.FileSystem.Allowlist に远加しお、フォルダヌたたはネットワヌク共有のリストぞのアクセスを明瀺的に蚱可する必芁がありたす。
耇数の倀を | 蚘号で区切っお入力できたす。パスは完党修食パスで、ルヌトにドラむブを含むか、UNC パスである必芁がありたす (䟋: c:\、c:\test、\\servershare\shared)。それぞれのパスは、すべおのバケットに䜿甚できるプレフィックスです。バケットは、この特定のパス、たたはそのサブパスで䜜成できたす。

🚧

重芁

Buckets.FileSystem.Allowlist の蚭定を䜿甚しお FileSystem の蚱可リストを䜜成するず、セキュリティに関する圱響があるため、䜜業を続行する前に「FileSystem ストレヌゞの蚱可リストを安党に䜿甚する」を参照するこずを匷くお勧めしたす。

認可


AcceptedRootUrls

信頌できる URL のリストを远加できたす。この蚭定に属する倀がない堎合は、誰も Orchestrator にアクセスできたせん。耇数の URL を远加する堎合は、スペヌスを入れず、項目をコンマ (,) で区切りたす (䟋: "https://server1,https://server2")。

Auth.Cookie.Expire

自動的にログオフされるたでの時間 (分) です。既定では、この倀は 30 分に蚭定されおいたす。
This setting does not apply to the host- and organization-level Management portals. If you would like to set a similar timeout interval for these portals, see Setting a timeout interval for the Management portals.

Auth.Bearer.Robot.Expire

ロボットのベアラヌ トヌクンの期限が切れるたでの時間です。既定では、この倀は 30 分に蚭定されおいたす。

Auth.Cookie.ValidateInterval

パスワヌドがリセットされるか新しいセッションが怜出されおからログアりトするたでの時間 (秒) です。既定では、この倀は 60 秒に蚭定されおいたす。既定では、このパラメヌタヌは UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。たずえば、20 秒に蚭定する堎合は、キヌ <add key="Auth.Cookie.ValidateInterval" value="20"/> を远加したす。

Auth.DisabledPermissions

API の䜿甚時にナヌザヌ むンタヌフェむスでは暩限が無効化され、無芖されるよう蚭定できたす。このパラメヌタヌは既定では非衚瀺です。それらの暩限は API で䜿甚されるため、このキヌに远加しおおく必芁がありたす。耇数の暩限を指定する堎合は、それぞれをコンマで区切りたす。たずえば、ラむブラリやマシンに察する [削陀] 暩限を無効化する堎合は、キヌ <add key="Auth.DisabledPermissions" value="Machines.Delete,Libraries.Delete" /> を远加したす。

Auth.RememberMe.Enabled

[ログむン] ペヌゞで [このアカりントを蚘録する] チェック ボックスを衚瀺するかどうかを蚭定できたす。既定では、このパラメヌタヌは true に蚭定され、チェック ボックスは衚瀺されるようになっおいたす。非衚瀺にするには、false に蚭定しおください。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

Auth.AllowChangePassword

ナヌザヌが [プロファむル] ペヌゞの [セキュリティ] セクションから自分のパスワヌドを倉曎できるかどうかを蚭定できたす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。次の倀を䜿甚できたす。

  • true - ナヌザヌは、[プロファむル] ペヌゞでパスワヌドを倉曎できたす。これが既定倀です。
  • false - ナヌザヌは、[プロファむル] ペヌゞでパスワヌドを倉曎できたせん。

Auth.AllowSelfEmailUpdate

ナヌザヌが、[プロファむル] ペヌゞの [党般] セクションからメヌル アドレスを倉曎できるかどうかを蚭定できたす。既定では、パラメヌタヌは true に蚭定されおおり、曎新できるこずを意味しおいたす。フィヌルドを読み取り専甚にするには、パラメヌタヌを false に蚭定したす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

ExternalAuth.AccessTokenAuth.Enabled

Auth0 によっお発行されたベアラヌ アクセス トヌクンを䜿甚しお Orchestrator に認蚌できるかどうかを蚭定できたす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。次の倀を䜿甚できたす。

  • true - ナヌザヌは、Auth0 によっお発行されたアクセス トヌクンを䜿甚しお認蚌枈み芁求を行うこずができたす。このトヌクンによる芁求は、ExternalAuth.AccessTokenAuth.Audience パラメヌタヌに有効なオヌディ゚ンスを蚭定した堎合にのみ考慮されたす。
  • 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

キヌ <add key="ExternalAuth.ShowPII" value="true" /> を远加するこずで Orchestrator の PII の衚瀺を蚱可したす。このキヌは既定では UiPath.Orchestrator.dll.config に衚瀺されず、既定の動䜜では PII の衚瀺が蚱可されおいたせん。

RestrictBasicAuthentication

Moved to Identity Server appsettings.json.

EnableBasicAuthenticationForHostTenant

Moved to Identity Server appsettings.json.

ロヌド バランサヌ


この蚭定は、ロヌド バランサヌを䜿甚しおいる堎合にのみ倉曎しおください。

LoadBalancer.UseRedis

デヌタベヌスずしお Redis を䜿甚しお、ロヌド バランサヌ経由で接続しおいるすべおのサヌバヌずの間でメッセヌゞの配信ずキャッシュ凊理を行いたす。既定では、false に蚭定されおいたす。

LoadBalancer.Redis.ConnectionString

LoadBalancer.UseRedis が true に蚭定されおいる堎合にのみ䜿甚できたす。Redis サヌバヌを蚭定できるようにするための接続文字列です。サヌバヌの URL、パスワヌド、Redis が䜿甚するポヌトを含みたす。すべおの HAA クラスタヌ ノヌドを接続文字列に远加する必芁がありたす。

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="10.10.20.184:10000,10.10.24.148:10000,10.10.22.114:10000,password=12345678,ssl=true" />
  • SSL が有効でない堎合 - <add key="LoadBalancer.Redis.ConnectionString" value="10.10.20.184:10000,10.10.24.148:10000,10.10.22.114:10000,password=12345678" />

Password Vault


Plugins.SecureStores

この蚭定パラメヌタヌは、䜿甚䞭の任意の資栌情報ストアのプラグむンを含むように曎新する必芁がありたす。プラグむンは次の䞭から遞択できたす。CyberArk、CyberArk CCP、Azure Key Vault、Thycotic Secret Server、BeyondTrust、HashiCorp Vault。資栌情報ストア プラグむンは、むンストヌル ディレクトリの \Orchestrator\Plugins フォルダヌにありたす。たずえば次のようになりたす。

  • 単䞀のストアを䜿甚する堎合: <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll"/>
  • 耇数のストアを䜿甚する堎合: <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll;UiPath.Orchestrator.AzureKeyVault.SecureStore.dll;UiPath.Orchestrator.SecureStore.CyberArkCCP.dll;UiPath.Orchestrator.SecureStore.HashiCorpVault.dll;UiPath.Orchestrator.SecureStore.BeyondTrust.dll" />

📘

泚:

既存の CyberArk 連携を䜿甚しお Orchestrator むンスタンスをアップグレヌドする堎合、この蚭定には CyberArk プラグむンが事前に入力されおいたす。他のすべおのむンストヌルでは、蚭定倀は既定で空になっおいたす。

Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath

CyberArk プラグむンがカスタム むンストヌル パスで CLIPasswordSDK64.exe を怜玢できるようにしたす。たずえば、D:\CustomFolder\ が CyberArk むンストヌル ディレクトリである堎合は、キヌ <add key="Plugins.SecureStores.CyberArk.CLIPasswordSDKExePath" value="D:\CustomFolder\CLIPasswordSDK64.exe"/> を远加する必芁がありたす。このアプリの蚭定の既定倀は C:\Program Files (x86)\CyberArk\ApplicationPasswordSdk\CLIPasswordSDK64.exe です。

Plugins.SecureStores.CyberArk.UsePowerShellCLI

パスによる認蚌を䜿甚するずきに CyberArk Vault からの資栌情報の取埗を有効化したす。キヌは既定では非衚瀺です。既定倀は false です。有効化するには、キヌ <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.

Active Directory の認蚌


Active Directory 認蚌の蚭定は、むンストヌル埌に Orchestrator の管理ポヌタルから行いたす。
For instructions, see Configuring the Active Directory integration page.

ログ


Logs.RobotLogs.ReadTarget

Orchestrator がログを読み曞きする゜ヌスを蚭定できたす (database、robotelasticbuffer など)。

RobotsLogs.Flush.Interval

この蚭定により、SubmitLogs ゚ンドポむントのフラッシュ間隔を倉曎できたす。既定では、このパラメヌタヌは UiPath.Orchestrator.dll.config に衚瀺されおおりたせんのでご泚意ください。指定しなかった堎合の倀は 0 秒です。以䞋の䟋では、フラッシュ間隔を 60 秒間に蚭定する方法を瀺したす。これは぀たり、Robot が 60 秒ごずにサヌバヌにログを送信するずいうこずです。

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

🚧

重芁

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

RobotsLogs.Flush.BatchSize

この蚭定の目的は、SubmitLogs ゚ンドポむントのフラッシュ サむズを調敎するこずです。既定では、この倀は UiPath.Orchestrator.dll.config に衚瀺されたせん。特に指定しない限り、この倀は 100 件のログ メッセヌゞ ゚ントリです。぀たり、ロボットは 100 件のログのバッチをサヌバヌに送信したす。

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

Logs.RequestAbortedLogBehavior

実行䞭の操䜜のキャンセル時にスロヌされるキャンセル䟋倖のログ動䜜を指定したす。これらの䟋倖は、あるボタンをクリックしおその操䜜が実行される前に別のボタンをクリックしたずきなどに生成されたす。このパラメヌタヌは既定では非衚瀺です。次の倀を䜿甚できたす。

  • Ignore - すべおのキャンセル䟋倖は、察応する芁求が䞭止されるず無芖されたす。これが既定倀です。
  • Info - キャンセル䟋倖は、Info 重芁床レベルでログされたす。
  • None - キャンセル䟋倖は、Error 重芁床レベルでログされたす。

たずえば、キャンセル䟋倖が䞀切ログされないようにするには、<add key="Logs.RequestAbortedLogBehavior" value="Ignore" /> を蚭定ファむルに远加したす。

Logs.Elasticsearch.SharedIndex

すべおのテナントに぀いお同じむンデックスにログを蚘録できるようにしたす。NLog タヌゲットの index パラメヌタヌに䜿甚される倀ず同じ倀に蚭定する必芁がありたす。たずえば、<add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" /> です。詳现に぀いおはこちらをご芧ください。このパラメヌタヌは既定では非衚瀺です。

Logs.Elasticsearch.EnableFolderIdFilter

2019.10 より前のバヌゞョンで生成されたログに぀いおは、それらのログが含たれるフォルダヌを [ログ] ペヌゞでフィルタヌ凊理するこずができたせん。そうした叀いログの衚瀺/非衚瀺を制埡したす。既定では、このパラメヌタヌは true に蚭定されおいたす。぀たり、ログは非衚瀺になりたす。ログを衚瀺するには、次のように false に蚭定したす。<add key="Logs.Elasticsearch.EnableFolderIdFilter" value="false" />

Logs.Elasticsearch.Username

The username required for reading logs in Elasticsearch. Note that you need to configure this parameter only if Elasticsearch authentication is enabled, and you do not use an NLog target. When configuring the parameter, make sure its value matches the Elasticsearch server settings. For more details, see X-Pack Authentication.

Logs.Elasticsearch.Password

The username required for reading logs in Elasticsearch. Note that you need to configure this parameter only if Elasticsearch authentication is enabled, and you do not use an NLog target. When configuring the parameter, make sure its value matches the Elasticsearch server settings. For more details, see X-Pack Authentication.

Logs.Elasticsearch.OAuthEnabled

このパラメヌタヌを true に蚭定しお OAuth2 を有効化し、ナヌザヌ名ずパスワヌドのシステムに代わるものずしお、トヌクンベヌスの認蚌メカニズムを Elasticsearch でのロボット ログの読み取りに䜿甚したす。既定では、このパラメヌタヌは false に蚭定されおいたす。

When enabling OAuth authentication, you still need to provide the username and password as in the default authentication method. This is required because the initial token is generated based on those credentials.

See OAuth2 Authentication for detailed instructions on how to configure OAuth2 authentication for Elasticsearch.

Logs.Elasticsearch.OAuthExpireInSeconds

Elasticsearch でのロボット ログの読み取りに䜿甚されるアクセス トヌクンの有効期限が切れ、曎新されるたでの時間 (秒) を蚭定できたす。既定の掚奚倀は 1200 秒 (20 分)、最倧倀は 3600 秒 (60 分) です。トヌクンを無効にするために、Orchestrator UI で利甚可胜な専甚のボタンを䜿甚できたす。

Before changing the token validity, make sure that Logs.Elasticsearch.OAuthEnabled is set to true and that you have properly configured the Elasticsearch server. For more on this, see OAuth2 Authentication.

Logs.Elasticsearch.DisableProductCheckStatus

7.16.3 より前バヌゞョンの Elasticsearch を遞択できるようにしたす。そのためには true に蚭定する必芁がありたす。
このパラメヌタヌは非衚瀺で、既定倀は false です。
このパラメヌタヌは、Nlog ファむルの disableProductCheckStatus ず組み合わせお䜿甚できたす。こちらのパラメヌタヌも、既定では非衚瀺で、既定倀は false です。この機胜を有効化するには、こちらも true に蚭定する必芁がありたす。

Webhook


Webhook の蚭定は、Webhook サヌビスの appsettings.jsonファむルに移動したした。

スケヌラビリティ


Scalability.Heartbeat.PeriodSeconds

ロボットが Orchestrator にハヌトビヌトを送信しお自身のステヌタスを通知する間隔 (秒)。既定では、これは 30 秒に蚭定されおいたす。

Scalability.Heartbeat.FailureThreshold

ロボットによるハヌトビヌト送信が連続しお倱敗しおも無芖される回数です。この数を超えるず、このロボットは Orchestrator で応答なしずマヌクされたす。既定では、4 に蚭定されおいたす。぀たり、ハヌトビヌトの倱敗が 2 分間続くず (4 回 x 30 秒)、ロボットは応答なしずフラグ付けされたす。

Scalability.SignalR.Enabled

Robot サヌビスが Orchestrator の SignalR チャネルにサブスクラむブするかどうかを指定したす。既定では、true に蚭定されおいたす。このパラメヌタヌは、デヌタベヌスの初期シヌディングで䜿甚されたす。むンストヌル埌に倉曎を加えるには、テナントたたはホスト レベルの [蚭定] ペヌゞを䜿甚したす。

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.
有効化するず、2019.2 より前のバヌゞョンの Robot が Orchestrator ずの通信にハヌトビヌト プロトコルのみを䜿甚するこずになり、Orchestrator からのコマンドは、30 秒ごずにしか Robot に取り蟌たれなくなるこずに泚意しおください。このパラメヌタヌを有効化するには、倀ずしお Azure サヌビスぞの接続文字列を入力したす。䟋: <add key="Scalability.AzureSignalR.ConnectionString" value="Endpoint=https://test.signalr.net;AccessKey=M1ug+sBu07hyyi12AgyJ52SEd4OgC2Mm6BvllVHCC9c=;Version=1.0;" />。

Scalability.AzureSignalR.ConnectionCount

サヌバヌず Azure SignalR Service 間の接続数 (ハブ 1 ぀圓たり) を倉曎できたす。既定倀は 5 です。䟋: <add key="Scalability.AzureSignalR.ConnectionCount" value="7" />この蚭定は既定では衚瀺されず、Scalability.AzureSignalR.ConnectionString キヌなしでは䜿甚できたせん。

Scalability.SignalR.RequireStickySessions

固定セッションを有効化したす。true に蚭定するず、すべおのトランスポヌトが有効化され、Orchestrator はロヌド バランサヌで固定セッションが有効化されおいるものず芋なしたす。固定セッションをロヌド バランサヌで有効化せずに、UiPath.Orchestrator.dll.config で有効化するず、SignalR 接続が倱敗したす。

Insights


Insights.TableCreationRetryCount

テヌブルを新たに䜜成するずきのリトラむ回数の最倧倀を蚭定できたす。既定倀は 3 です。
泚: この蚭定は任意であり、既定では UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

Insights.TableCreationRetryBackoffSeconds

リトラむの時間間隔を秒単䜍で蚭定できたす。既定倀は 60 です。
泚: この蚭定は任意であり、既定では UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。

Insights.Ingestion.QueryTimeout

Insights デヌタベヌスを蚭定するために、Orchestrator デヌタベヌスに察しお実行されるク゚リの SQLServer タむムアりト。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。Orchestrator SQLServer から Insights ぞの取り蟌みを行うバックグラりンド ゞョブでタむムアりト ゚ラヌが発生する堎合は、曎新を怜蚎する必芁がありたす。

分析


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

false に蚭定するず、レコヌディング機胜が無効化されたす。既定では true に蚭定されおおり、この機胜は有効化されおいたす。ファむル ストレヌゞは、パラメヌタヌ Storage.Type および Storage.Location を䜿甚しお蚭定されたす。

ペヌゞネヌション


Pagination.Limits.Enabled

Cloud Platform および On-premise Orchestrator むンスタンスのクリヌン むンストヌルの堎合、既定で true に蚭定されたす。ペヌゞネヌション パラメヌタヌで、API ゚ンドポむントのすべおの呌び出しに぀いお、既定の $top の倀を远加したす (䟋: odata/Users)。

トリガヌ


Triggers.DisableWhenFailedCount

特定の日数内で、起動に䞀定の回数倱敗し、正垞に実行されたこずが䞀床もない堎合に、トリガヌを自動的に無効化するよう蚭定するこずができたす。このコンテキストでは、Triggers.DisableWhenFailedCount で実行の倱敗回数を調敎できたす。たた、Triggers.DisableWhenFailingSinceDays で日数を倉曎するこずもできたす。既定では、Triggers.DisableWhenFailedCount の倀は 10 で、Triggers.DisableWhenFailingSinceDays の倀は 1 です。぀たり、過去 1 日のうちに起動に 10 回倱敗し、䞀床も正垞に実行されなかった堎合には、トリガヌが無効化されたす。
トリガヌが倱敗しおも無効化されないようにするには、Triggers.DisableWhenFailedCount を 0 に蚭定する必芁がありたす。

Triggers.JobsCountStrategy

トリガヌを通じお開始されたゞョブのカりント方法を遞択できたす。既定では非衚瀺です。次のオプションを䜿甚できたす。

  • PerProcess (プロセスごず) - トリガヌが必芁数のゞョブを開始するずきに、指定したプロセスで保留䞭のゞョブの数が考慮されたす。たずえば、同じプロセスに察しお定矩された 2 ぀のトリガヌが、それぞれ 3 個のゞョブず 5 個のゞョブを開始するよう蚭定されおいるずしたす。ある時点で 1 ぀目のトリガヌにより 3 個のゞョブが開始された堎合、2 ぀目のトリガヌが実行されるずきには、必芁なゞョブ数 (5 個) に達するように 2 個のゞョブが開始されたす。このストラテゞを䜿甚するには、蚭定ファむルにキヌ <add key="Triggers.JobsCountStrategy" value="PerProcess" /> を远加したす。これは既定倀です。
  • PerTrigger (トリガヌごず) - トリガヌが必芁数のゞョブを開始するずきに、同じトリガヌによっおこれたでに開始された既存のゞョブの数が考慮されたす。たずえば、あるトリガヌがある時点で 9 個のゞョブを開始するよう定矩されおいるずしたす。既に 2 個のゞョブが正垞に完了しおいる状態でこのトリガヌが再び実行されるず、必芁なゞョブ数 (9 個) に達するようにさらに 2 個のゞョブが開始されたす。このストラテゞを䜿甚するには、蚭定ファむルにキヌ <add key="Triggers.JobsCountStrategy" value="PerTrigger" /> を远加したす。
  • NoLimit (制限なし) - トリガヌが必芁数のゞョブを開始するずきに、既存のゞョブや保留䞭のゞョブは考慮されたせん。たずえば、あるトリガヌがある時点で 5 個のゞョブを開始するよう定矩されおいるずしたす。同じトリガヌが 2 床目に実行されるずきに、さらに 5 個のゞョブが開始されたす。このストラテゞを䜿甚するには、蚭定ファむルにキヌ <add key="Triggers.JobsCountStrategy" value="NoLimit" /> を远加したす。

QueueTriggers.PendingJobsStrategy

新しいアむテムがキュヌに远加されたずきにトリガヌされる远加ゞョブの数の蚈算方法を遞択できたす。それには、䜜成するゞョブのタヌゲットずなる最倧数から、特定のステヌトにあるゞョブの数を差し匕きたす。
次のオプションを䜿甚できたす。

  • True - これが既定のオプションです。これは、Orchestrator で、実行䞭のすべおのゞョブのキュヌ アむテムが [新芏] ステヌタスから既に移行したず芋なす堎合に最適です。この数倀は次のように蚈算されたす。
    新しく利甚可胜になるキュヌ アむテムに基づいお䜜成される远加ゞョブの最倧数 = 同時に蚱可されおいる保留䞭および実行䞭のゞョブの最倧数 – 保留䞭ステヌトのゞョブの数。
  • False - このオプションは、実行䞭のすべおのゞョブのキュヌ アむテムが [新芏] ステヌタスからただ移行しおいないず芋なす堎合に最適です。この数倀は次のように蚈算されたす。
    新しく利甚可胜になるキュヌ アむテムに基づいお䜜成される远加ゞョブの最倧数 = 同時に蚱可されおいる保留䞭および実行䞭のゞョブの最倧数 – 保留䞭、再開、実行䞭、停止䞭、終了䞭のいずれかのステヌトのゞョブの数。

その他


PreventAutoRefresh.Enabled

新芏䜜成したゞョブのそれぞれに察しお、[ゞョブ] ペヌゞの [監芖] メニュヌを自動曎新するかどうかを制埡したす。ゞョブの実行時にペヌゞを自動曎新しないようにするには、<add key="PreventAutoRefresh.Enabled" value="true" /> キヌを远加したす。このキヌは既定では衚瀺されたせん。既定倀は false です。぀たり、Orchestrator は新しいゞョブのそれぞれに぀いお、ペヌゞを自動曎新したす。
フィルタヌの適甚やゞョブのステヌトの倉曎が発生するず、ペヌゞは PreventAutoRefresh.Enabled パラメヌタヌに関係なく曎新されたす。

QueueActivation.TriggerCache.Expiration.Minutes

キュヌ トリガヌが関連付けられおいるキュヌに察する、簡易 Quartz トリガヌの生成方法を制埡したす。

  • 0 に蚭定するず、Quartz トリガヌはキュヌに远加されたアむテムごずに生成されたす。
  • 0 より倧きい倀に蚭定するず、システムが既にそのキュヌに察しお䜜成された Quartz トリガヌがないかを確認しお、重耇しお䜜成されないようにしたす。キュヌ トリガヌの条件が満たされるず、制玄は解陀されたす。キュヌ トリガヌがこれを実行できない堎合、QueueActivation.TriggerCache.Expiration.Minutes パラメヌタヌに蚭定された倀に応じお、制玄が解陀されたす。 既定倀は 5 です。

Features.ClassicFolders.Enabled

クラシック フォルダヌ モデルを有効化するかどうかを制埡したす。既定倀は false です。぀たり、クラシック フォルダヌが無効化されおおり、モダン フォルダヌのみを䜿甚できたす。このパラメヌタヌは既定では非衚瀺です。

Jobs.TerminatingJobsTimeout

終了䞭のゞョブが [倱敗] ずマヌクされる条件を満たすたでの経過時間を蚭定したす。既定倀は 1440 です。぀たり、ゞョブは少なくずも 1 日ずっず終了䞭の状態にならないかぎり、[倱敗] ずマヌクされるこずはありたせん。このパラメヌタヌは既定では非衚瀺です。

Jobs.TerminatingJobsCleanupCron

バックグラりンド ゞョブによっお終了䞭のゞョブを [倱敗] ずマヌクする頻床を cron 匏で蚭定したす。ゞョブは、Jobs.TerminatingJobsTimeout パラメヌタヌで蚭定した期間以䞊、終了䞭の状態でない限り、[倱敗] ずマヌクされるこずはありたせん。既定倀は、Jobs.TerminatingJobsCleanupCron が 0 0 0/3 1/1 * ? *、Jobs.TerminatingJobsTimeout が 1440 です。぀たり、バックグラりンド ゞョブが 3 時間に 1 回実行され、1 日以䞊終了䞭の状態であったゞョブだけが [倱敗] に移行したす。このパラメヌタヌは既定では非衚瀺です。

PW.StopExploringCron

個人甚ワヌクスペヌスを怜玢するナヌザヌが、必芁な暩限 (フォルダヌに察する衚瀺ず線集の暩限) を持ち続けおいるかどうかを確認するバックグラりンド ゞョブの頻床を cron 匏で蚭定したす。既定倀は 0 25 * ? * * です。぀たり、バックグラりンド ゞョブは 毎時 25 分に実行されたす。ナヌザヌが必芁な暩限を持っおいない堎合、怜玢セッションは終了されたす。このパラメヌタヌは既定では非衚瀺です。

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

むンスタンスでスマヌトカヌド認蚌を有効化するかどうかを蚭定できたす。有効化する堎合は、キヌ <add key="Features.SmartCardAuthentication.Enabled" value="true" /> を远加したす。

OData.BackwardsCompatible.Enabled

Orchestrator API での特殊文字の解析方法を制埡できたす。true に蚭定されおいる堎合、芁求ず応答の本文に含たれる特殊文字が解析されたす。このパラメヌタヌは既定では非衚瀺で、false に蚭定されおいたす。

NotRespondingRobotsJobStartDelay

アップグレヌド埌のロボット ステヌタスの初回チェックに぀いお、遅延を秒単䜍で蚭定できたす。既定では、このパラメヌタヌは UiPath.Orchestrator.dll.config に衚瀺されたせん。

Upload.Queues.MaxNumberOfItems

䞀括アップロヌド機胜で䞀床にアップロヌド可胜な最倧アむテム数を少なくするこずができたす。既定倀は 15000 です。既定では、このパラメヌタヌは UiPath.Orchestrator.dll.config に衚瀺されたせん。

Processes.FilterOutDeleted

Orchestrator によるプロセスの取埗方法を最適化できたす。最適化は、関連するパッケヌゞが削陀された孀立プロセスに察する䞍芁な怜蚌を排陀するこずで実珟したす。これにより、特に倧芏暡デプロむにおいお、むンスタンスの党䜓的なパフォヌマンスが向䞊したす。次の倀を䜿甚できたす。

  • false - パッケヌゞの取埗を最適化し、孀立したプロセスに察する怜蚌を実行したせん。
  • true - パッケヌゞ取埗を最適化したせん。

このパラメヌタヌは非衚瀺で、既定では true に蚭定されたす。぀たり、プロセス取埗を最適化したせん。

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

資栌情報アセットのパスワヌドの保護に䜿甚される暗号化キヌです。ネットワヌク ロヌド バランサヌのある環境を䜿甚しおいる堎合は、すべおのマシンでこのキヌを同䞀にする必芁がありたす。

テナントごずの暗号化キヌを Azure Key Vault に栌玍する堎合は、次のパラメヌタヌを䜿甚しおセットアップしたす。これらのパラメヌタヌは、EncryptionKeyPerTenant.Enabled が true に蚭定され、EncryptionKeyPerTenant.KeyProvider が AzureKeyVault に蚭定されおいる堎合にのみ䜿甚できたす。たた、Azure Key Vault のアクセス ポリシヌで、キヌ、シヌクレット、蚌明曞に関するすべおの暩限を Orchestrator むンスタンスに付䞎しおください。この手順の詳现に぀いおは、このペヌゞをご芧ください。

Azure.KeyVault.ClientId

Orchestrator むンスタンスのアプリケヌション ID です。これは、Azure の [アプリの登録] に ae11aa1a-1234-1234-a123-a12a12aaa1aa ずいう圢匏で蚘茉されおいたす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。䟋: <add key="Azure.KeyVault.ClientId" value="ae11aa1a-1234-1234-a123-a12a12aaa1aa" />

Azure.KeyVault.CertificateThumbprint

Azure が生成した Orchestrator 蚌明曞のサムプリントです。この倀は、Azureの [App Services] > [むンスタンス] > [SSL 蚭定] > [プラむベヌト蚌明曞] (たたは [公開蚌明曞]) に蚘茉されおいたす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。䟋: <add key="Azure.KeyVault.CertificateThumbprint" value="1234123412341234123412341234124312341234" />

Azure.KeyVault.VaultAddress

Azure Key Vault の DNS 名です。これは、Azure Key Vault の [抂芁] の [DNS 名] に https://CustomVaultName.vault.azure.net/ 圢匏で蚘茉されおいたす。既定では、この蚭定は UiPath.Orchestrator.dll.config ファむルに衚瀺されたせん。䟋: <add key="Azure.KeyVault.VaultAddress" value="https://CustomVaultName.vault.azure.net/" />

Azure.KeyVault.DirectoryId

Azure Portal に衚瀺される組織のディレクトリ ID を瀺したす。Azure Key Vault にテナントごずの暗号化キヌを保存する堎合は必須です。䟋: <add key="Azure.KeyVault.DirectoryId" value="c9d0e174-684e-469e-84ea-d32c863ad534" />

Identity Server の蚭定

このセクションには、SSO ログむン、S2S アクセス トヌクン、およびロボットのプロビゞョニングのアクセス トヌクンの蚭定が含たれたす。

シングル サむンオン


次のパラメヌタヌにより、Identity Server を介した SSO ログむンを蚭定できたす。

ExternalAuth.System.OpenIdConnect.ClientId

Identity Server 内で登録されおいる Orchestrator アプリケヌション ID (クラむアント ID) を蚭定できたす。この倀はむンストヌル時に生成され、Identity Server に保存されたす。

ExternalAuth.System.OpenIdConnect.ClientSecret

Orchestrator アプリケヌションが倖郚認蚌システムで認識されるように、クラむアント シヌクレットを蚭定できたす。この倀はむンストヌル時に生成され、Identity Server に保存されたす。

ExternalAuth.System.OpenIdConnect.RedirectUri

Identity Server の認蚌埌の、Orchestrator ぞのリダむレクト URL を指定したす。この URL は Identity Server ず Orchestrator 内で自動的に事前蚭定されるため、倉曎しないでください。既定倀は http://Orchestrator/signinsystemopenidconnect です。

ExternalAuth.System.OpenIdConnect.PostLogoutRedirectUri

ナヌザヌが Orchestrator からログアりトした埌に、Identity Server がリダむレクトするアドレスです。この倀にはお䜿いの Orchestrator URL が自動的に蚭定されたす。

たずえば、UiPath.Orchestrator.dll.config には次のキヌが必芁です。

<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/" />

連携


Identity Server にデヌタを安党に䌝達するには、Orchestrator はトヌクン認蚌甚のアクセス トヌクンを必芁ずしたす。このトヌクンは、クラむアント資栌情報フロヌ (S2S) を介しお Identity Server から取埗されたす。次のキヌを UiPath.Orchestrator.dll.config に远加する必芁がありたす。

IdentityServer.GroupMembershipCacheExpireHours

Orchestrator に远加された Identity Server グルヌプのキャッシュの有効期限が切れるたでの時間を、時間単䜍で指定できたす。このパラメヌタヌは既定では衚瀺されず、既定倀は 1 です。

IdentityServer.Integration.Enabled

Identity Server ず Orchestrator の連携を有効たたは無効化したす。既定倀は true です。

IdentityServer.Integration.Authority

Identity Server の堎所を蚭定できたす。既定ではこの倀は https://Orchestrator/Identity に蚭定され、Orchestrator の箇所はお䜿いの Orchestrator のむンストヌル アドレスずなりたす。

IdentityServer.Integration.ClientId

Identity Server 内で登録されおいる S2S アクセス トヌクンを生成するために䜿甚するアプリケヌション ID (クラむアント ID) を蚭定できたす。この倀はむンストヌル時に生成されたす。

IdentityServer.Integration.ClientSecret

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

IdentityServer.Integration.AccessTokenCacheBufferInSeconds

アクセス トヌクンのキャッシュ バッファの有効期限が切れるたでの時間を秒単䜍で蚭定できたす。既定倀は 50 です。

IdentityServer.Integration.UserOrchestratorApiAudience

Identity Server は、オヌディ゚ンスが異なる耇数のアクセス トヌクンを生成できたす。Orchestrator API の芁求の認蚌には、そのオヌディ゚ンスを持぀ナヌザヌ アクセス トヌクンを䜿甚できたす。既定倀は 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" />

Identity Server により生成されたクラむアント資栌情報 (S2S) アクセス トヌクンを䜿甚するのに、Orchestrator は次のキヌを UiPath.Orchestrator.dll.config に远加する必芁がありたす。

IdentityServer.Integration.S2SOrchestratorApiAudience

S2S アクセス トヌクンを怜蚌する際に Orchestrator が確認するオヌディ゚ンスを蚭定できたす。既定倀は OrchestratorApiS2SAccess です。

たた、UiPath.Orchestrator.dll.config に次の既存のキヌも含たれおおり、倀が true に蚭定されおいるこずを確認したす。

MultiTenancy.AllowHostToAccessTenantApi

true に蚭定するず、ホスト ナヌザヌが他のテナントの固有デヌタにアクセスできたす。既定では、この倀は true に蚭定されおいたす。

MultiTenancy.TenantResolvers.HttpGlobalIdHeaderEnabled

S2S アクセス トヌクンを䜿甚しお認蚌された API 呌び出しを Orchestrator が受信するず、蚭定が true の堎合は API 芁求のヘッダヌのテナント グロヌバル ID を読み蟌むこずで、Orchestrator がテナントを識別できたす。

<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 サヌビスはアクセス トヌクンの生成を匕き継ぎたす。

曎新サヌバヌの蚭定

このセクションでは、曎新サヌバヌを構成するパラメヌタヌに぀いお説明したす。

UpdateServer.CheckUpdates.PollingInterval

クラむアントが曎新を確認する頻床です。既定倀は 180 分です。

UpdateServer.CheckUpdates.DefaultForceInstallAfterMinutes

曎新が延期されおいる堎合、䜕分埌に匷制曎新を開始するかを指定したす。既定倀は 1440 分です。

UpdateServer.CheckUpdates.ScheduledForceInstallAfterMinutes

曎新が延期されおいる堎合、䜕分埌に匷制曎新を開始するかを指定したす。この蚭定は、スケゞュヌルされた曎新に察しおのみ有効です。既定倀は 10 分です。

UpdateServer.CheckUpdates.MaxRetries

曎新に倱敗した堎合のリトラむ回数を指定したす。既定倀は 3 です。

UpdateServer.UpdateRequest.RetryStepMinutes

リトラむの実行方法を時系列で指定したす。

䟋

  • 1 回目のリトラむ: 蚭定倀を経過した埌 (分単䜍)
  • 2 回目のリトラむ: 蚭定倀を 2 回経過した埌 (分単䜍)
  • 3 回目のリトラむ: 蚭定倀を 4 回経過した埌 (分単䜍)

ログの構成

ロボット ログ

これに察応する UiPath.Orchestrator.dll.config キヌは <logger name="Robot.*" writeTo="database,robotElasticBuffer" final="true" /> です。Robot によっお生成されるログ メッセヌゞを構成するために䜿甚されたす。次のパラメヌタヌを構成する必芁がありたす。

  • 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 - ログに蚘録されたメッセヌゞずロガヌ名ずの間に䞀臎が芋぀かったずきに実行する内容を瀺すフラグ。true に蚭定されおいる堎合は、別の䞀臎の怜玢を行いたせん。false に蚭定されおいる堎合は、同じ゜ヌスを照合する他のルヌルが確認されたす。既定では true に蚭定されおいたす。

スケゞュヌルログ


これに察応する UiPath.Orchestrator.dll.config キヌは <logger name="Quartz.*" minlevel="Info" writeTo="eventLogQuartz" final="true" /> です。スケゞュヌルによっお生成されるログ メッセヌゞを構成するために䜿甚されたす。

📘

泚:

ロヌド バランサヌで蚭定された Orchestrator でスケゞュヌルがスムヌズに実行されるようにするため、quartz.jobStore.clustered パラメヌタヌも true に蚭定しおください。

ログの監芖


察応する UiPath.Orchestrator.dll.config キヌは <logger name="Monitoring.*" writeTo="monitoring" minlevel="Warn" final="true" /> です。[監芖] ペヌゞに衚瀺される゚ラヌ ログを蚭定するために䜿甚されたす。このルヌルを削陀たたは target を倉曎した堎合、゚ラヌ ログは [監芖] ペヌゞに衚瀺されたせん。

ビゞネス䟋倖ログ


これに察応する UiPath.Orchestrator.dll.config キヌは <logger name="BusinessException.*" minlevel="Info" writeTo="businessExceptionEventLog" final="true" /> です。スロヌされたビゞネス䟋倖のログを構成するために䜿甚されたす。たずえば、怜蚌の問題 (䟋: Invalid username) たたはビゞネスの競合 (䟋: License expired)。

他のログ


これに察応する UiPath.Orchestrator.dll.config キヌは <logger name="*" minlevel="Info" writeTo="eventLog" /> です。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 - ElasticSearch URL です。http://elastic_server:9200 などのプロトコルずポヌトを含める必芁がありたす。uri="http://elastic-node1:9200,http://elastic-node2:9200,http://elastic-node3:9200" など、各ノヌドの Elasticseach URL でこのパラメヌタヌを蚭定するこずにより、ロヌド バランサヌの必芁性を取り陀くこずができたす。
  • excludedProperties - Elasticsearch に保存しないデヌタです。
  • index - ログ むンデックスの圢匏。テナントごずに䞀意にするこずも、すべおのテナントで共有するこずもできたす。以䞋の詳现をご芧ください。
  • requireAuth - true に蚭定するず、Orchestrator を Elasticsearch に接続するずきに認蚌が有効化されたす。
  • username - Elasticsearch ぞのログむンに䜿甚するナヌザヌ名を指定したす。requireAuth が true、OAuthEnabled が false に蚭定されおいる堎合にのみ、蚭定する必芁がありたす。
  • password - Elasticsearch ぞのログむンに䜿甚するパスワヌドを指定したす。requireAuth が true、OAuthEnabled が false に蚭定されおいる堎合にのみ、蚭定する必芁がありたす。
  • OAuthEnabled - set this parameter to true to enable OAuth2 and use a token-based authentication mechanism for the Nlog target for Elasticsearch. When enabling this for the first time, you need to provide your current username and password to generate the initial token. For this parameter to take effect, you need to ensure that Logs.Elasticsearch.OAuthEnabled is also set to true and that you properly configured the Elasticsearch server. For more on this, see X-Pack Authentication.

むンデックスの構成


  • 個別むンデックス - index="${event-properties:item=indexName}-${date:format=yyyy.MM}"
    各テナントに個別のむンデックスが䜿甚されたす。぀たり、あるテナントに固有のログは、䞀意のテナント識別子に基づいお生成され、怜玢されたす。この堎合、indexName は、既定でテナント名になりたす。これが既定の蚭定です。この堎合、ログは月ごずに生成されたす。

  • 共有むンデックス - index="robotlogs-${date:format=yyyy.MM.dd}"
    すべおのテナントに察しお 1 ぀のむンデックスが䜿甚されたす。぀たり、テナントに関係なく、すべおのログで同じむンデックスが䜿甚されたす。この堎合、ログは 1 日ごずに生成されたす。共有むンデックスを䜿甚するには、UiPath.Orchestrator.dll.config にキヌ <add key="Logs.Elasticsearch.SharedIndex" value="robotlogs" /> を远加する必芁がありたす。NLog タヌゲットの index パラメヌタヌず同じ倀に蚭定しおください。

🚧

重芁

共有むンデックスに移行するず、個々のむンデックスを䜿甚しお生成されたログが保持されたす。ただし、個別のむンデックスに移行するず、共有むンデックスを䜿甚しお生成されたログは倱われたす。

デヌタベヌスのむベントのログ蚘録


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

  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)

䞊蚘のク゚リでは、次の列を持぀ EventLogs ずいう名前の衚を䜜成したす。

  • Id - 各ログの ID 番号を保持したす。ここでは 1 で始たり、各ログが远加されるたびに倀が増えおいきたす。
  • Timestamp - 各むベントがログ蚘録された時間を保持したす。
  • Level - 各むベントの数倀ログ レベルを保持したす。
  • Message - 該圓する堎合、各むベントのメッセヌゞを保持したす。
  • Exception - 該圓する堎合、各むベントに察しおログに蚘録された䟋倖を保持したす。

📘

泚:

衚に任意の名前を䜿甚し、䞊蚘のク゚リから列を削陀するか、ニヌズに合わせお他の列を远加できたす。

  1. UiPath.Orchestrator.dll.config ファむルで、新しい NLog タヌゲットを远加したす。
<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>

各デヌタベヌス列に远加されるデヌタの察応する parameter の定矩、この䟋では、@timestamp、@level、@message、@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.

NLog では、正垞な機胜を確保するために、デバッグを有効化するこずができたす。既定では、NLog は Off に蚭定されおいたす。UiPath.Orchestrator.dll.config ファむルの次のセクションを蚭定すれば、有効化されたす。

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

📘

泚:

Orchestrator が実行されるナヌザヌ プロファむルは、internalLogFile 属性で指定されおいるパスぞのアクセス暩を持぀必芁がありたす。

箄 1 か月前に曎新


UiPath.Orchestrator.dll.config


改善の提案は、API リファレンスのペヌゞでは制限されおいたす

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