リモートデバッグ

オートメーションの動作は、マシンによって異なることがあります。オートメーションが実行される運用環境のマシンの設定が、オートメーションが設計されたマシンと異なる場合 (たとえば、マシンのハードウェア、ソフトウェア、権限が異なる場合、またはマシンが分離されたネットワークにある場合)、そのマシン上のロボットでプロセスをテストし、デバッグする必要があります。

リモートデバッグ機能を使用することにより、リモートマシンにデプロイされたロボット (クロスプラットフォームプロジェクトを実行できる Linux 環境のロボットなど) で、有人プロセスと無人プロセスを実行およびデバッグできます。

次のいずれかの接続の種類で、リモートロボットに接続できます。

リモートマシン - リモートマシンでロボットへの TCP/IP 接続を確立します。
Unattended ロボット - Orchestrator を使用している同じテナントの Unattended ロボットに接続します。

リモートデバッグを使用するには、そのプロジェクトが Studio で開かれている必要があります。ソース管理を使用している場合は、確実に最新バージョンのプロジェクトで作業できるように、[パブリッシュ直前にチェックインを強制実行] デザイン設定を有効にすることをお勧めします。

注: コード化されたオートメーションに対してリモートデバッグを実行することはできません。

リモートマシン接続

リモートマシン接続を使用してプロジェクトを実行またはデバッグするには、以下の手順を実行します。

すべての前提条件が満たされていることを確認します。
リモートマシンで、リモートデバッグ要求を受け入れるロボットを設定します。
対話型認証が強制されている Orchestrator で、無人プロセスを実行またはデバッグする場合は、リモートロボットが以下のいずれかの条件を満たしていることを確認します。
- 対話型サインインを使用して Orchestrator に接続されている。
- クライアント資格情報またはマシンキーを使用して接続されており、ユーザーが Assistant からサインインしている
- クライアント資格情報またはマシンキーを使用して接続されており、Assistant からサインインしているユーザーがいない。また、マシンに対するトラブルシューティングセッションが Orchestrator で有効化されている。詳しくは、「無人プロセスをデバッグする」をご覧ください。
Studio で、以下の手順を実行します。
1. リモートロボットへの接続を設定します。
2. リモート実行が有効化されていることを確認します。
3. プロジェクトを実行またはデバッグします。

前提条件

Studio のマシンとリモートマシン間に TCP/IP 接続が確立されている。
リモート環境の Robot のバージョンが Studio と同じである。
対応している .NET Framework がお使いのリモートマシンにインストールされます。

リモートマシンでロボットを設定する

リモートロボットをデバッグで使用するには、事前に Studio からのリモートデバッグ要求を受け入れるようにマシン上の UiPath.RemoteDebugging.Agent ユーティリティを設定する必要があります。

インストールディレクトリに移動します。
- Windows 環境のロボットの場合 - UiPath のインストールフォルダー (既定では、マシン単位のインストールの場合は %PROGRAMFILES%\UiPath\Studio、ユーザー単位のインストールの場合は %localappdata%\Programs\UiPath\Studio) でコマンドプロンプトを開きます。
- Linux 環境のロボットの場合 - コマンドラインターミナルから /root/application に移動します。
- macOS ロボットの場合 - zsh から /Applications/UiPath Assistant.app/Contents/Robot に移動します。
次のコマンドを実行します。
- Windows 環境のロボットの場合 - UiPath.RemoteDebugging.Agent.exe enable --port <port_number> --password <pasword> --verbose
- Linux 環境のロボットの場合 - ~/application # dotnet ./UiPath.RemoteDebugging.Agent.dll enable --port <port_number> --password <pasword> --verbose
- macOS ロボットの場合 - dotnet UiPath.RemoteDebugging.Agent.dll enable --port <port_number> --password <pasword> --verbose
  
  コマンドの引数はすべて任意です。
- --port <port_number> - Studio からリモートデバッグコマンドを受け取るために使用するポートを入力します。指定しないと、既定でポート 8573 が使用されます。
  
  ポートがファイアウォールで開かれていて、他のアプリケーションにまだバインドされていない必要があります。
- --password <password> - リモートデバッグエージェントへの接続を設定するときに Studio で指定する必要のあるパスワードを入力します。
- --verbose - 詳細な情報をコンソールに記録します。
次のメッセージが表示されます。

Robot on machine <hostname> is waiting for remote debugging instructions on port <port_number>
hostname と port_number の値を書き留めます。これらの値は、Studio で接続を設定するときに指定する必要があります。

ロボットがリモートデバッグステートの間は、Orchestrator またはローカルの Assistant から有人ジョブまたは無人ジョブを実行することはできません。Robot のインストールがライセンスされていないマシンにも、リモートデバッグコマンドを送信できます。

リモートマシン接続を設定する

Studio で、[デバッグ] タブを選択します。
リボンで [リモートデバッグ] の下にある矢印を選択してから、[リモートデバッグを設定] を選択して [リモートデバッグ設定] ウィンドウを開きます。
[接続の種類] ドロップダウンから [リモートマシン] を選択します。
対応するボックスに、以下の情報を入力します。
- ホスト - リモートマシンのホスト名または IP アドレス。
- ポート - 使用するポート。既定のポートは 8573 です。
- パスワード - ロボット端末でリモートデバッグエージェントが設定されたときに指定されたパスワード (該当する場合)。
(任意) 現在の設定で接続を確立できることを確認するには、[テスト接続] をクリックします。
[保存] をクリックします。

Unattended ロボット接続

Orchestrator に接続されている Unattended ロボットを使用して、リモートでプロジェクトを実行またはデバッグするには、以下の手順を実行します。

すべての前提条件が満たされていることを確認します。
リモートロボットへの接続を設定します。
リモート実行が有効化されていることを確認します。
プロジェクトを実行またはデバッグします。

前提条件

Studio と対象のロボットが同じ Orchestrator テナントに接続されている。
リモート環境の Robot のバージョンが Studio と同じである。
Studio、対象の Robot、Orchestrator が v2021.10 以降を実行している。
Studio にサインインしているユーザーが、対象のロボットと同じフォルダーコンテキストでのジョブの開始権限およびストレージバケットとストレージファイルの作成・削除権限を持っている。さらに、ロボットアカウントがストレージバケットとストレージファイルの表示権限を持っている。
Unattended ロボットが設定済みであり、マシンで Unattended、NonProduction、または Testing のいずれかのランタイムライセンスを利用できる。

注: リモートデバッグ用の Testing ランタイムは、Orchestrator 2022.4 以降でサポートされています。
フォアグラウンドプロセスをデバッグする場合は、Orchestrator でロボットに対して [フォアグラウンドオートメーションを実行] オプションが有効化されている。
トラブルシューティングセッションを使用する場合は、ロボットを Orchestrator に接続した後に有効化する必要があります。

Unattended ロボット接続を設定する

Studio で、[デバッグ] タブを選択します。
リボンで [リモートデバッグ] の下にある矢印を選択してから、[リモートデバッグ設定] を選択します。
[接続の種類] ドロップダウンから [Unattended ロボット] を選択します。
Studio のステータスバーから選択した Orchestrator フォルダーにある接続済みの利用可能なマシンを使用するには、[保存] をクリックします。接続先のマシンを選択する場合は、以下のオプションを使用します。
- ユーザー - Orchestrator フォルダーに割り当てられた Unattended ロボットを持つアカウントを選択します。
- マシン - Orchestrator フォルダーからマシンまたはテンプレートを選択します。
- ホスト名 - 接続済みマシンのリストからマシンを選択します。
- ライブストリーミングを表示 - ロボットによって実行されるアクションを表示する場合に選択します。詳しくは、「ライブストリーミングとリモート制御」をご覧ください。
  
  注: Orchestrator で設定されたアカウントに変更を加えた場合、Studio のステータスバーのボタンを使用して Orchestrator の接続を更新し、このウィンドウに反映されるようにします。

リモート実行

リモートデバッグ接続が確立されている場合、リボンの [リモートデバッグ] ボタンをクリックして、リモート実行とローカル実行を切り替えることができます。実行操作またはデバッグ操作を選択する前に、必要なオプションが有効化されていることを確認してください (リモートまたはローカル)。

ボタンが灰色で強調表示されている場合、すべての実行操作とデバッグ操作 ([ファイルをデバッグ]、[ファイルを実行]、[プロジェクトをデバッグ]、[プロジェクトを実行]、[ステップイン/オーバー/アウト]、[アクティビティをテスト]、[このアクティビティまで実行/このアクティビティから実行]) はリモートロボットで実行されます。
ボタンが灰色で強調表示されていない場合、すべての実行操作とデバッグ操作はローカルロボットで実行されます。

リモートデバッグ操作はローカルデバッグ操作とほぼ同じであり、ローカルデバッグで使用できる機能はすべて、リモートデバッグでも使用できます。[デバッグ] タブからトリガーされたリモート実行が進行中の場合、Studio のステータスバーは緑で表示されます。

リモートデバッグに使用する接続の種類に応じて、リモートロボットは次のように、プロジェクトの実行に必要なアクティビティパッケージを取得します。

リモートマシン接続 - Studio はプロジェクト依存関係とアクティビティフィード (パッケージソース) のリストをリモートロボットに送信します。ロボットは Studio から提供されたフィードを使用して、必要なパッケージをダウンロードします。
Unattended ロボット接続 - Studio はプロジェクト依存関係のリストのみをリモートロボットに送信します。ロボットは Orchestrator フィードとリモートロボットで設定されたアクティビティフィードを使用して、必要なパッケージをダウンロードします。

Unattended ロボット接続では、[ライブストリーミングを表示] を選択すると、ロボットが実行しているアクションをリアルタイムで可視化できます。リモート実行中に新しいライブストリーミングウィンドウが開きます。このウィンドウは移動やサイズ変更が可能です。また、詳細なデバッグを行う場合や、(たとえば、クリックが必要な UI 要素によって) 実行がブロックされた場合にオートメーションを一時停止することなくリモート制御を実行することもできます。ワークフローが終了するとすぐに、ライブストリーミングウィンドウは非表示になります。サーバーレスな Automation Cloud ロボットには追加の操作は不要ですが、Windows ロボットには VNC サーバーの設定が必要です。

注: リモートデバッグ中にアカウントからサインアウトすることはお勧めしません。

既知の制限事項

リモートマシン接続を使用するときに、デバッグを長期間停止すると、リモートマシンで接続がアクティブであるように見えても、Studio で接続が閉じられるエラーが発生することがあります。この問題を回避するには、クラウドまたはオンプレミスのロードバランサーで TCP アイドルタイムアウトの値を増やします。
長期実行のワークフローのリモートデバッグは、Unattended ロボット接続でのみサポートされています。
Unattended ロボット接続を使用するときに、[ピクチャインピクチャ] オプションを選択しても、別のセッションで実行が開始されることはありません。
[ライブストリーミングを表示] オプションは、Unattended ロボット上の Robot サービスがサービスモードでデプロイされている場合にのみ機能します。詳細については、「Robot サービス」をご覧ください。
[ライブストリーミングを表示] オプションは、Automation Cloud Orchestrator と Automation Suite Orchestrator でのみサポートされます。