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-Prozess und UIP Maestro Flow-Prozesse

Syntax und Optionen für „uip Maestro Flow Process“ und „uip Maestro Flow Processes“, die veröffentlichte Flow-Prozessvorgänge pro Ordner und mandantenweit abdecken.

Sobald ein Flow-Paket im Orchestrator veröffentlicht wurde, wird es zu einem Prozess. Diese Seite behandelt zwei verwandte Befehlsgruppen:

  • uip maestro flow process – Vorgänge pro Ordner für eine einzelne Prozessdefinition (Liste in einem Ordner, Schema abrufen, ausführen).
  • uip maestro flow processes (Plugin) – mandantenweite Zusammenfassungen und Vorfallssuche pro Prozess.

Zusammenfassung​

# Singular — per-folder, operational
uip maestro flow process list (-f <folder-key> | --folder-path <path>) [--filter <odata>] [--limit <n>] [--offset <n>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--entry-point <id>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list [--folder-key <key>] [-l, --limit <number>] [--offset <number>] [--status <status>]
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>
# Singular — per-folder, operational
uip maestro flow process list (-f <folder-key> | --folder-path <path>) [--filter <odata>] [--limit <n>] [--offset <n>] [--login-validity <minutes>]
uip maestro flow process get  <process-key> <feed-id> -f <folder-key> [--login-validity <minutes>]
uip maestro flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--entry-point <id>]
                       [--attachment <name=path>]...
                       [--wait [--timeout <seconds>] [--poll-interval <seconds>]]
                       [--validate] [--login-validity <minutes>]
uip maestro flow process settings get       <process-key> -f <folder-key>
uip maestro flow process settings set       <process-key> -f <folder-key> [--inputs <json|@file>]
uip maestro flow process variable-tags get  <process-key> -f <folder-key>
uip maestro flow process variable-tags set  <process-key> -f <folder-key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <bool>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

# Plural — tenant-wide summary and incident surface
uip maestro flow processes list [--folder-key <key>] [-l, --limit <number>] [--offset <number>] [--status <status>]
uip maestro flow processes incidents    <process-key> --folder-key <key>
uip maestro flow processes diagnose     <process-key> --folder-key <key>
uip maestro flow processes error-codes  <process-key> --folder-key <key>

Alle Unterbefehle erfordern uip login und berücksichtigen globale Optionen. Austrittscodes folgen dem Standardvertrag.


UIP Maestro Flow-Prozessliste​

Listen Sie verfügbare Flow-Prozesse (Releases) in einem bestimmten Ordner auf.

Optionen​

OptionErforderlichBeschreibung
-f, --folder-key <key>eines von --folder-key oder --folder-pathOrdnerschlüssel (GUID).
--folder-path <path>eines von --folder-key oder --folder-pathOrdnerpfad, z. B. Shared/Invoices. Wenn Sie beide Optionen übergeben, müssen sie auf denselben Ordner verweisen.
--filter <odata>neinZusätzlicher OData-Filter serverseitig angewendet.
-l, --limit <number>neinNumber of processes to return, 1–1000.
--offset <number>neinAnzahl der zu überspringenden Prozesse, 0–1000.000. Standard: 0.
--login-validity <minutes>neinSchwellenwert für die Tokenaktualisierung (Standard: 10).

Der Orchestrator wendet --limit und --offset an, sodass das Pagination -Objekt in der Antwort kein Total hat. Es enthält:

  • Returned
  • Limit
  • Offset
  • HasMore

Wenn weder --folder-key noch --folder-path übergeben werden, schlägt das mit Exitcode 3 fehl.

Datenform (--output json)​

{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "releaseActive": "Yes",
      "releaseLatest": "Yes"
    }
  ]
}
{
  "Code": "FlowProjectList",
  "Data": [
    {
      "name":       "InvoiceFlow",
      "processKey": "a1b2c3d4-0000-0000-0000-000000000001:1.0.0",
      "releaseKey": "e5f6a7b8-0000-0000-0000-000000000001",
      "folderKey":  "c3d4e5f6-0000-0000-0000-000000000001",
      "feedId":     "default",
      "folderId":   42,
      "releaseActive": "Yes",
      "releaseLatest": "Yes"
    }
  ]
}

releaseActive und releaseLatest spiegeln den Release-Status des Orchestrators wider: ob der Release als aktiv markiert ist und ob es sich um die höchste Version handelt. Sie geben nicht an, ob der Prozess bereitgestellt oder ausführbar ist.


Abrufen des UIP Maestro Flow-Prozesses​

Rufen Sie das Einstiegspunktschema (JSON-Schemas für Eingabe/Ausgabe) für einen Flow-Prozess ab. Verwenden Sie das Ergebnis, um eine gültige --inputs -Nutzlast für process run zu erstellen.

Argumente​

  • <process-key> (erforderlich) – Prozessschlüssel, z. B MyFlow.flow.Flow:1.0.0 oder <package-id>:<version>.
  • <feed-id> (erforderlich) – Feed-ID (aus der list -Ausgabe).

Optionen​

  • -f, --folder-key <key> (erforderlich)
  • --login-validity

Datenform​

{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "FlowProjectGet",
  "Data": [
    {
      "Path":         "/content/main.flow",
      "DisplayName":  "Main",
      "Type":         "Flow",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema und OutputSchema sind JSON-Objekte mit erneuter Zeichenfolge; Analysieren Sie sie als JSON-Schema, um die Eingabeentwicklung zu steuern.


Ausführung des UIP Maestro Flow-Prozesses​

Starten Sie einen Flow-Auftrag für einen veröffentlichten Prozess.

Argumente​

  • <process-key> (erforderlich) – Prozessschlüssel (z. B MyFlow.flow.Flow:1.0.0).
  • <folder-key> (erforderlich) – Ordnerschlüssel (GUID).

Optionen​

OptionBeschreibung
-i, --inputs <json>Eingaben als JSON-Zeichenfolge oder @path/to/file.json. Wenn sie weggelassen wird und die Standardeinstellungen über einen Pipe-Parameter extrahiert werden, wird der Standardwert als Eingabe geparst.
--release-key <key>Versionsschlüssel (GUID) – von process list. Wenn diese Option nicht ausgeführt wird, sucht der Befehl nach dem Release, das im Ordner mit <process-key> (Name und Version) übereinstimmt. Wenn kein Release oder mehrere Releases übereinstimmen, schlägt der Befehl mit Code: "FlowReleaseKeyRequired" fehl; Übergeben Sie die übereinstimmende releaseKey von process list.
--feed-id <id>Feed-ID für die Paketsuche (optional).
--robot-ids <ids>Durch Kommas getrennte Roboter-IDs (Integer). Ungültige Werte schlagen schnell fehl.
--entry-point <id>Einstiegspunkt zum Starten des Auftrags, unter: eine Triggerknoten-ID aus der .flow -Datei. Standardmäßig der standardmäßige Einstiegspunkt des Release. Eine ID, die mit keinem Einstiegspunkt des Prozesses übereinstimmt, schlägt mit dem Exitcode 3 fehl, bevor ein Anhang hochgeladen wird. Mit --validate werden die Eingaben anhand des Schemas dieses Einstiegspunkts geprüft.
--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.
--waitBlockieren Sie, bis der Auftrag einen Endstatus erreicht, anstatt sofort mit Pending zurückzukehren.
--timeout <seconds>Maximale Wartezeit in Sekunden. 0 = keine Zeitüberschreitung. Standard: 1800. Erfordert --wait.
--poll-interval <seconds>Sekunden zwischen Statusprüfungen während der Wartezeit. Standard: 5. Erfordert --wait.
--validateValidieren Sie Eingaben anhand des Prozessschemas, bevor Sie sie ausführen. Führt nur grundlegende Prüfungen durch – Pflichtfelder sind vorhanden und primitive Typen stimmen überein. Komplexe Einschränkungen (Aufzählungen, Muster, Verweise) werden durch diese Übergabe nicht erzwungen.
--login-validity <minutes>Schwellenwert für die Tokenaktualisierung (Standard: 10).

Eingabepriorität: --inputs <json> / --inputs @file.json > ständig > leeres Objekt {}.

Beispiele​

# Run with inline JSON (the release key is looked up)
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --inputs '{"amount":100}'

# Run a specific release
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Bind a local file to a file-typed input variable
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --attachment file1=./resume.pdf

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate
# Run with inline JSON (the release key is looked up)
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --inputs '{"amount":100}'

# Run a specific release
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

# Bind a local file to a file-typed input variable
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --attachment file1=./resume.pdf

# Run with inputs from a file
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" --inputs @inputs.json

# Run with inputs piped from stdin
echo '{"amount":100}' | uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…"

# Validate before running
uip maestro flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-…" \
  --inputs '{"amount":100}' --validate

Datenform​

{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "folderKey": "c3d4e5f6-0000-0000-0000-000000000001"
  }
}
{
  "Code": "FlowJobStarted",
  "Data": {
    "jobKey":  "b2c3d4e5-0000-0000-0000-000000000001",
    "state":   "Pending",
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "folderKey": "c3d4e5f6-0000-0000-0000-000000000001"
  }
}

Nächster Schritt: uip maestro flow jobs traces <jobKey> --folder-key <folder-key> für die Stream-Ausführung oder uip maestro flow jobs status <jobKey> für die Abfrage. Mit --wait ruft der Befehl nach dieser Ausgabe weiter ab, bis der Auftrag einen Endstatus erreicht.


UIP Maestro Flow-Prozesseinstellungen​

Rufen Sie die Runtime-Einstellungen eines Prozesses ab oder aktualisieren Sie sie.

Abrufen der UIP Maestro Flow-Prozesseinstellungen​

Argumente​
  • <process-key> (erforderlich) – Prozessdefinitionsschlüssel.
Optionen​
  • -f, --folder-key <key> (erforderlich)
Datenform​

Code: "ProcessSettingsGet", Data ist das Prozesseinstellungsobjekt.

UIP Maestro Flow-Prozesseinstellungen festgelegt​

Argumente​
  • <process-key> (erforderlich)
Optionen​
OptionBeschreibung
-f, --folder-key <key>(erforderlich) Ordnerschlüssel (GUID).
--inputs <value>Einstellungsnutzlast als JSON-Zeichenfolge, ein @file -Pfad oder über Standardpipeline.
Datenform​

Code: "ProcessSettingsSet".

UIP Maestro Flow Process-Variable-Tags​

Abrufen oder Aktualisieren von Durchsuchbarkeits-Tags für die Ausgabevariablen eines Prozesses – diese Variablen können zum Filtern von Instanzen verwendet werden.

Abrufen von Variablen-Tags für UIP Maestro Flow​

Argumente​
  • <process-key> (erforderlich)
Optionen​
  • -f, --folder-key <key> (erforderlich)
Datenform​

Code: "ProcessVariableTagsGet", Data ist die variableTags -Zuordnung des Prozesses ({} wenn keine festgelegt ist).

UIP Maestro Flow Process Variable-Tags festgelegt​

Zwei sich gegenseitig ausschließende Eingabestile: Übergeben Sie --inputs mit einer vollständigen JSON-Payload, oder verwenden Sie die benutzerfreundlichen Flags --variable/--all/--searchable/--tags/--add-tags/--remove-tags – die Kombination beider Optionen schlägt mit einem Upgrade fehl Dieser Fehler

Argumente​
  • <process-key> (erforderlich)
Optionen​
OptionBeschreibung
-f, --folder-key <key>(erforderlich) Ordnerschlüssel (GUID).
--variable <name>Name einer Variablen (Ausgabe), die markiert werden soll. Wiederholbar, um mehrere in einem Aufruf mit Tags zu versehen.
--element-id <id>Element, das die Variable besitzt – ist mehrdeutig, wenn derselbe Name für mehrere Elemente erscheint. Nur mit einem einzelnen --variable gültig.
--allWenden Sie die Änderung auf jede tagbare Variable an.
--searchable <bool>Markieren Sie die Variable(n), die für die Instanzfilterung durchsuchbar ist (true/false).
--tags <csv>Erweitert: Ersetzen Sie die aktuellen Tags der Variablen direkt. Leerer Wert löscht sie.
--add-tags <csv>Fügen Sie Tags zu den aktuellen Tags der Variablen hinzu.
--remove-tags <csv>Entfernen Sie Tags aus den aktuellen Tags der Variablen.
--inputs <value>Vollständige Variablen-Tags-Nutzlast als JSON-Zeichenfolge, ein @file -Pfad oder über STTIN – eine Alternative zu den oben genannten Flags.
Datenform​

Code: "ProcessVariableTagsSet". Bei --inputs sind Data die aktualisierten Prozesseinstellungen. Mit den Flags ist Data { updated, variableTags }.


UIP Maestro Flow-Prozesse​

Mandantenweite Zusammenfassung der Flow-Prozesse.

Optionen​

OptionBeschreibung
--folder-key <key>Ordnerschlüssel, um die Zusammenfassung auf einen Ordner zu beschränken.
-l, --limit <number>Anzahl der zurückzugebenden Elemente (1–10000).
--offset <number>Anzahl der zu überspringenden Elemente (0–1000000). Standard: 0.
--status <status>Nach Prozessstatus filtern.

Datenform​

{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
{
  "Code": "ProcessList",
  "Data": [
    {
      "processKey":     "…",
      "name":           "…",
      "folderKey":      "…",
      "latestVersion":  "…"
    }
  ]
}
Hinweis:

Der genaue Feldsatz einer jeden Prozesszusammenfassung wird von der Maestro-Runtime festgelegt und kann sich weiterentwickeln; Führen Sie den Befehl einmal mit --output json für einen Mandanten mit Daten aus, um die Felder anzuzeigen, die Sie verbrauchen, und heften Sie @uipath/cli in CI an, wenn Sie bestimmte Felder parsen.


Vorfälle bei UIP Maestro Flow-Prozessen​

Rufen Sie alle Vorfälle für eine bestimmte Flow-Prozessdefinition ab (keine einzelne Instanz).

Argumente​

  • <process-key> (erforderlich) – Prozessdefinitionsschlüssel.

Optionen​

  • --folder-key <key> (erforderlich) – Ordnerschlüssel, um die Suche durchzuführen.

Datenform​

{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

Refer to uip maestro flow incidents for the per-incident shape.

Diagnose von UIP Maestro Flow-Prozessen​

Korrelieren Sie die Zusammenfassung, Vorfälle und Fehlercodes eines Prozesses in einem Aufruf – ein Schnelltriage-Befehl.

Argumente​

  • <process-key> (erforderlich) – Prozessdefinitionsschlüssel.

Optionen​

  • --folder-key <key> (erforderlich)

Datenform​

{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}
{
  "Code": "ProcessDiagnostics",
  "Data": {
    "ProcessKey": "…",
    "FolderKey": "…",
    "Summary": { /* this process's entry from processes/summary, or null if not found */ },
    "FaultedCount": 0,
    "RunningCount": 0,
    "Incidents": [ /* array of incidents */ ],
    "IncidentCount": 0,
    "ErrorCodes": [ /* array of error code strings */ ],
    "ErrorCodeCount": 0
  }
}

UIP Maestro Flow verarbeitet Fehlercodes​

Rufen Sie den eindeutigen Satz von Fehlercodes ab, die bei allen Vorfällen eines Prozesses aufgetreten sind.

Argumente​

  • <process-key> (erforderlich)

Optionen​

  • --folder-key <key> (erforderlich)

Datenform​

{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}
{
  "Code": "ProcessIncidentErrorCodes",
  "Data": ["Process.UnhandledException"]
}

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