デバッグの操作

単一のファイルまたはプロジェクト全体のデバッグは、[デザイン] または [デバッグ] リボン タブの両方から実行できます。ただし、プロジェクト ファイルに検証エラーがある場合、デバッグ プロセスは使用できません。

ステップ イン

[ステップ イン] を使用して、アクティビティを 1 つずつデバッグします。この操作がトリガーされると、デバッガーが開き、実行される前にアクティビティが強調表示されます。

ステップ インが[ワークフロー ファイルを呼び出し] アクティビティで使用されると、ワークフローは ReadOnly モードで新しいタブで開かれ、各アクティビティが 1 つずつ実行されます。

ステップ インのキーボード ショートカットは F11 です。

ステップ オーバー

ステップ オーバー機能は、ステップ インとは異なり、現在のコンテナーを開くことはありません。この機能では、次のアクティビティをデバッグし、コンテナー (フローチャート、シーケンスなど)、または [ワークフロー ファイルを呼び出し] アクティビティを開くことなく強調表示します。

この操作は、実行中に問題が発生する可能性がない大きなコンテナーの分析をスキップする際に便利です。

ステップ オーバーは、F10 キーボード ショートカットを使用して利用可能です。

ステップ アウト

名前が示すように、この操作は、現在のコンテナーのレベルで実行をステップ アウトおよび一時停止するために使用されます。ステップ アウトすると、デバッグを一時停止する前に、現在のコンテナーでアクティビティの実行を完了します。このオプションは、入れ子になったシーケンスで正常に機能します。

ステップ アウトは、 Shift + F11 キーボード ショートカットを使用して利用可能です。

リトライ

リトライは以前のアクティビティを再実行し、再び発生した場合は例外をスローします。例外をスローしたアクティビティが強調表示され、エラーの詳細は [ローカル] パネルと [コールスタック] パネルに表示されます。

無視

無視操作は、ワークフローの残りの部分をデバッグできるように、発生した例外を無視し、次のアクティビティから実行を継続するために使用することができます。

この操作は、例外をスローしたアクティビティを飛び越えて、プロジェクトの残りの部分のデバッグを継続するときに役立ちます。

再実行

再実行は、例外がスローされ、デバッグ プロセスが一時停止された後に使用できます。この操作は、プロジェクトの最初のアクティビティからデバッグ プロセスを再実行するために使用されます。デバッグのスピードを遅くし、適切にそれらが実行されているような活動を検査するには低速ステップを使用します。

[このアクティビティから実行] を使用した後にこのオプションを使用する場合、デバッグは以前に指示されたアクティビティから再実行されることに留意してください。

中断

中断では、特定の時点でデバッグ プロセスを一時停止できます。デバッグされているアクティビティは一時停止されると強調表示されたままになります。この状態になると、デバッグ プロセスの続行、ステップ イン、ステップ オーバー、または停止を選択できるようになります。

デバッグを正確な位置で一時停止するために、[中断] と [低速ステップ] を併用することをお勧めします。

[低速ステップ] を使用しない場合は、[出力] パネルを注意深く監視し、現在デバッグ中のアクティビティに到達したところで [中断] を使用します。

フォーカス

「実行ポイントにフォーカスします」では、現在のブレークポイントまたはデバッグ中にエラーが発生したアクティビティに戻ることができます。エラーが発生したアクティビティに戻り、デバッグ プロセスを再開するには、プロセス内を移動した後に [フォーカス] ボタンを使用するのが簡単な方法です。

または、ブレークポイントに達してデバッグが一時停止した場合、オートメーション プロセスに含まれるアクティビティ内を移動した後に [フォーカス] を用いると、該当するブレークポイントに戻ることができます。

3 番目のケースとしては、[ステップ イン] または [ステップ オーバー] を使用してから、プロセス内を移動した後に、デバッグが一時停止した場合が考えられます。このケースで [フォーカス] を使用すると、デバッグ プロセスを一時停止させたアクティビティに戻ります。

ブレークポイントコンテキスト メニューから、ブレークポイントでアクティビティを強調するためにフォーカスを選択することができます。

低速ステップ

[低速ステップ] では、デバッグ中にアクティビティを入念に調べることができます。この操作が有効化されていると、デバッグ プロセスでアクティビティが強調表示されます。さらに、コンテナー (フローチャート、シーケンスなど)、または [ワークフロー ファイルを呼び出し] アクティビティが開かれます。これは、[ステップ イン] を使用した場合と類似していますが、デバッグ プロセスを一時停止する必要がありません。

[低速ステップ] は、デバッグ プロセスの実行前でも実行中でもアクティブ化できます。この操作をアクティブ化しても、デバッグは一時停止されません。

低速ステップという名前が付けられていますが、4 段階の速度があります。選択した速度で、前よりも低速でデバッグ プロセスを実行します。たとえば、低速ステップを 1 倍でデバッグする場合が最も低速、4 倍が最も高速となります。言い換えると、この速度によって、デバッガーが 1 つのアクティビティから次のアクティビティにジャンプする速さが決まります。

この速度は、[低速ステップ] をクリックするたびに 1 段階ずつ変化します。速度の段階が更新されるとそれに従ってアイコンも変化するため、速度がわかります。

実行証跡

既定では、[実行証跡] リボン ボタンは無効化されています。有効化すると、デバッグ時の正確な実行パスが表示されます。プロセスを実行すると、デザイナー パネル上で各アクティビティが強調表示およびマークされるので、実行状況をリアルタイムで確認できます。

• 実行されたアクティビティは緑色でマークおよび強調表示されます。
• 実行されなかったアクティビティにはマークが一切付きません。

• 例外をスローしたアクティビティは赤色でマークおよび強調表示されます。

  
  

  

  
  

要素を強調表示する

これを有効化すると、デバッグ中に UI 要素が強調表示されます。このオプションは、通常のでデバッグでも、ステップごとのデバッグでも使用できます。

アクティビティをログ

これを有効化すると、デバッグされたアクティビティが [出力] パネルに [Trace] ログとして表示されます。[要素の強調表示]、[アクティビティをログ] オプションの切り替えは、デバッグの実行前にのみ行うことができます。また、選択したオプションは、オートメーション プロジェクトを再度開いた際にもそのまま残ります。これらのファイルがデザイナー パネルで開かれている場合を除き、これは呼び出しワークフローには適用されません。

Orchestrator に接続している場合は、ログが Orchestrator に自動的に送信されます。ただし、それらをローカルに保存するには、[ユーザーを追加] または [ユーザーを編集] ウィンドウの [ロボットの設定] タブで [開発ログを許可] オプションを無効化する必要があります

Orchestrator に小さめのログ ファイルを送信する場合には、[アクティビティをログ] を無効化する方法がよいでしょう。

注: Studio からプロセスを実行する場合、Orchestrator に送信されるログは常に、[アクティビティをログ] が無効のときには Trace となり、有効のときには Verbose となります。これは、ロボットと Orchestrator のいずれの設定よりも優先されます。

既定では、デバッガーによりアクティビティがログされ、[出力] パネルに各ステップが表示されます。追跡しやすくするために、このオプションは有効化しておくことをお勧めします (下図を参照)。

ここでの問題は、[User Input] シーケンスの入力フィールドが 1 つ以上空白になっていることです。これは、[フロー条件分岐] の True 条件です。このことは、デバッグ中に [User Input] シーケンスが 2 回実行されることからわかります。これは、1 回目の実行時に 1 つ以上のフィールドが空白になっていたからです。

デバッグで [アクティビティをログ] オプションを無効化した場合、[出力] パネルには [Trace] ログが表示されません。エラーなしで正常に実行された場合は、デバッグの実行開始時刻と終了時刻のみが取得されます。しかし、[メッセージをログ] を追加すると、問題が発生する箇所を特定するのに役立ちます。

たとえば、このケースでは 1 つ以上の入力フィールドが空の場合に通知するように、[メッセージをログ] アクティビティを追加します。[アクティビティをログ] オプションが無効化されている場合でも、このメッセージはデバッグ中に [出力] パネルに表示されます (下図を参照)。

[出力] パネルでは、必要なアラートの種類を選択することでメッセージをフィルターで絞り込むだけではなく、すべてのメッセージもクリアできます。

既定では、すべてのデバッグ ログは Orchestrator に送信されます。これを無効化するには、ロボットの [追加] または [編集] ウィンドウの [設定] タブから [開発ログを許可] オプションの選択を解除する必要があります。このオプションが無効化されていると、デバッグ ログはローカルにしか保存されません。

例外発生時に続行

既定では、このデバッグ機能は無効化されています。リボンで無効化されている場合、実行エラーのスロー、デバッグの中止、例外をスローしたアクティビティの強調表示、[出力] パネルでの例外のログが実行されます。プロジェクトにグローバル例外ハンドラーを設定済みである場合、例外がハンドラーに渡されます。

有効化すると例外のログが [出力] パネルに記録され、実行は継続されます。

ピクチャ イン ピクチャ

[デバッグ] タブの [ピクチャ イン ピクチャ] リボン オプションは、プロセスまたはライブラリの実行とデバッグの両方を、マシン上の別のセッションで行うために用意されたものです。

有効化すると、[実行]、[ファイルを実行]、[デバッグ]、[ファイルをデバッグ] のいずれを選択しても、プロセスが別のセッションまたはユーザー セッションの仮想デスクトップで開始します。[ピクチャ イン ピクチャ] を無効化すると、デバッグおよび実行は現在のセッションで行われます。

ピクチャ イン ピクチャ (PiP) 内でプロセスを実行するオプションは、有人オートメーションに非常に役立つ可能性があります。PiP 内でプロセスが正常に実行されるかどうかを確認してから、パブリッシュ後のプロセスをこの機能を使用して実行できるかどうかを示すよう、プロジェクトの設定を更新します。

1. [プロジェクト] パネルで、[設定] をクリックして [プロジェクト設定] ウィンドウを開きます。

2. [全般] タブで、以下の操作を実行します。

   • PiP のオプション - プロジェクトがピクチャ イン ピクチャを使用してテストされたかどうか、および既定で PiP で開始するかどうかを指定します。

     • PiP の使用をテスト済み、PiP で開始 - オートメーションの PiP モードでの実行が承認されています。実行時は、既定で PiP で開始されます。
     • PiP の使用をテスト済み、既定では PiP で開始しない - オートメーションの PiP モードでの実行が承認されています。実行時は、既定でメイン セッションまたはデスクトップで開始されます。
     • PiP の使用のテスト未実施 - オートメーションの PiP モードでの実行が承認されていません。実行時は、既定でメイン セッションまたはデスクトップで開始されます。PiP で実行すると、この機能を使用してテストされていないことを知らせるダイアログが表示され、次に進む前に確認を求められます。
   • PiP の種類 - プロジェクトを PiP で実行する場合にオートメーションをユーザー セッションから分離する方法を選択します。[新しいセッション] (マシン上の子セッション) または [新しいデスクトップ] (ユーザー セッションの仮想デスクトップ) のいずれかを選択します。

この機能の制限事項などの詳細については、『Robot ガイド』の「ピクチャ イン ピクチャ」をご覧ください。

リモート デバッグ

この機能を有効化すると、すべての実行とデバッグ操作は、ローカルにインストールされたロボットではなく指定したリモート ロボットで実行されるため、異なる環境でオートメーションをテストできます。詳しくは、「リモート デバッグ」をご覧ください。

実行をプロファイル

ファイルをデバッグする際に、ワークフローのパフォーマンスのボトルネックを特定することができます。詳細は、「実行をプロファイルする」をご覧ください。

ログを開く

[ログを開く] をクリックすると、ログのローカルな保存先である%localappdata%\UiPath\Logs フォルダーが開きます。ログ ファイルの名前の形式は YYYY-DD-MM_Component.log (2018-09-12_Execution.log や 2018-09-12_Studio.log など) です。ログについての詳細は、こちらをご覧ください。