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

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

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

Zusammenfassung

# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]
# Singular — per-folder, operational
uip maestro process list -f <folder-key> [-t <tenant>] [--filter <odata>] [--login-validity <minutes>]
uip maestro process get  <process-key> <feed-id> -f <folder-key> [-t <tenant>] [--login-validity <minutes>]
uip maestro 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 maestro processes list
uip maestro processes incidents <process-key> [--folder-key <key>]

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


UIP Maestro-Prozessliste

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

Optionen

OptionErforderlichBeschreibung
-f, --folder-key <key>jaOrdnerschlüssel (GUID).
-t, --tenant <name>neinMandantenname. Standardmäßig der authentifizierte Mandant.
--filter <odata>neinZusätzlicher OData-Filter serverseitig angewendet.
--login-validity <minutes>neinSchwellenwert für die Tokenaktualisierung (Standard: 10).

Data shape (--output json)

{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "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"
    }
  ]
}
{
  "Code": "MaestroProcessList",
  "Data": [
    {
      "name":       "InvoiceOrchestration",
      "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 Maestro Process Get

Rufen Sie das Einstiegspunktschema (JSON-Schemas für Eingabe/Ausgabe) für einen Maestro-Prozess ab.

Argumente

  • <process-key> (erforderlich) – Prozessschlüssel.
  • <feed-id> (erforderlich) – Feed-ID (von list).

Optionen

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

Datenform

{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}
{
  "Code": "MaestroProcessGet",
  "Data": [
    {
      "Path":         "/content/main.bpmn#Event_start",
      "DisplayName":  "Manual trigger",
      "Type":         "processorchestration",
      "InputSchema":  "{\"type\":\"object\",\"properties\":{}}",
      "OutputSchema": "{\"type\":\"object\",\"properties\":{}}"
    }
  ]
}

InputSchema und OutputSchema sind erneut stringifizierte JSON-Schema-Strings.


UIP Maestro-Prozessausführung

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

Argumente

  • <process-key> (erforderlich) – Prozessschlüssel.
  • <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 eine Standardeinstellung über die Pipeline übergeben wird, wird Standarddaten 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.
--validateValidieren Sie Eingaben anhand des Prozessschemas, bevor Sie sie ausführen. Nur grundlegende Prüfungen – Pflichtfelder + primitive Typen.
--login-validity <minutes>Schwellenwert für die Tokenaktualisierung (Standard: 10).

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

Beispiele

# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate
# Inline JSON
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}'

# From a file
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" --inputs @inputs.json

# Piped stdin
echo '{"amount":100}' | uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>"

# Validate before running
uip maestro process run "InvoiceOrchestration:1.0.0" "<folder-key>" \
  --inputs '{"amount":100}' --validate

Datenform

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

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


UIP Maestro-Prozesse Liste

Mandantenweite Zusammenfassung der Maestro-Prozesse (auf diese Ebene wird kein processType -Filter angewendet – der ProcessOrchestration -Filter wird für alle Tools gemeinsam genutzt und ist nicht auf die -Serverseite beschränkt).

Argumente

Keine.

Datenform

{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
{
  "Code": "ProcessList",
  "Data": [ /* array of Maestro process summaries */ ]
}
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.


UIP-Maestro-Prozessvorfälle

Rufen Sie alle Vorfälle für eine bestimmte Maestro-Prozessdefinition ab.

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 */ ]
}
{
  "Code": "ProcessIncidents",
  "Data": [ /* array of process incidents */ ]
}

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