設定ファイル

構成ファイルを編集した場合、変更を有効にするには Robot の関連コンポーネントを再起動する必要があります。次のリストに、さまざまなコンポーネントを再起動する方法を、Robot のインストール モードに基づいてまとめています。

保存していない作業が失われることがないよう、再起動する前に必ず進行中の作業を保存してください。

• Robot サービス
  • サービス モードのインストール
    1. [タスク マネージャー] > [サービス] を開きます。
    2. UiPathRobotSvc サービスを探します。
    3. サービスを右クリックし、[再起動] を選択します。
  • ユーザー モードのインストール - Assistant を終了して再起動します。または、以下の手順を実行します。
    1. [タスク マネージャー] > [詳細] を開きます。
    2. UiPath.Service.UserHost.exe プロセスを選択します。
    3. [タスクの終了] を選択します。
• 更新サービス
  1. [タスク マネージャー] > [サービス] を開きます。
  2. UiPath.UpdateService.Agent サービスを探します。
  3. サービスを右クリックし、[再起動] を選択します。
• UiPath RobotJS ServiceHost
  1. [タスク マネージャー] > [サービス] を開きます。
  2. UiPath.RobotJS.ServiceHost サービスを探します。
  3. サービスを右クリックし、[再起動] を選択します。
• UiPath Assistant
  1. Assistant で、[設定] を選択して、[終了] を選択します。
  2. Assistant を再起動します。
• ウィジェット - Assistant を再起動します。または、以下の手順を実行します。
  1. タスクバーの Assistant のアイコンを右クリックします。
  2. [ウィジェットを再読み込み] を選択します。

uipath.config

UiPath.config ファイルには、Robot に不可欠な構成パラメーターが含まれています。管理者は、構成ファイルのパラメーターのリストを編集して、ロボットの動作をカスタマイズできます。

注:

環境ごとに固有の注意が必要な場合があるため、UiPath では、ロボットの現在の環境が開発、ステージング、運用のいずれであっても、その環境に基づいて異なる構成を適用できます。このファイルを編集するときは常に注意してください。設定が間違っていると、アプリケーションに問題が発生することがあります。

ファイルにアクセスする

Robot をインストールすると、UiPath.config ファイルが作成されます。

ログにアクセスするには、C:\Program Files\UiPath\Studio\UiPath.config に移動します。

カスタマイズ可能な設定

UiPath.config ファイルは、以下のパラメーターで構成されます。

• connectionSettings 構成セクション
  • DefaultServiceUrl (string) - ロボットが Orchestrator に接続するために使用する既定のアドレスを設定します。例：

    string DefaultServiceUrl = "https://cloud.uipath.com"

  • AutoSignIn (bool) - Assistant の自動サインイン機能を有効化します。既定値は false です。以下に例を示します。

    bool AutoSignIn = true.

  • EnforceDefaultServiceUrl (bool) - DefaultServiceUrl で指定したアドレスをすべてのユーザーに適用します。既定値は false です。例：

    bool EnforceDefaultServiceUrl = true.

• communicationSettings 構成セクション
  • MaxMessageSizeInMegabytes (byte) - システムが送受信できるメッセージの最大サイズを MB 単位で設定します。既定値は 10 です。

    大きすぎるメッセージを処理することによる過負荷やプロセスのクラッシュを防止するために使用します。 例：

    byte MaxMessageSizeInMegabytes = 10;

  • InstallPackageTimeout (TimeSpan) - パッケージのインストールの制限時間を設定します。既定値は 20 分です。

    パッケージのインストールに定義された時間よりも長い時間がかかる場合、インストールは中止されます。 例：

    TimeSpan InstallPackageTimeout = TimeSpan.FromMinutes(20);

  • RequestTimeout (TimeSpan) - システムが通信の応答を待機する時間を定義します。既定値は 40 秒です。

    設定された時間内に応答を受信しない場合、システムは停止して次の処理に進みます。 これにより、システムのハングアップを防止します。 例：

    TimeSpan RequestTimeout = TimeSpan.FromSeconds(40);

• packageSettings 構成セクション
  • PackagesInstallationFolder (string) - パッケージをインストールする既定のディレクトリを設定します。既定値は C:\UiPath\Packages です。
  • SkipHttpConfigurationSources (bool) - HTTP 上に設定されているパッケージ ソース (NuGet フィードなど) をシステムが無視できるようにします。既定値は false です。

    つまり、システムはこれらのソースからパッケージを取得しません。このため、ソースが信頼できない場合や安全でない場合に便利です。

  • DisableSecureXaml (bool) - 安全でない可能性があるワークフローの実行をロボットに許可します。既定値は false です。
  • DirectDownload (bool) - ユーザーへの確認なしにパッケージを直接ダウンロードすることを許可します。既定値は false です。
  • PackageSaveWithoutNupkg (bool) - パッケージを .nupkg ファイルなしで保存することを許可します。既定値は false です。

    ダウンロード サイズを減らすのに役立ちます。

• analyticsSettings 構成セクション
  • Telemetry.Enabled (bool) - UiPath が分析のために使用状況データを収集および送信することを許可します。既定値は false です。
• robotCacheSettings 構成セクション
  • SessionCacheDuration (TimeSpan) - 特定のセッションのデータをキャッシュに保持して破棄するまでの期間を定義します。既定値は 30 秒です。

    変数の値や操作の詳細などのデータを、再作成または再取得するのではなく再利用する場合に便利です。 例：

    TimeSpan SessionCacheDuration = TimeSpan.FromSeconds(30);

  • GetResourceUrlCacheDuration (TimeSpan) - API や Web ページなどのリソースの URL をキャッシュに保存する期間を定義します。既定値は 1 時間です。

    ロボットが特定のリソースに何度もアクセスする必要がある場合にパフォーマンスを最適化するのに役立ちます。 例：

    TimeSpan GetResourceUrlCacheDuration = TimeSpan.FromHours(1);

• robotJsSettings 構成セクション
  • ListenerPort (int) - Robot.js が受信接続をリッスンするポート番号を設定します。既定値は 2323 です。

    これにより、Robot サービスは、ローカル サーバーまたはリモート サーバーで実行されている Web アプリケーションと対話できます。 例：

    int ListenerPort = 2323;

  • TokenExpiryInDays (int) - Robot サービスによって生成される認証トークンの有効期間を日数で設定します。既定値は 30 日です。

    Robot サービスは、他のソフトウェア コンポーネントやサービスと対話する際にこれらのトークンを使用して自身を認証します。 例：

    int TokenExpiryInDays = 30;

  • AllowUrlList (string) - Robot サービスがアクセスできる URL のリストを設定します。Robot サービスが承認されたサービスとのみ対話するようにするのに役立ちます。例：

    string AllowUrlList = "https://cloud.uipath.com";

重要:

• 変更を加える前に、必ず元の UiPath.config ファイルのバックアップを作成してください。問題が発生した場合に元の設定を復元するのに役立ちます。
• UiPath.config ファイルに加えた更新内容を適用するには、UiPath サービスまたはシステムを再起動します。
• UiPath.config ファイルでのローカルの設定は、Orchestrator での設定よりも優先されます。
• UiPath.config ファイル内の機密データを暗号化してセキュリティを強化できます。

UiPath Robot のシステム変数

システム環境変数を使用して、さらに細かくカスタムの動作を設定できます。

重要:

いずれかのシステム変数を変更したら、Robot サービスを再起動してください。

次のリストは、最も一般的なユース ケースをまとめたものです。

• UIPATH_SESSION_TIMEOUT - 対話型セッションを作成するための既定の 60 秒のタイムアウトを変更します。ロボットが対話するシステムのパフォーマンスと読み込み時間に基づいてロボットの動作を適応させるには、この値を調整します。

  例：

  UIPATH_SESSION_TIMEOUT=75

• UIPATH_PIP_SESSION_TIMEOUT - ロボット セッションでプロセスを開始する場合の既定の 180 秒のタイムアウトを変更します。

  例：

  UIPATH_PIP_SESSION_TIMEOUT=60

• UIPATH_LANGUAGE - ロボットが動作する言語を設定します。優先順位は次のとおりです。
  1. UIPATH_LANGUAGE 件の値
  2. マシンの環境変数
  3. 現在のスレッドの UI の言語設定
  4. UiPath の既定の言語 (英語)

  例：

  UIPATH_LANGUAGE=French

• UIPATH_HEADLESS_WITH_USER - Orchestrator に設定済みの特定のユーザーの資格情報を使用します。

  例：

  UIPATH_HEADLESS_WITH_USER=True

• UIPATH_PRE_LOADED_EXECUTOR - 既定では、ロボットの起動時に、事前読み込み済みの Executor が起動します。この動作を変更し、最初のプロセスの実行時にのみ事前読み込み済みの Executor を起動するには、この変数を None に設定します。

  例：

  UIPATH_PRE_LOADED_EXECUTOR=None

• UIPATH_DISABLE_PRE_LOADED_EXECUTOR - 事前読み込みされた実行機能を無効化します。

  例：

  UIPATH_PRE_LOADED_EXECUTOR=None

• UIPATH_ROBOTJS_ALLOWLIST - Robot JS SDK と Robot Executor 間の接続を確立するときに、ロボットの同意ダイアログを自動的に受け入れます。

  この変数には、複数のカスタム アプリケーションの URL をセミコロンで区切って指定できます。ポート番号が標準のポート (80 または 443) と異なる場合は、URL にポート番号を含めてください。

  例：

  UIPATH_ROBOTJS_ALLOWLIST=cloud.uipath.com;mydomain.com;

• UIPATH_DNS_MACHINENAME - RDP セッションの作成時にローカルホストに DNS ホスト名を使用することを許可します。RDP に Kerberos 認証を使用する環境で無人ジョブを実行するには、この値を True に設定します。

  例：

  UIPATH_DNS_MACHINENAME=True

• NUGET_FALLBACK_PACKAGES - フォールバック パッケージ フォルダーへのパスを設定します。複数のパスを区切るには、セミコロンを使用します。
  この変数がない場合、ロボットはフォールバック パッケージ フォルダーを Nuget.config ファイル内で検索します。
• NUGET_SCRATCH - 同じマシン上の複数のユーザー モードの Robot が、パッケージを保存するローカル パスを共有できるようにします。

  この値は、NuGet のインストール フォルダーとは異なるパスにする必要があります。また、これは NuGet の一時フォルダーとして機能します。

  注: 設定する一時フォルダーは、NUGET_SCRATCH 変数でのみ使用してください。

  例：

  NUGET_SCRATCH=C:\NuGetTempFolder

• UIPATH_PRESERVE_CREDENTIALS_CASE - ログ記録用の資格情報の、元の大文字と小文字 (ドメイン\ユーザー名) を保持します。

  例：

  UIPATH_PRESERVE_CREDENTIALS_CASE = True

• UIPATH_SESSION_BEHAVIOR - ジョブ完了後のセッション復元動作を設定します。次のオプションが利用できます。
  • TryReuseAndRestoreSession — 既定のオプションです。ジョブの完了後に、セッションを再利用して以前のステートへの復元を試みます。再利用する初期セッションがない場合は、復元時にログオフします。
  • ForceNew — 以前のセッション ステートに関係なく、まったく新しいセッションを作成します。復元時には常にログオフします。
  • LeaveSessionActive — 初期セッション ステートの復元を防止します。
  • LeaveSessionDisconnected — 復元時に常にセッションを切断します。

  例：

  UIPATH_SESSION_BEHAVIOR = LeaveSessionDisconnected

• UIPATH_HTTP_CONNECTION_LIFETIME - Orchestrator への接続を開いたままにする時間を定義します。この時間を過ぎると、接続は閉じられて更新されます。既定の時間は 30 分ですが、この値を調整するには秒単位の値を使用します。

  例：

  // to set 10 minutes                          
  UIPATH_HTTP_CONNECTION_LIFETIME = 600

• UIPATH_FILE_LOG_LEVEL - ローカル ファイルで使用される実行ログ レベルを定義します。これは、Orchestrator で使用されるログ レベルとは異なります。次のオプションが利用できます。
  • Verbose
  • Trace (トレース)
  • Information
  • Warning
  • Error
  • Critical
  • Off

  例：

  // to set verbose level locally
  UIPATH_FILE_LOG_LEVEL = Verbose

• UIPATH_EXECUTOR_STARTUP_DELAY - セッションが作成されてから Executor が起動されるまでの待機時間を秒単位で定義します。インフラストラクチャにおいて、一部のサービス (VPN、セキュリティ) を読み込んでからオートメーションの実行を開始する必要がある場合に使用します。

  例：

  // to set the delay to 5 seconds
  UIPATH_EXECUTOR_STARTUP_DELAY = 5