UIP Maestro フローのデバッグ

「uip maestro flow debug」の構文とオプション。ローカルのフロー プロジェクトを Studio Web にアップロードし、サーバー側のデバッグ セッションを実行してステータスの更新をストリーミングします。

uip maestro flow debug は、ローカルの Flow プロジェクトを Studio Web にアップロードし、サーバー側のデバッグ セッションを実行して、要素ごとのステータスの更新をコンソールにストリーミングし、最終ステータスを返します。

概要

uip maestro flow debug <project-path>
               [--folder-id <id> | --folder-key <key> | --folder-path <path>]
               [--poll-interval <ms>]
               [-i, --inputs <json>]
               [--attachment <name=path>]...
               [--open-in-browser]
               [--login-validity <minutes>]

uip loginが必要です。グローバルオプションを優先します。終了コードは 標準コントラクトに従います。

引数

• <project-path> (必須) — Flow プロジェクトディレクトリへのパス。次の文字列を含む必要があります project.uiproj。

オプション

オプション	既定 (Default)	説明
--folder-id <id>	自動検出	Orchestrator フォルダー (OrganizationUnitId)、正の整数です。--folder-key/--folder-pathと相互に排他的です。この 3 つの値のいずれも指定しない場合、現在のログイン セッションのフォルダーが使用されます。
--folder-key <key>	—	Orchestrator フォルダー キー (UUID) — CLI によってフォルダー ID に解決されます。--folder-id/--folder-pathと相互に排他的です。
--folder-path <path>	—	Orchestrator フォルダー パス (例:Shared/Sub — CLI によってフォルダー ID に解決されます。--folder-id/--folder-keyと相互に排他的です。uip or folders list を使用して有効なキー/パスを検出します。
--poll-interval <ms>	2000	Studio Web がセッションを前進させるのを待機する間のポーリング間隔 (ミリ秒単位)。
-i, --inputs <json>	—	入力引数は JSON 文字列、またはファイルから読み取る @path/to/file.json です。
--attachment <name=path>	—	ローカル ファイルを Orchestrator にアップロードし、ファイル型の入力変数としてバインドします。繰り返し可能 (例:--attachment file1=./resume.pdfです。同じ変数名が にも存在する場合は、上書き --inputsです。
--open-in-browser	—	用意されたら、ブラウザーで Studio Web セッションの URL を開きます。
--login-validity <minutes>	10	トークンの有効期限の最小時間 (分) 前に自動更新がトリガーされます。

動作

1. ログインを検証し、組織、テナント、ベース URL、組織名、認証トークンをセッションから取得します。
2. プロジェクトを Studio Web のターゲット フォルダーにアップロードします。
3. 最終ステータスをポーリングし、次のような要素ごとのステータス行を出力します。

   Status: InProgress (2/5 elements completed)
     v Node_1 [Completed]
     > Node_2 [InProgress]
     - Node_3 [NotStarted]
   

4. 実行中のインシデントに対して、警告ラインを発します。
5. finalStatus が Completed または Successfulの場合に 0 を終了します。1そうでなければ。

例

# Debug a local project, auto-detect folder, default poll interval
uip maestro flow debug ./invoice-flow

# Debug against a specific folder with inline JSON inputs
uip maestro flow debug ./invoice-flow --folder-id 2553016 \
  --inputs '{"amount":100,"customer":"Acme"}'

# Debug with inputs from a file
uip maestro flow debug ./invoice-flow --inputs @inputs.json

# Slower polling for long-running flows
uip maestro flow debug ./invoice-flow --poll-interval 5000

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

{
  "Code": "FlowDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Completed",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "elementExecutions": [
      { "elementId": "Node_1", "status": "Completed" }
    ],
    "variables": {}
  }
}

ブラウザーで studioWebUrl を開き、対話形式でセッションを検査します。

会話トリガーによるハンドオフ

エントリ ポイントが core.trigger.conversation のフローは、チャット UI によってのみ駆動できます。CLI はそのフローのデバッグ セッションを開始できません。代わりに、プロジェクトを Studio Web にアップロードしてハンドオフします。

{
  "Code": "FlowDebugStudioWebHandoff",
  "Data": {
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/studio_/designer/a1b2c3d4?solutionId=e5f6a7b8",
    "handedOff": true
  }
}

elementExecutions/finalStatus フィールドが存在しません。何も実行されていないため、ポーリングするものはありません。CLI が自動的に開かれるように--open-in-browserstudioWebUrl渡します。

実行が失敗しました — インラインのインシデント

失敗した実行は、 Result: "Failure" エンベロープ (終了コード 1) として返され、インシデントの詳細はすでに Data.incidents にインラインで表示されています。何が発生したかを確認するためにフォローアップ コマンドは必要ありません。

{
  "Code": "FlowDebug",
  "Data": {
    "jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "runId": "d4e5f6a7-0000-0000-0000-000000000001",
    "finalStatus": "Faulted",
    "incidents": [
      {
        "incidentId": "inc-1",
        "elementId": "Node_3",
        "errorCode": "Process.UnhandledException",
        "errorMessage": "Object reference not set to an instance of an object."
      }
    ]
  }
}

実行が失敗した場合、エラーが表示される Instructions 、バックエンドの未加工のペイロードを検査する uip maestro flow debug-instance incidents <instanceId> を示します (下位レベルのコントロール サーフェスについては debug-instance をご覧ください)。

参照

• uip maestro flow debug-instance — カスタム ツールを構築するための、デバッグ セッションのステップバイステップの制御
• uip maestro flow validate — 実行前の静的チェック
• uip maestro flow process run — パブリッシュ済みのプロセスを実行します
• uip maestro flow job traces — 開始済みのジョブのストリームトレース
• 認証
• フローの概要