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 - テナントごとに異なる暗号化キーを使用します。テナントのセキュリティを強化し、機密データをより適切に分離します。

この機能を有効化するには、「セキュリティで保護されたアプリ設定」セクションで説明されているパラメーターに加えて、EncryptionKeyPerTenant.KeyProvider パラメーターも設定する必要があります。

EncryptionKeyPerTenant.KeyProvider

Orchestrator からテナントごとに生成した暗号化キーの格納に使用するキー管理アプリケーションを指定できます。事前設定された Microsoft Azure Key Vault を使用するには、AzureKeyVault に設定します。UiPath では Azure Key Vault ライセンスを提供していません。「セキュリティで保護されたアプリ設定」セクションで説明しているパラメーターも設定する必要があります。EncryptionKeyPerTenant.Enabled を false に設定すると、このパラメーターは使用されなくなります。

ここで行った暗号化の設定に対する変更は、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
EncryptionKeyPerTenant.KeyProvider	MultiTenantEncryptionKeyProvider

キュー

注: cron ジョブに関する変更を反映させるには、Database.EnableAutomaticMigrations パラメーターをあらかじめ true に設定しておく必要があります。

autogenerateStatistics

トランザクション グラフを自動的に生成します。既定では、このパラメーターは true に設定されています。

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

キュー アイテムが SLA 予測に加味されるために必要な締め切りまでの期間。既定値は 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

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

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

• Orchestrator の 2020.10 よりも前のバージョンからのアップグレードであり、かつ
• 以前の NuGet.Repository.Type が Legacy であり、かつ
• 以前の NuGet.Packages.Path で既定値を使用していなかった場合

ターゲット	場所
ファイルシステム	次のフォーマットで絶対パスを指定します: RootPath=C:\FolderName\AnotherFolderName 例: <add key="Storage.Location" value="RootPath=C:\FolderName\AnotherFolderName" />。 指定したフォルダー内に、次のフォルダー構造が作成されます: Orchestrator-Host\Libraries - ホスト フィードに保存されるライブラリ専用の 1 つのフォルダー Orchestrator-[tenantKey] - テナントごとに 1 つのフォルダー。テナントは、データベースに格納されたテナント キー、たとえば Orchestrator-12ab1234-a567-456b-a12b-ab3456b123ab のようなもので識別されます。 各テナント フォルダーには、その他に次の 3 つのサブディレクトリが作成されます。 \ExecutionMedia \Packages \Libraries ファイルは、指定した場所の専用フォルダーに保存されます。既定では、次のパスに保存されます: C:\Program Files (x86)\UiPath\Orchestrator\Storage
Azure	接続文字列を指定します。 例: <add key="Storage.Location" value="DefaultEndpointsProtocol=https;AccountName=usr;AccountKey=...;EndpointSuffix=core.windows.net" />。
Amazon	接続文字列を指定します。 例: <add key="Storage.Location" value="EndpointRegion=eu-west-3;accessKey=AKIAZGUEIGXUJ3BBI4MW;secretKey=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;useHttp=false" />。
MinIO	接続文字列を指定します。 例: <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、S3Compatible ソリューション、FileSystem です。複数の値はコンマで区切って入力できます。

注: 既定では、このキーは UiPath.Orchestrator.dll.config ファイルに表示されず、プロバイダー Orchestrator、Amazon、Azure、Minio のみが選択されています。既定の挙動は、クリーン インストールとアップグレードの両方に対して適用されます。キーが表示されている場合、利用可能なプロバイダーは Buckets.AvailableProviders の値として指定したもののみに限定されます。

例: Minio と FileSystem の使用を制限するには、次のキーを追加します。

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

Buckets.FileSystem.Allowlist

FileSystem バケットの使用可否を制御できます。既定では、このパラメーターには値が設定されていません。新規インストールとアップグレードの両方で、FileSystem は既定で無効化されているため、FileSystem のパスを最初から使用することはできません。セキュリティ上の理由から、FileSystem 機能を使用するには、管理者がまず FileSystem を有効化し、次に、値を Buckets.FileSystem.Allowlist に追加して、フォルダーまたはネットワーク共有のリストへのアクセスを明示的に許可する必要があります。

複数の値を | 記号で区切って入力できます。パスは完全修飾パスで、ルートにドライブを含むか、UNC パスである必要があります (例: c:\、c: est、\\servershare\shared)。それぞれのパスは、すべてのバケットに使用できるプレフィックスです。バケットは、この特定のパス、またはそのサブパスで作成できます。

重要: Buckets.FileSystem.Allowlist の設定を使用して FileSystem の許可リストを作成すると、セキュリティに関する影響があるため、作業を続行する前に「FileSystem ストレージの許可リストを安全に使用する」を参照することを強くお勧めします。

認可

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

注: [Active Directory] グループをインポートするには WindowsAuth.Enabled、WindowsAuth.Domain、AcceptedRootUrls の各パラメーターを構成しておく必要があります。

WindowsAuth.Enabled

Windows Active Directory のユーザー インポート機能を有効または無効化します。Windows Active Directory を使用した認証を有効化するには、Identity Server の [外部プロバイダー] 内で設定します。

WindowsAuth.Domain

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

WindowsAuth.GroupMembershipCacheExpireHours

Orchestrator に追加された Active Directory グループのキャッシュが期限切れになるまでの時間 (時間単位)。この設定は既定では UiPath.Orchestrator.dll.config ファイルに表示されず、既定値は 1 時間に設定されています。

WindowsAuth.ConvertUsersAtLogin

true に設定すると、AD 資格情報を持つ各ローカル AD ユーザーが AD 資格情報で最初にログインした際に、ディレクトリ ユーザーに変換されます。これに代わる方法として、こちらで説明しているスクリプトを使用して、AD の資格情報でログインしているすべてのローカル AD ユーザーをディレクトリ ユーザーに変換することもできます。既定では、このパラメーターは UiPath.Orchestrator.dll.config ファイルに表示されません。既定では false に設定されています。

AcceptedRootUrls

信頼できる URL のリストを追加できます。この設定に属する値がない場合は、誰も Orchestrator にアクセスできません。複数の URL を追加する場合は、スペースを入れず、項目をコンマ (,) で区切ります (例: "https://server1,https://server2")。

Auth.Cookie.Expire

自動的にログオフされるまでの時間 (分) です。既定では、この値は 30 分に設定されています。

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

アクセス トークンのターゲット オーディエンスを制御できます。このパラメーターは、Auth0 トークン オーディエンスと照合するために使用される有効なオーディエンスに設定する必要があります。たとえば、オーディエンスを https://cloud.uipath.com に設定したい場合は、キー <add key="ExternalAuth.AccessTokenAuth.Audience" value="https://cloud.uipath.com" /> を追加する必要があります。既定では、この設定は UiPath.Orchestrator.dll.config ファイルに表示されません。

ExternalAuth.ShowPII

キー <add key="ExternalAuth.ShowPII" value="true" /> を追加することで Orchestrator の PII の表示を許可します。このキーは既定では UiPath.Orchestrator.dll.config に表示されず、既定の動作では PII の表示が許可されていません。

WindowsAuth.GroupMembershipCacheExpireHours

Active Directory グループ メンバーシップ キャッシュを設定できます。既定値は 1 で、Active Directory グループ メンバーシップに加えられた変更は、アクティブなユーザー セッションに対して 1 時間ごとに Orchestrator と同期されます。

RestrictBasicAuthentication

Identity Server の appSettings.json に移動されました。

EnableBasicAuthenticationForHostTenant

Identity Server の appSettings.json に移動されました。

ロード バランサー

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

LoadBalancer.UseRedis

データベースとして Redis を使用して、ロード バランサー経由で接続しているすべてのサーバーとの間でメッセージの配信とキャッシュ処理を行います。既定では、false に設定されています。

LoadBalancer.Redis.ConnectionString

LoadBalancer.UseRedis が true に設定されている場合にのみ使用できます。Redis サーバーを設定できるようにするための接続文字列です。サーバーの URL、パスワード、Redis が使用するポートを含みます。また、Orchestrator ノードと Redis サービスの間で SSL 暗号化接続を有効化することもできます。詳しくは、こちらをクリックしてください。例:

• 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

これらの設定は、CyberArk、CyberArk CCP、または Azure Key Vault などの、使用している任意の資格情報ストアのプラグインを含むように更新する必要があります。資格情報ストア プラグインは、インストール ディレクトリの \Orchestrator\Plugins フォルダーにあります。以下に例を示します。

• 単一のストアを使用する場合: <add key="Plugins.SecureStores" value="UiPath.Orchestrator.CyberArk.dll"/>
• 複数のストアを使用する場合: <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

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 認証

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

ログ

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

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 による仲介は行われなくなります。このオプションは、Azure がホストする Orchestrator インスタンスがある場合にだけ使用するようにしてください。Scalability.AzureSignalR.ConnectionCount キーと組み合わせて使用できます。このパラメーターは UiPath のクラウド製品で有効化されます。既定では、UiPath.Orchestrator.dll.config ファイルに表示されません。

有効化すると、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 ファイルに表示されません。

分析

Telemetry.Enabled

問題の診断および Orchestrator の改善を目的として UiPath が使用する、使用状況とパフォーマンスに関するデータの収集を有効化/無効化します。UiPath プライバシー ポリシーのプラクティスについては、プライバシー ステートメントをご覧ください。次の値を使用できます。

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

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

メディア レコーディング

MediaRecording.Enabled

true に設定すると、レコーディング機能が有効化されます。既定では false に設定されており、この機能は無効化されています。ファイル ストレージは、NuGet.Repository.Type パラメーターの影響を受けます。また、NuGet.Repository.Type が Composite に設定されている場合は、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.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" /> を追加します。

その他

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

インスタンスで長期実行ワークフローをサポートするかどうかを設定できます。有効化するには、キー <add key="Features.LongRunning.Enabled" value="true" /> を追加します。

Tasks.ModuleEnabled

インスタンスでアクション機能を有効化するかどうかを設定できます。有効化するには、キー <add key="Tasks.ModuleEnabled" value="true" /> を追加します。この設定によって、この機能をインスタンス レベルで使用できるようになります。この機能をテナント別に設定するには、こちらに記載されている手順に従います。この設定を適用するには、Features.LongRunning.Enabled パラメーターを true に設定する必要があります。

Features.SmartCardAuthentication.Enabled

インスタンスでスマートカード認証を有効化するかどうかを設定できます。有効化する場合は、キー <add key="Features.SmartCardAuthentication.Enabled" value="true" /> を追加します。

ActiveDirectory.SearchInputMinimumLength

検索をトリガーするクエリの最小サイズ。既定値は 2 です。これは、2 文字以上を入力すると検索が実行されることを意味します。既定では、このパラメーターは UiPath.Orchestrator.dll.config ファイルに表示されません。例: <add key="ActiveDirectory.SearchInputMinimumLength" value="4" />

ActiveDirectory.SearchResultsSizeLimit

Active Directory ユーザーまたはグループを検索したときに返される結果の最大数。既定値は 20 です。既定では、このパラメーターは UiPath.Orchestrator.dll.config ファイルに表示されません。例: <add key="ActiveDirectory.SearchResultsSizeLimit" value="30" />

ActiveDirectory.SearchResultsTimeLimitSeconds

クエリで許容される検索時間の最大値。この時間を超過すると検索が中断され、その時点までに見つかった結果が返されます。既定値は 30 秒です。既定では、このパラメーターは UiPath.Orchestrator.dll.config ファイルに表示されません。例: <add key="ActiveDirectory.SearchResultsSizeLimit" value="40" />

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

次の設定を使用して、Orchestrator インスタンスの証明書がローカル マシンの証明書ストアにインストールされるよう指定します。<add key="CertificatesStoreLocation" value="LocalMachine" />appsettings.Production.json の AzureKeyVaultCertificateStoreLocation に同じ値が設定されていることを確認してください。

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

暗号化キー

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

テナントごとの暗号化キーを 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/" />

Identity Server の設定

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

シングル サインオン

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

ExternalAuth.System.OpenIdConnect.Enabled

Orchestrator の外部認証システムへの接続を有効または無効化します。既定値は true です。

ExternalAuth.System.OpenIdConnect.Authority

外部認証システムの場所を設定できます。既定ではこの値は https://Orchestrator/Identity に設定され、Orchestrator の箇所はお使いの Orchestrator のインストール アドレスとなります。

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

連携

Identity Server にデータを安全に伝達するには、Orchestrator はトークン認証用のアクセス トークンを必要とします。このトークンは、クライアント資格情報フロー (S2S) を介して Identity Server から取得されます。次のキーを UiPath.Orchestrator.dll.config に追加する必要があります。

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

S2S アクセス トークンの消費を有効または無効化します。このパラメーターは 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.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 サービスはアクセス トークンの生成を引き継ぎます。

ログの構成

ロボット ログ

これに対応する UiPath.Orchestrator.dll.config キーは <logger name="Robot.*" writeTo="database,robotElasticBuffer" final="true" /> です。Robot によって生成されるログ メッセージを構成するために使用されます。次のパラメーターを構成する必要があります。

• writeTo - ロボットが生成したログ メッセージが書き込まれる場所です。次の値を使用できます。
  • database - ログは Orchestrator の SQL データベースに送られます。これは既定値の 1 つです。
  • robotElasticBuffer - ログは Elasticsearch に送信されます。これは 2 番目の既定値です。これには追加の設定が必要です。詳しくは、こちらをご覧ください。

    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 - ログ インデックスの形式。テナントごとに一意にすることも、すべてのテナントで共有することもできます。以下の詳細をご覧ください。

インデックスの構成

• 個別インデックス - 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 - 該当する場合、各イベントに対してログに記録された例外を保持します。
     注: 表に任意の名前を使用し、上記のクエリから列を削除するか、ニーズに合わせて他の列を追加できます。
2. 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 です。

3. 最後に、次を追加して、新しく作成されたターゲットを、上記のすべての Orchestrator メッセージの NLog ロガー分類に関連付けます。

   <logger name="*" minlevel="Info" writeTo="eventLog,eventLogDatabase" />

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

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

重要: カスタムの NLog ターゲットは、アップグレード時に自動的に移行されません。それらは、Identity Server と Webhook サービスに手動で移行する必要があります。Identity Server の NLog ドキュメントをご覧ください。

NLog と Orchestrator では、一部重複しているものの、ログ レベルが異なります。NLog では、Trace、Debug、Info、Warn、Error、Fatal、または Off を選択できます。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 で指定されているパスへのアクセス権を持つ必要があります。