UIP Maestro-Fallprozess & Auftrag

Syntax und Optionen für „uip Maestro Case Process“, „Processes“, „Job“, „Instance“ und „Incident“ – Ausführen und Überprüfen von Fallverwaltungsprozessen und deren Ausführungen.

Runtime-Befehle für uip maestro case: process führt einen Fallprozess aus und verwaltet dessen Einstellungen/Variablen-Tags, job überprüft einen Ausführungsversuch, instance überprüft/steuert die resultierende Prozessinstanz, processes erstellt eine prozessübergreifende Zusammenfassung und incident liest Vorfälle. Konzepte, die im gesamten case -Subsystem geteilt werden, finden Sie unter Fallübersicht .

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

instance, incident und processes teilen ihre Implementierung mit den entsprechenden BPMN- und Flow- Befehlen (@uipath/maestro-sdk: das Modul für gemeinsam genutzte Befehle von ) – dieselben Fehler, dieselben Korrekturen gelten, hier für Fall parametrisiert (toolLabel: "Case", processType: "CaseManagement"). Ein wirklicher Verhaltensunterschied: instance 's --folder-key ist hier optional (folderKeyRequired: false), wo es für die BPMN/Flow-Äquivalente erforderlich ist.

Zusammenfassung

uip maestro case process list --folder-key <key> [--filter <odata>] [--login-validity <minutes>]
uip maestro case process get <process-key> <feed-id> --folder-key <key> [--login-validity <minutes>]
uip maestro case process run <process-key> <folder-key> [--inputs <json|@file>] [--release-key <key>] [--feed-id <id>] [--robot-ids <ids>] [--validate] [--login-validity <minutes>]
uip maestro case process settings get <process-key> --folder-key <key>
uip maestro case process settings set <process-key> --folder-key <key> --inputs <json|@file>
uip maestro case process variable-tags get <process-key> --folder-key <key>
uip maestro case process variable-tags set <process-key> --folder-key <key> [--variable <name>]... [--element-id <id>] [--all] [--searchable <true|false>] [--tags <csv>] [--add-tags <csv>] [--remove-tags <csv>] [--inputs <json|@file>]

uip maestro case processes list [--folder-key <key>] [--limit <n>] [--offset <n>] [--status <status>]
uip maestro case processes incidents <process-key> --folder-key <key>
uip maestro case processes diagnose <process-key> --folder-key <key>
uip maestro case processes error-codes <process-key> --folder-key <key>

uip maestro case job traces <job-key> [--folder-key <key>] [--poll-interval <ms>] [--traces-service <name>] [--pretty] [--login-validity <minutes>]
uip maestro case job status <job-key> [--folder-key <key>] [--detailed] [--login-validity <minutes>]

uip maestro case instance list --folder-key <key> [-l <limit>] [--next-page <cursor>] [--process-key <k>] [--package-id <id>] [--error-code <code>] [--status <status>]... [--from-date <iso-8601>] [--to-date <iso-8601>]
uip maestro case instance get <instance-id> [--folder-key <key>]
uip maestro case instance pause|resume|cancel|retry <instance-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance migrate <instance-id> <new-version> [--folder-key <key>] [--comment <text>]
uip maestro case instance incidents|asset|cursors|element-executions|variables|variables-all|global-variables <instance-id> [--folder-key <key>]
uip maestro case instance variables-set <instance-id> [--folder-key <key>] --inputs <json|@file>
uip maestro case instance goto <instance-id> <transitions> [--folder-key <key>]
uip maestro case instance element cancel|retry <instance-id> <element-id> [--folder-key <key>] [--comment <text>]
uip maestro case instance message send [--folder-key <key>] [--inputs <json|@file>]

uip maestro case incident summary [--folder-key <key>] [-l <limit>] [--offset <n>] [--process-key <k>] [--status <status>] [--severity <severity>]
uip maestro case incident get <incident-id> --folder-key <key>

UIP Maestro-Fallprozess

Fallprozesse verwalten: Listen Sie auf, was in einem Ordner veröffentlicht wird, überprüfen Sie das Eingabe-/Ausgabeschema eines Einstiegspunkts und führen Sie eines aus.

Hinweis:

process run verwendet <folder-key> als Positionsargument, nicht als Flag – anders als jedes andere Verb auf dieser Seite (list/get/settings/variable-tags), die alle --folder-key/-f verwenden . Diese Asymmetrie ist real und kein Tippfehler – überprüfen Sie es mit der --help Ihrer eigenen CLI-Version, wenn ein kopiertes Beispiel fehlschlägt.

UIP Maestro-Fallprozessliste

Listen Sie Fallprozesse auf, die in einem Ordner veröffentlicht wurden.

Optionen

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
--filter <odata>	nein	Zusätzlicher OData-Filter.
--login-validity <minutes>	nein	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. Der Standardwert ist 10.

Datenform

{
  "Code": "CaseProcessList",
  "Data": [
    {
      "name": "InvoiceReview",
      "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-Fallprozesses für Maestro

Rufen Sie die Einstiegspunktschemata eines Prozesses ab – die Eingabe-/Ausgabeform, die process run erwartet.

Argumente

Name	Erforderlich	Zweck
<process-key>	ja	Prozessschlüssel.
<feed-id>	ja	Feed-ID aus process list dem feedId Feld.

Optionen

Option	Erforderlich	Beschreibung
-f, --folder-key <key>	ja	Ordnerschlüssel (GUID).
--login-validity <minutes>	nein	Der Standardwert ist 10.

Datenform

{
  "Code": "CaseProcessGet",
  "Data": [
    {
      "Path": "/content/caseplan.json.bpmn#Trigger_1",
      "DisplayName": "Start",
      "Type": "CaseManagement",
      "InputSchema": "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

Data ist ein Array – ein Eintrag pro Einstiegspunkt, den der Prozess verfügbar macht, kein einzelnes Objekt. Schlägt mit einem expliziten Fehler fehl, wenn der Prozess null Einstiegspunkte hat.

Ausführung des Fallprozesses von UIP Maestro

Starten Sie eine Fallprozessinstanz.

Argumente

Name	Erforderlich	Zweck
<process-key>	ja	Prozessschlüssel.
<folder-key>	ja	Ordnerschlüssel (GUID) – hier Positional, kein Flag.

Optionen

Option	Erforderlich	Beschreibung
-i, --inputs <json>	nein	Eingabeparameter als JSON-Zeichenfolge oder @file.json. Lassen Sie stattdessen das Lesen aus Standardwert weg; lassen Sie beides für leere Eingaben weg ({}).
--release-key <key>	nein	Releaseschlüssel (GUID) von process list.
--feed-id <id>	nein	Feed-ID für die Paketsuche.
--robot-ids <ids>	nein	Durch Kommas getrennte numerische Roboter-IDs. Schlägt schnell fehl, wenn ein Eintrag keine Zahl ist.
--validate	nein	Führen Sie vor der Übermittlung eine grundlegende clientseitige Validierung (Pflichtfelder + primitive Typen) für das Eingabeschema des Prozesses aus. Gibt ✅/❌ aus und beendet 1 bei einem Fehler, ohne einen Auftrag zu starten.
--login-validity <minutes>	nein	Der Standardwert ist 10.

Beispiel

uip maestro case process run a1b2c3d4-0000-0000-0000-000000000001 c3d4e5f6-0000-0000-0000-000000000001 \
  --inputs '{"amount":100}'

Datenform

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

Die Erfolgsmeldung verweist Sie auf uip maestro case job traces <jobKey>, um die Ausführung zu beobachten.

UIP Maestro-Fallprozesseinstellungen

Lesen oder ersetzen Sie das Roheinstellungsobjekt eines Prozesses (dasselbe Objekt, von dem variable-tags ein Feld liest/schreibt).

Verb	Argumente	Optionen	Hinweise
get	<process-key>	-f, --folder-key <key> erforderlich	Code: "ProcessSettingsGet".
set	<process-key>	-f, --folder-key <key> erforderlich, --inputs <json|@file>	Lesen-Modifizieren-Schreiben: GET-Aufrufe für aktuelle Einstellungen, PUTs Ihre Nutzlast als neues Objekt. Code: "ProcessSettingsSet").

UIP Maestro Case-Prozessvariablen-Tags

Kennzeichnen Sie die Ausgabevariablen eines Prozesses (z. B. Markieren einer durchsuchbaren Variable für die Instanzlistenfilterung). Zwei unabhängige Modi – wählen Sie einen, nicht beides:

• Anzeigemodus: --variable <name> (wiederholbar) + --element-id/--all zum Ziel, plus --searchable <true|false> oder die niedrigere Ebene --tags/--add-tags/--remove-tags zum Ändern.
• Unformatierter Modus: --inputs <json|@file> mit der vollständigen variableTags Nutzlast.

Verb	Argumente	Optionen	Hinweise
get	<process-key>	-f, --folder-key <key> erforderlich	Gibt nur das variableTags -Objekt zurück. Code: "ProcessVariableTagsGet").
set	<process-key>	-f, --folder-key <key> requirements. sowie die oben genannten unabhängigen/unformatierten Flags	Das Kombinieren von --inputs mit einem benutzerfreundlichen Flag ist ein Fehler. --element-id funktioniert nur mit genau einem --variable. --searchable kann nicht mit --tags/--add-tags/--remove-tags kombiniert werden. Code: "ProcessVariableTagsSet").

Beispiel

# Mark the "amount" output searchable
uip maestro case process variable-tags set a1b2c3d4-… --folder-key <key> --variable amount --searchable true

UIP Maestro Fallprozesse

Prozessübergreifende Zusammenfassungsansicht – listen Sie die aggregierte Anzahl jedes Prozesses auf oder analysieren Sie jeden Prozess nach Schlüssel. Freigegeben die Implementierung mit BPMN processes und dem Flow-Äquivalent, gefiltert nach processType: "CaseManagement".

Verb	Argumente	Optionen	Hinweise
list	–	--folder-key <key>, -l/--limit <n>, --offset <n>, --status <status>	Code: "ProcessList".
incidents	<process-key>	--folder-key <key> erforderlich	Code: "ProcessIncidents".
diagnose	<process-key>	--folder-key <key> erforderlich	Korreliert Zusammenfassung + Vorfälle + Fehlercodes in einem Aufruf. Code: "ProcessDiagnostics" mit FaultedCount/RunningCount/IncidentCount/ErrorCodeCount Rollups.
error-codes	<process-key>	--folder-key <key> erforderlich	Code: "ProcessIncidentErrorCodes".

UIP Maestro-Fallauftrag

Überprüfen Sie einen Ausführungsversuch (einen Auftrag) eines Fallprozesses.

Ablaufverfolgungen von UIP Maestro-Fallaufträgen

Streamen Sie Ausführungs-Trace-Ereignisse für einen laufenden oder kürzlich abgeschlossenen Auftrag.

Optionen

Option	Standard	Beschreibung
--folder-key <key>	–	Optional – Scopes für die Ablaufverfolgungsanforderung.
--poll-interval <ms>	2000	Abrufintervall.
--traces-service <name>	llmopstenant_	Ablaufverfolgungendienstname.
--pretty	aus	Für Menschen lesbare Ablaufverfolgungszeilen anstelle von unformatiertem JSON.
--login-validity <minutes>	10	Schwellenwert für die Tokenaktualisierung.

Traces werden direkt zur Ausgabe – keine endgültige Data Nutzlast. Bei Erfolg beenden Sie den Code 0, andernfalls 1.

UIP Maestro-Fallauftrag

Rufen Sie den Status eines Auftrags ab.

Optionen

Option	Erforderlich	Standard	Beschreibung
--folder-key <key>	nein	authentifizierten Ordner	Ordnerschlüssel (GUID, von process list). Optional – lassen Sie es weg, wenn das Backend Ihren Standardordner auflöst.
--detailed	nein	aus	Vollständige Antwort anstelle der kuratierten Zusammenfassung.
--login-validity <minutes>	nein	10	Schwellenwert für die Tokenaktualisierung.

Datenform (Standardzusammenfassung)

{
  "Code": "CaseJobStatus",
  "Data": {
    "key": "b2c3d4e5-0000-0000-0000-000000000001",
    "state": "Successful",
    "runtimeType": "…",
    "processType": "CaseManagement",
    "startTime": "2025-04-15T10:30:00Z",
    "endTime": "2025-04-15T10:32:11Z",
    "creationTime": "…",
    "inputArguments": "…",
    "outputArguments": "…",
    "info": "…",
    "releaseName": "InvoiceReviewProcess",
    "processKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "robotName": "…",
    "hostMachineName": "…"
  }
}

uip Maestro-Fallinstanz

Untersuchen und steuern Sie einzelne Prozessinstanzen – eine Ausführung eines Fallprozesses. Gibt die Implementierung mit BPMN instance und Flow instance frei; Die vollständige Verb-für-Verb-Referenz finden Sie auf einer der Seiten (list, get, pause, resume, cancel, retry, migrate, variables, variables-set, variables-all, global-variables, incidents, asset, cursors, goto, element-executions, element cancel/retry, message send) – jeder Optionsname, Standard und Datenform identisch ist.

Der einzige echte Unterschied: -f, --folder-key ist optional bei jedem instance -Unterbefehl für Case (folderKeyRequired: false in der Konfiguration für gemeinsame Befehle), wo BPMN und Flow dies erfordern. Lassen Sie den Scope weg, um auf Ihren authentifizierten Standardordner zuzugreifen.

UIP-Vorfall für Maestro

Lesen Sie Vorfälle prozessübergreifend oder nach ID. Identische Implementierung mit dem Äquivalent von BPMN incident/Flow – siehe entweder Seite für die vollständige 6-Flag- summary -Optionstabelle und das einzelne erforderliche get --folder-key.

Beispiele

# Publish check, then run
uip maestro case process list --folder-key <key>
uip maestro case process get a1b2c3d4-… default --folder-key <key>
uip maestro case process run a1b2c3d4-… <key> --inputs '{"amount":100}'

# Watch it through to completion
JOB_KEY=$(uip maestro case process run a1b2c3d4-… <key> --inputs '{}' --output-filter "Data.jobKey" --output plain)
uip maestro case job traces "$JOB_KEY" --pretty
uip maestro case job status "$JOB_KEY" --detailed

# Diagnose a failing process in one call
uip maestro case processes diagnose a1b2c3d4-… --folder-key <key>

Siehe auch

• Case overview
• uip maestro bpmn instance / uip maestro flow instance – vollständige Referenz für freigegebene Instanz
• uip maestro bpmn incident – vollständige Referenz für gemeinsame Vorfälle
• Orchestrator-Aufträge