UIP-Flow-Prozess und UIP-Flow-Prozesse

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

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

Zusammenfassung

# Singular — per-folder, operational
uip flow process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip flow process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip flow process run  <process-key> <folder-key>
                       [-i, --inputs <json>] [-t, --tenant <name>]
                       [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>]
                       [--validate] [--login-validity <minutes>]

# Plural — tenant-wide summary and incident surface
uip flow processes list
uip flow processes incidents <process-key> [--folder-key <key>]

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

---

UIP-Flow-Prozessliste

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

Optionen

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
-t, --tenant <name>	nein	Mandantenname. Standardmäßig der authentifizierte Mandant.
--filter <odata>	nein	Zusätzlicher OData-Filter serverseitig angewendet.
--login-validity <minutes>	nein	Schwellenwert für die Tokenaktualisierung (Standard: 10).

Data shape (--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,
      "active":     "Yes",
      "latest":     "Yes"
    }
  ]
}

---

UIP-Flow-Prozess abrufen

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)
• -t, --tenant
• --login-validity

Datenform

{
  "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-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

Option	Beschreibung
-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.
-t, --tenant <name>	Mandantenname (standardmäßig ist der authentifizierte Mandant).
--release-key <key>	Versionsschlüssel (GUID) – 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.
--validate	Validieren 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
uip flow process run "InvoiceFlow.flow.Flow:1.0.0" "c3d4e5f6-0000-0000-0000-000000000001" \
  --release-key "e5f6a7b8-…" --inputs '{"amount":100}'

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

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

# Validate before running
uip 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"
  }
}

Nächster Schritt: uip flow job traces <jobKey> für die Stream-Ausführung oder uip flow job status <jobKey> für die Abfrage.

---

UIP-Flow-Prozesse

Mandantenweite Zusammenfassung der Flow-Prozesse (/processes/summary?processType=Flow). Keine Argumente, keine Optionen über globale Variablen hinaus.

Datenform

{
  "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 mit UIP-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> (optional) – Ordnerschlüssel, um die Suche durchzuführen.

Datenform

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

Die Form pro Vorfall finden Sie unter uip flow incidents .

Siehe auch

• uip flow instances – Überprüfen und steuern Sie die laufenden Ausführungen
• uip flow job – Ablaufverfolgungen und Status für einen einzelnen Auftrag
• uip flow incidents – Zusammenfassungen und Details der Vorfälle
• Orchestrator-Aufträge, Orchestrator-Prozesse
• Flow-Übersicht