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>]
               [-i, --inputs <json>]
               [--attachment <name=path>]...
               [--open-in-browser]
               [--login-validity <minutes>]
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>]

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.
-i, --inputs <json>Geben Sie Argumente als JSON-Zeichenfolge oder @path/to/file.json zum Lesen aus einer Datei ein.
--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.
--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. Lädt das Projekt in Studio Web unter dem Zielordner hoch.
  3. 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]
    
  4. Gibt bei Vorfällen während der Ausführung eine Warnzeile aus.
  5. 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
# 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

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.

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

Bei einer fehlerhaften Ausführung verweist der Fehler Instructions auf uip maestro flow debug-instance incidents <instanceId> , um die unformatierte Backend-Nutzlast zu überprüfen – siehe debug-instance für diese Steuerelementoberfläche auf niedriger Ebene.

Siehe auch

War diese Seite hilfreich?

Verbinden

Benötigen Sie Hilfe? Support

Möchten Sie lernen? UiPath Academy

Haben Sie Fragen? UiPath-Forum

Auf dem neuesten Stand bleiben