UiPath Documentation
uipath-cli
latest
false
UiPath-CLI-Benutzerhandbuch
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UIP Maestro Flow-Debugging

Syntax und Optionen für „uip Maestro Flow Debugging“, der ein lokales Flow-Projekt in Studio Web hochlädt und eine serverseitige Debugging-Sitzung mit gestreamten Statusaktualisierungen ausführt.

uip maestro flow debug lädt ein lokales Flow-Projekt in Studio Web hoch und führt eine serverseitige Debugging-Sitzung durch, wobei Statusaktualisierungen pro Element zurück an die Konsole streamt und einen endgültigen Status zurückgibt.

Zusammenfassung​

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

Erfordert uip login. Beachten Sie globale Optionen. Austrittscodes folgen dem Standardvertrag.

Argumente​

  • <project-path> (erforderlich) – Der Pfad zum Flow-Projektverzeichnis. Muss project.uiproj enthalten.

Optionen​

OptionStandardBeschreibung
--folder-id <id>Automatisch erkennenOrchestrator-Ordner (OrganizationUnitId), ein positiver Integer. Sich gegenseitig mit --folder-key/--folder-path ausschließen. Wenn keiner der drei angegeben ist, wird der Ordner in der aktuellen Anmeldesitzung verwendet.
--folder-key <key>–Orchestrator-Ordnerschlüssel (UUID) – von der CLI in die Ordner-ID aufgelöst. Sich gegenseitig mit --folder-id/--folder-path ausschließen.
--folder-path <path>–Orchestrator-Ordnerpfad, z. B. Shared/Sub – wurde von der CLI in die Ordner-ID aufgelöst. Sich gegenseitig mit --folder-id/--folder-key ausschließen. Verwenden Sie uip or folders list, um gültige Schlüssel/Pfade zu erkennen.
--poll-interval <ms>2000Abrufintervall in Millisekunden, während darauf gewartet wird, dass Studio Web die Sitzung weiterleitet.
--timeout <seconds>Keine BeschränkungMaximale Sekunden, die bis zum Abschluss der Debugausführung gewartet werden soll. Wenn sie abläuft, schlägt der Befehl mit ErrorCode: timeout und Retry: RetryLater fehl und Data hat instanceId, jobKey, lastStatus und timeoutSeconds. Die Ausführung wird nicht angehalten. Dies hat keine Auswirkungen auf einen Konversationsfluss, der ohne Abruf übergeben wird.
-i, --inputs <json>–Geben Sie Argumente als JSON-Zeichenfolge oder @path/to/file.json zum Lesen aus einer Datei ein.
--entry-point <id>Standard-TriggerEinstiegspunktknoten-ID – eine Triggerknoten-ID aus der .flow -Datei. Standardmäßig wird der markierte Trigger verwendet isDefaultEntryPoint, andernfalls der erste Trigger. Eine ID, die mit keinem Trigger übereinstimmt, schlägt mit Exitcode 3 fehl.
--attachment <name=path>–Laden Sie eine lokale Datei in den Orchestrator hoch und binden Sie sie als Eingabevariable vom Typ Datei. Wiederholbar, z. B --attachment file1=./resume.pdf). Überschreibt denselben Variablennamen, wenn er auch in --inputs vorhanden ist.
--summary–Nur den Ausführungsstatus, die nicht abgeschlossenen Elemente und die deklarierten Ausgaben des Flows anstelle der unformatierten Ausgabe jedes Knotens zurückgeben. Siehe Zusammenfassungsausgabe.
--open-in-browser–Öffnen Sie die URL der Studio Web-Sitzung in einem Browser, sobald sie verfügbar ist.
--login-validity <minutes>10Mindestens Minuten vor dem Tokenablauf zum Auslösen einer automatischen Aktualisierung.

Verhalten​

  1. Validiert die Anmeldung und ruft die Organisation, den Mandanten, die Basis-URL, den Organisationsnamen und das Authentifizierungstoken aus der Sitzung ab.
  2. Refreshes the solution's resources. If the flow binds a resource that does not exist in Orchestrator, or a connection that does not exist in Resource Catalog, the command fails before anything is uploaded, lists the missing resources, and Instructions say how to bind them. A conversational flow is uploaded and handed off anyway. A Data Fabric node that names an entity of the solution with no Entity binding also fails the command before upload (exit code 3), with Instructions naming the node to configure.
  3. Lädt das Projekt in Studio Web unter dem Zielordner hoch.
  4. Abfragen nach einem endgültigen Status, wobei Statuszeilen pro Element ausgegeben werden wie:
    Status: InProgress (2/5 elements completed)
      v Node_1 [Completed]
      > Node_2 [InProgress]
      - Node_3 [NotStarted]
    Status: InProgress (2/5 elements completed)
      v Node_1 [Completed]
      > Node_2 [InProgress]
      - Node_3 [NotStarted]
    
    A status poll that fails with HTTP 403 or a 5xx error is retried twice before the command fails.
  5. Gibt bei Vorfällen während der Ausführung eine Warnzeile aus.
  6. 0 wird beendet, wenn finalStatus Completed oder Successful ist; 1 andernfalls.

Beispiele​

# 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

# Start from a specific trigger and stop waiting after 10 minutes
uip maestro flow debug ./invoice-flow --entry-point trigger_2 --timeout 600

# Read only the verdict and the declared outputs
uip maestro flow debug ./invoice-flow --summary
# 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

# Start from a specific trigger and stop waiting after 10 minutes
uip maestro flow debug ./invoice-flow --entry-point trigger_2 --timeout 600

# Read only the verdict and the declared outputs
uip maestro flow debug ./invoice-flow --summary

Datenform (--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": {}
  }
}
{
  "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": {}
  }
}

Öffnen Sie studioWebUrl in einem Browser, um die Sitzung interaktiv zu überprüfen.

Zusammenfassende Ausgabe​

Das vollständige Ergebnis enthält die Ausgabe jedes Knotens neben den deklarierten Ausgaben des Flows, einschließlich ganze HTTP-Antwortkörper und Header. Mit --summary enthält Data nur das, was Sie zur Beurteilung der Ausführung benötigen:

{
  "Code": "FlowDebug",
  "Data": {
    "finalStatus": "Completed",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "failed": [],
    "outputs": { "weatherVerdict": "warm office today" },
    "fullOutputPath": "/path/to/solution/.flow-debug/invoice-flow.json"
  }
}
{
  "Code": "FlowDebug",
  "Data": {
    "finalStatus": "Completed",
    "instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
    "solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
    "failed": [],
    "outputs": { "weatherVerdict": "warm office today" },
    "fullOutputPath": "/path/to/solution/.flow-debug/invoice-flow.json"
  }
}
FeldBeschreibung
failedElementausführungen, die nicht abgeschlossen wurden, als { elementId, status }. Leer für eine saubere Ausführung.
outputsDie deklarierten Ausgabevariablen des Flows (out und inout) nach ID. Abwesend, wenn die Variablen nicht gelesen werden konnten. variablesError gibt dann den Grund an und die Ausgaben sind unbekannt und nicht leer.
missingOutputsDeklarierte Ausgaben, die der Datensatz der Ausführung nicht durchgeführt hat.
incidentsVorfälle, die während der Ausführung ausgelöst wurden, wenn welche vorhanden sind.
fullOutputPathWo das vollständige Ergebnis geschrieben wurde.
fullOutputErrorWarum das vollständige Ergebnis nicht geschrieben werden konnte. Die Zusammenfassung steht weiterhin.

Das vollständige Ergebnis – was der Befehl ohne --summary ausgibt – wird in <solution>/.flow-debug/<project>.json geschrieben, wobei <solution> der Ordner ist, der die .uipx -Datei enthält, und <project> der Projektpfad relativ dazu ist. Die Datei wird bei jeder Ausführung ersetzt.

Die Datei enthält Mandantendaten, sodass die CLI auch .flow-debug/.gitignore mit * schreibt und uip solution pack sowie uip solution upload den Ordner überspringen.

Übergabe des Konversations-Triggers​

Ein Flow, dessen Einstiegspunkt core.trigger.conversation ist, kann nur von einer Chat-UI gesteuert werden – die CLI kann keine Debugging-Sitzung dafür starten. Stattdessen wird das Projekt in Studio Web hochgeladen und übergeben:

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

Es sind keine elementExecutions/finalStatus -Felder vorhanden – es wurde nichts ausgeführt, also gibt es nichts abzurufen. Übergeben Sie --open-in-browser, damit die CLI studioWebUrl automatisch öffnet.

Fehlerhafte Ausführung – Inline-Vorfälle​

Eine fehlerhafte Ausführung wird als Result: "Failure" -Umschlag (Exitcode 1) zurückgegeben, wobei die Details zum Vorfall bereits inline auf Data.incidents enthalten sind – es ist kein Folgebefehl erforderlich, um zu sehen, was funktioniert hat:

{
  "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."
      }
    ]
  }
}
{
  "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."
      }
    ]
  }
}

On a faulted run, the error Instructions point you at uip maestro flow debug-instances incidents <instanceId> to inspect the raw backend payload. Refer to debug-instances for that lower-level control surface.

Siehe auch​

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support(opens in new window)

Möchten Sie lernen? UiPath Academy(opens in new window)

Haben Sie Fragen? UiPath-Forum(opens in new window)

Auf dem neuesten Stand bleiben