UiPath Documentation
uipath-cli
latest
false
Wichtig :
Dieser Inhalt wurde maschinell übersetzt. Es kann 1–2 Wochen dauern, bis die Lokalisierung neu veröffentlichter Inhalte verfügbar ist.

UiPath-CLI-Benutzerhandbuch

uip Maestro-Instanzen

uip maestro instance überprüft und steuert einzelne Prozessinstanzen – eine Ausführung eines veröffentlichten Maestro-Prozesses. Der Befehlsname ist Singular (instance), obwohl der Seitenleisteneintrag instances lautet.

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

Zusammenfassung

uip maestro instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>
uip maestro instance list                                  -f <folder-key> [-l <limit>] [--offset <n>] [--process-key <k>] [--package-id <id>] [--error-code <code>]
uip maestro instance get                 <instance-id>     -f <folder-key>
uip maestro instance pause               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance resume              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance cancel              <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance retry               <instance-id>     -f <folder-key> [--comment <text>]
uip maestro instance migrate             <instance-id> <new-version> -f <folder-key> [--comment <text>]
uip maestro instance variables           <instance-id>     -f <folder-key> [--parent-element-id <id>]
uip maestro instance incidents           <instance-id>     -f <folder-key>
uip maestro instance asset               <instance-id>     -f <folder-key>
uip maestro instance cursors             <instance-id>     -f <folder-key>
uip maestro instance goto                <instance-id> <transitions> -f <folder-key>
uip maestro instance element-executions  <instance-id>     -f <folder-key>

-f, --folder-key <key> ist für jeden Unterbefehl erforderlich.

Allgemeine Optionen

  • -f, --folder-key <key> (erforderlich) – Ordnerschlüssel (GUID).
  • --comment <text> (nur Vorgangsbefehle) – optionaler Kommentar, der mit dem Vorgang aufgezeichnet wurde. Wird als leere Zeichenfolge gesendet, wenn er nicht angegeben wird.

Unterbefehle

UIP Maestro-Instanzliste

Listen Sie Instanzen in einem Ordner auf, die auf processType=ProcessOrchestration beschränkt sind.

Optionen
OptionStandardBeschreibung
-l, --limit <n>DEFAULT_PAGE_SIZEAnzahl der zurückzugebenden Elemente (1–10.000).
--offset <n>0Anzahl der zu überspringenden Elemente (0-1000000).
--process-key <k>Nach Prozessschlüssel filtern.
--package-id <id>Filtern Sie nach Paket-ID.
--error-code <code>Nach Fehlercode filtern.
Datenform

Code: "InstanceList", Data is an array of process-instance objects.

Abrufen der UIP-Maestro-Instanz

Rufen Sie eine einzelne Instanz nach ID ab. Datenform: Code: "InstanceGet", Data ist das Prozessinstanzobjekt.

Anhalten der UIP-Maestro-Instanz

Eine laufende Instanz anhalten. Datenform: Code: "InstancePaused".

Fortsetzen der UIP-Maestro-Instanz

Setzen Sie eine angehaltene Instanz fort. Datenform: Code: "InstanceResumed".

Abbruch der UIP-Maestro-Instanz

Bricht eine laufende Instanz ab. Datenform: Code: "InstanceCanceled".

Wiederholung der UIP-Maestro-Instanz

Eine fehlerhafte Instanz wiederholen. Datenform: Code: "InstanceRetried".

UIP Maestro Instanz migrieren

Migrieren Sie eine Instanz zu einer anderen Paketversion.

Argumente: <instance-id>, <new-version> (Zielpaketversion).

Datenform: Code: "InstanceMigrated".

Variablen der UIP-Maestro-Instanz

Rufen Sie Variablen für eine Instance ab.

Optionen: --parent-element-id <id> – Filtern Sie Variablen nach dem übergeordneten Element.

Datenform: Code: "InstanceVariables", Data trägt die Nutzlast der Instanzvariablen.

Vorfälle mit der UIP-Maestro-Instanz

Datenform: Code: "InstanceIncidents", Data ist ein Array von Vorfallsobjekten.

UIP Maestro-Instanz-Asset

Rufen Sie das BPMN-Asset ab, das an das Release dieser Instanz angehängt ist.

Datenform: Code: "InstanceAsset", Data ist die BPMN-Asset-Nutzlast.

Cursor in Maestro-Instanzen

Aktuelle Cursorpositionen für die Ausführung abrufen – bei welchen Elementen die Instanz angehalten wird.

Datenform: Code: "InstanceCursors", Data listet die aktuellen Cursorpositionen auf.

UIP Maestro Instance Goto

Verschieben eines Ausführungscursors von einem Element zu einem anderen.

Argumente
  • <instance-id> (erforderlich)
  • <transitions> (erforderlich) – JSON-Array von Übergängen mit jeweils sourceElementId und targetElementId.
uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-uip maestro instance goto c3d4e5f6-… \
  '[{"sourceElementId":"Activity_1","targetElementId":"Activity_3"}]' \
  --folder-key c3d4e5f6-…
Datenform

Code: "InstanceGoto".

Elementausführungen für die UIP-Maestro-Instanz

Rufen Sie den Ausführungsverlauf pro Element für eine Instanz ab.

Datenform

Code: "InstanceElementExecutions", Data is the per-element execution history.

Beispiele

# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"
# Paginate through instances for a specific process
uip maestro instance list --folder-key <k> \
  --process-key "InvoiceOrchestration:1.0.0" --limit 50

# Pause, fix, resume
uip maestro instance pause  <id> --folder-key <k> --comment "Investigating"
uip maestro instance resume <id> --folder-key <k>

# Inspect cursors, jump a faulted node, retry
uip maestro instance cursors <id> --folder-key <k>
uip maestro instance goto    <id> '[{"sourceElementId":"A","targetElementId":"C"}]' --folder-key <k>
uip maestro instance retry   <id> --folder-key <k>

# Upgrade a long-running instance to a new package version
uip maestro instance migrate <id> "1.2.0" --folder-key <k> --comment "Patch release"

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