UIP RPA の実行、デバッグ、実行

「uip rpa run」、「debug」グループ、および「execution cancel」の構文とオプション — ワークフローまたはコード化されたファイルを実行およびデバッグするための現在のプライマリサーフェスであり、以前の「run-file」/「stop-execution」動詞を置き換えます。

uip rpa run、 uip rpa debug *、および uip rpa execution cancel Studio でワークフローまたはコード化されたファイルを実行およびデバッグします。このページの 17 個の動詞はすべて、1 つのワイド --command 列挙型として公開uip rpa run-fileおよびuip rpa stop-execution同じ 2 つの基になるツールにディスパッチします — これは、同じ機能の現在の主要な検出可能な形式であり、19 個の値を持つ 1 つのフラグではなく、動作ごとに 1 つの動詞に分割されています。run-file/stop-execution は引き続き機能しますが (インストールされているスキルの非表示の互換性エイリアスとして保持されます)、このページ --help 実際に表示しています。

実行は Studio を介して行われるため、これらのコマンドは Windows ランナーでのみ動作します (Studio は Windows 専用です)。Studio がまだ実行されていない場合は、自動的に起動します。専用のセットアップ手順で初期費用を支払う必要がある場合は、最初に uip rpa start-studio を実行します。

概要

uip rpa run --file-path <path> [--input-arguments <json>] [--log-level <level>] [--skip-build] [--profiling] [--profiling-mode endOfRun|stream] [--remote]

uip rpa debug start --file-path <path> [same options as run] [--breakpoints <json>]
uip rpa debug start-from-here [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug test-activity [--input-arguments <json>] [--input-variables <json>] [--log-level <level>] [--profiling] [--profiling-mode <mode>]
uip rpa debug break [--wait-timeout-seconds <n>]
uip rpa debug continue [--wait-timeout-seconds <n>]
uip rpa debug resume [--wait-timeout-seconds <n>]
uip rpa debug continue-retry [--wait-timeout-seconds <n>]
uip rpa debug continue-ignore [--wait-timeout-seconds <n>]
uip rpa debug step-into [--wait-timeout-seconds <n>]
uip rpa debug step-over [--wait-timeout-seconds <n>]
uip rpa debug step-out [--wait-timeout-seconds <n>]
uip rpa debug state [--wait-timeout-seconds <n>]
uip rpa debug set-breakpoints --breakpoints <json>
uip rpa debug apply-file-changes --file-changes <json>
uip rpa debug toggle-breakpoint
uip rpa debug restart-from-top

uip rpa execution cancel

概念

• 2 つのバックエンドのうちの 1 つ。デスクトップ版の Studio とヘッドレス Helm バックエンドはどちらもこれらを実装します。いくつかのオプション (--profiling-mode stream、 debug set-breakpoints、 debug apply-file-changes、ロングポーリング --wait-timeout-seconds) は Helm 専用であり、Studio のバックエンドでは無視されるか、利用できません (以下の動詞ごとに記載)。
• --remote (run/debug start/debug start-from-here/debug test-activity のみ) は、ローカルではなく、設定したリモート エージェント (Orchestrator の Unattended ロボット) で実行されます。最初にターゲットを設定する方法については、uip rpa remoteをご覧ください。
• セッション中間のコマンドはすべて、次の安定したステートで返されます。continue/resume/continue-retry/continue-ignore/ステップ動詞/break/state セッションが安定した状態 (Paused、 Suspended、または Completed) に達するまで待ってから戻ります。 --wait-timeout-seconds 内に何も到達しない場合は、ハングせずに DebugState: "Running" を返します。

UIP RPA の実行

デバッガーを接続せずに Studio でワークフローまたはコード化されたファイルを実行する。

オプション

長押し	値 (Value)	説明
--file-path <path>	string	必須。.xaml ワークフローまたはコード化されたファイルへのパス.cs。
--input-arguments <json>	JSON オブジェクト	プレーンな JSON としてのプロジェクト レベルの入力引数 (例:{"customerId":"ACME-1234"}です。
--log-level <level>	Verbose|Trace|Information|Warning|Error|Critical	出力ストリームの最小ログ レベル。既定 Traceです。
--skip-build	フラグ	検証/ビルドをスキップします (プロジェクトがすでに構築されていると仮定)。何も変更されていないときに素早く再実行する場合に使用します。
--profiling	フラグ	Profilingフィールドとして返される、アクティビティごとのプロファイル データを収集します。EnableProfiling設定された Studio Develop プロファイルが必要です。利用できない場合、実行は完了し、Profiling単に省略されます。既定 falseです。
--profiling-mode <mode>	endOfRun|stream	データのプロファイルの配信タイミング。endOfRun (既定) は、完了時に 1 回だけ要約を返します。また、 stream 単独で収集をオンにして、さらにアクティビティごとの各エントリを [Profiling] 行としてライブ転送し、さらに実行の .uistat ファイルに網羅的なデータを書き込みます。Helm バックエンドのみ。リモートの実行時は無視されます。
--remote	フラグ	ローカルではなく、設定したリモート エージェントで実行します。最初に を使用してターゲットを設定しますuip rpa remote configure既定 falseです。

例

uip rpa run --file-path ./Main.xaml --input-arguments '{"customerId": "ACME-1234"}'

データシェイプ(--output json)

{ "Code": "RunResult", "Data": { "DebugState": "Completed", "Result": {} } }

正確な Data 形状は、基になるツールの実行結果のペイロードです。完全な結果コントラクトについては uip rpa run-file を参照してください (両方の動詞は同じ形状を返します)。

UIP RPA デバッグ開始

ワークフローまたはコード化されたファイルのデバッグ セッションを開始します。runと同じオプションに加えて --breakpointsです。

オプション

runのすべてのオプションに加えて:

長押し	値 (Value)	説明
--breakpoints <json>	JSON 配列	最初のブレークポイントが設定されました。各エントリ: workflowFile (必須、プロジェクトのルートを基準としたパス)、 activityIdRef (XAML からのアクティビティの sap2010:WorkflowViewState.IdRef — 安定したアドレス指定方法)、または activityId (ランタイム ID)、および任意の condition (VB/C# 式、true の場合にのみ中断)、 hitCount (N 回目のヒット時にのみ中断)、 enabled (既定の true)。繰り返し可能なコンマ区切りの key=value 項目、出現ごとに 1 つの配列エントリ、または @breakpoints.json / --breakpoints-fileによる JSON ファイル。

例

uip rpa debug start --file-path ./Main.xaml \
  --breakpoints 'workflowFile=Main.xaml,activityIdRef=Assign_1'

データシェイプ(--output json)

runと同じ形状。ブレークポイントに到達したセッションは、DebugDetails内のアクティビティとローカルとのDebugState: "Paused"を報告します。

UIP RPA デバッグ start-from-here

現在フォーカスしているアクティビティからデバッグを開始し、それ以前のすべてをスキップします。--file-pathはありません — オープン プロジェクトで焦点を当てているものすべてに基づいて動作します。

オプション

長押し	値 (Value)	説明
--input-arguments <json>	JSON	プロジェクト レベルの入力run/debug startとは異なり、ここでの値はプレーンな JSON リテラルではなく、VB.NET または C# の式です。
--input-variables <json>	JSON	スコープ内ステート (リテラルではなく式) をシードするためのワークフロー レベルの変数値。
--log-level <level>	と同じ列挙型 run	最小ログ レベル。
--profiling / --profiling-mode <mode>	—	runと同じです。

例

uip rpa debug start-from-here --input-variables '{"greeting": "\"Hello World\""}'

UIP RPA デバッグ test-activity

現在フォーカスされているアクティビティを分離して実行します。 --input-arguments/--input-variables (式、 start-from-hereと同じ規則) を使用してスコープ内のステートをシードします。

オプション

debug start-from-hereと同じです。

例

uip rpa debug test-activity --input-variables '{"greeting": "\"Hello World\""}'

UIP RPA のデバッグ ブレーク

アクティブなセッションで次に実行されたアクティビティで実行を一時停止します。

オプション

長押し	値 (Value)	説明
--wait-timeout-seconds <n>	Number	を返す前に次の安定ステートまで待機する最大秒です DebugState: "Running"。既定 120です。Helm バックエンドのみ — Studio バックエンドは、独自の固定された 120 秒のバインドを適用し、明示的な値は無視します。

UIP RPA デバッグの続行/再開/続行-リトライ/続行-無視

アクティブなセッションで実行を再開します。continue は一時停止状態から再開します。 resume は中断状態から再開します。 continue-retry は、スローしたアクティビティを再開してリトライします。 continue-ignore 再開し、スローしたアクティビティの例外を飲み込みます。

オプション

debug breakと同じ--wait-timeout-secondsです。

UIP RPA デバッグ ステップイン/ステップオーバー/ステップアウト

アクティブなセッションでの標準のデバッガー ステップ。step-outは、アクティブなセッションなしで呼び出され、最初のアクティビティの前に一時停止して開始します。

オプション

debug breakと同じ--wait-timeout-secondsです。

UIP RPA のデバッグ ステート

アクティブなデバッグ セッションの状態 (Running/Paused/Suspended/Completed/None) を、副作用なしに報告します。

オプション

長押し	値 (Value)	説明
--wait-timeout-seconds <n>	Number	実行中のセッションをロングポーリングして、次の安定したステートを求めます。既定の 0 です (インスタント プローブ)。Helm バックエンドのみ — Studio のバックエンドでは、これは常にインスタント プローブです。

UIP RPA デバッグ set-breakpoints

アクティブなデバッグ セッションのブレークポイント セット全体を置き換えます。Helm バックエンドのみ — Studio のバックエンドでは、代わりに debug toggle-breakpointを使用するか、 debug start にブレークポイントを渡します。

オプション

長押し	値 (Value)	Required	説明
--breakpoints <json>	JSON 配列	○	debug startの--breakpointsと同じ形。結合ではなく、セット全体を置換します。

uip rpa デバッグ apply-file-changes

デバッグ セッションで一時停止/中断されているときに、ホット リロードによってディスク上のアクティビティ プロパティの編集内容を実行中のセッションに調整し、再起動せずに編集内容を取得するようにします。最初にワークフロー ファイルを編集してから、変更された名前を付けてこれを呼び出します。

オプション

長押し	値 (Value)	Required	説明
--file-changes <json>	JSON 配列	○	編集するプロパティごとに 1 つのオブジェクト: workflowFile (必須)、 activityIdRefと、変更されたプロパティ名/値。フォームまたは@changes.json/--file-changes-fileの繰り返し可能なkey=value。

データシェイプ(--output json)

{ "Code": "ApplyFileChanges", "Data": { "applied": [], "rejected": [], "debugState": "Paused" } }

applied 編集内容がセッション内でライブで行われます (例:continue-retry は、エラーが発生したアクティビティを修正して再実行します)。 rejected 編集 (それぞれに理由があります) は構造的な変更であり、有効にするにはセッションを再起動する必要があります。

UIP RPA デバッグ トグル - ブレークポイント

現在フォーカスされているアクティビティ (.xaml) または行 (.cs) でブレークポイントを切り替えます。オプションはありません。XAML サイクルが有効化されている→無効になっている→無効になっているコード化されたワークフローのオン/オフを切り替えます。

UIP RPA デバッグ restart-from-top

アクティブなデバッグ セッションを最初からやり直します。オプションはありません。

UIP RPA の実行のキャンセル

現在アクティブな実行またはデバッグ セッションをキャンセルします — run と debug startの両方で一律に機能します。オプションはありません。

例

uip rpa execution cancel

関連

• uip rpa run-file / uip rpa stop-execution — これらの動詞が置き換えた隠れたレガシーエイリアス。基になるツールは同じです。
• uip rpa start-studio — 専用のセットアップ手順で Studio の起動費用を支払います。
• uip rpa remote — --remoteのターゲットを設定します。
• uip rpa get-errors — 実行後に診断を検査します。

参照

• RPA ツールの概要
• グローバル オプション
• 終了コード