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> [--filter <odata>] [--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>]
                       [--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>]... [--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
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

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
--filter <odata>	nein	Zusätzlicher OData-Filter serverseitig angewendet.
--login-validity <minutes>	nein	Schwellenwert für die Tokenaktualisierung (Standard: 10).

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

---

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

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

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.
--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.
--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.
--wait	Blockieren Sie, bis der Auftrag einen Endstatus erreicht, anstatt sofort mit Pending zurückzukehren.
--timeout <seconds>	Maximale Wartezeit in Sekunden. 0 = keine Zeitüberschreitung. Erfordert --wait.
--poll-interval <seconds>	Sekunden zwischen Statusprüfungen während der Wartezeit. Erfordert --wait.
--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 maestro 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 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"
  }
}

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

---

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

Option	Beschreibung
-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

Option	Beschreibung
-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.
--all	Wenden 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".

---

UIP Maestro 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 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 */ ]
}

Die Form pro Vorfall finden Sie unter uip maestro flow incident .

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
  }
}

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

Siehe auch

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