- Überblick
- Erste Schritte
- Konzepte
- Verwenden der UiPath CLI
- Anleitungen
- CI/CD-Rezepte
- Befehlsreferenz
- Überblick
- Exitcodes
- Globale Optionen
- UIP-codierter Agent
- UIP-Coded
- UIP-Kontextgrundlage
- UIP-Dokumentation
- UIP-Funktion
- UIP-Leitplanken
- uip llm-configuration
- uip llm-gateway
- UIP Maestro-Erstellung
- UIP Maestro-Registrierung
- UIP-Modellhub
- Aktivitäten finden
- get-standard-xaml
- Analysieren
- Analyseregeln-Liste
- Erstellen
- Bereinigung
- data-fabric-entities installieren
- data-fabric-entities-Liste
- Dateien differenzieren
- Get-Library-Object-Repository
- Get-Object-Repository
- Init
- Instanzenliste
- Packen
- Pakete überprüfen
- Pakete installieren
- Paketversionen
- Veröffentlichen
- Remote
- restore
- Ausführen, Debuggen & Ausführung enthält
- Einstellungen
- Studio-Start
- Vorlagensuche
- Testdaten-Add-Entität
- Testdaten-Warteschlange hinzufügen
- Testdaten-Hinzufügevariante
- TM
- UIA
- Überprüfen
- Workflow-Beispiele abrufen
- Workflow-Beispiele
- UIP-Aufgaben
- Anhang
- benutzerdefiniertes Feld
- Defects
- Ausführungen
- Exportaufträge
- Migration
- Objektbeschriftung
- Packen
- perf-szenario
- Perf-Szenario-Lastgruppen
- Ausführungsdaten für perf-szenario
- Perf-Szenario-Bericht
- Projekt
- Projektberechtigungen
- Aufforderungen
- Melden
- Anforderungen
- Ergebnis
- Ausführen
- Zeitpläne
- Testfallprotokoll
- Testfälle
- Testsätze
- Testschrittprotokoll
- Benutzer
- Warten
- UIP-Ablaufverfolgungen
- Feedback zu UIP-Ablaufverfolgungen
- Migration
- Referenz und Support
UIP oder Prozesse
Syntax und Optionen für „UIP oder Processes“, das die Ordnerbindungen von Paketen an ausführbare Prozesse in Orchestrator verwaltet.
uip or processes verwaltet die ausführbaren Bindungen von Paketen an Ordner – was Orchestrator intern als Releases aufruft. Ein Prozess ist das Ziel von uip or jobs start ; Ein Paket ist das zugrunde liegende .nupkg -Artefakt (siehe uip or packages).
Zusammenfassung
uip or processes <verb> [options]
uip or processes <verb> [options]
Verben
| Verb | Zweck |
|---|---|
list | Listen Sie Prozesse in einem Ordner oder in jedem Ordner im Mandanten auf. |
get | Rufen Sie einen Prozess nach Schlüssel ab, einschließlich Argumentschemas und Aufbewahrung. |
resources | Listenpaketressourcen (Warteschlangen, Assets, Buckets, Verbindungen) auf, die für einen Prozess erforderlich sind. |
version-history | Listen Sie den chronologischen Paketversionsverlauf für einen Prozess auf. |
create | Binden Sie ein Paket als neuen Prozess an einen Ordner. |
update-version | Führen Sie einen oder mehrere Prozesse auf die neueste (oder eine bestimmte) Paketversion aus. |
update (Alias edit) | Prozesseinstellungen aktualisieren (PATCH-Semantik für ausgewählte Felder). |
delete | Eine Prozessbindung nach Schlüssel löschen (löscht das Paket nicht). |
rollback | Einen Prozess auf die vorherige Paketversion zurücksetzen. |
UIP oder Prozessliste
Listen Sie Prozesse in einem Ordner (--folder-path oder --folder-key) oder in jedem Ordner im Mandanten mit --all-folders auf. Gibt den Prozessschlüssel (GUID), den Namen, die Version, den Ordner und die Aufbewahrungseinstellungen zurück.
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | – | Zielordner nach Pfad. |
| – | --folder-key | GUID | – | Zielordner nach Schlüssel. |
| – | --all-folders | Markieren | aus | Mandantenweite Auflistung. Sich gegenseitig mit --folder-path/--folder-key ausschließen. |
-n | --name | text | – | Enthält Übereinstimmung für Prozessnamen. |
| – | --process-type | ENUM | – | Process, Agent, Flow, TestAutomationProcess, WebApp, Api, MCPServer, BusinessRules, CaseManagement, Function. |
| – | --all-fields | Markieren | aus | Gibt die vollständige API-Nutzlast zurück. |
-l | --limit | Nummer | 50 | Seitengröße. |
| – | --offset | Nummer | 0 | Anzahl der Überspringungen. |
| – | --sort-by | Feld | Id desc | OData-Sortierung. |
Beispiele
uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --limit 50 --folder-path "Shared" \
--output-filter '[].{key:Key, name:Name, v:ProcessVersion}'
# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"
uip or processes list --folder-path "Shared"
uip or processes list --folder-path "Shared" --process-type Agent
uip or processes list --limit 50 --folder-path "Shared" \
--output-filter '[].{key:Key, name:Name, v:ProcessVersion}'
# Tenant-wide audit across every folder
uip or processes list --all-folders --name "Invoice"
Datenform (--output json)
{
"Code": "ProcessList",
"Data": [
{
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "",
"IsLatestVersion": true,
"FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
"FolderPath": "Shared",
"RetentionPeriod": 30,
"RetentionAction": "Delete"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
"Code": "ProcessList",
"Data": [
{
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "",
"IsLatestVersion": true,
"FolderKey": "f0f0f0f0-0000-0000-0000-000000000001",
"FolderPath": "Shared",
"RetentionPeriod": 30,
"RetentionAction": "Delete"
}
],
"Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
FolderId wird jeder Zeile nur hinzugefügt, wenn --all-folders verwendet wird.
UIP oder Prozesse abrufen
Rufen Sie einen Prozess nach GUID-Schlüssel ab. Gibt Version, Einstiegspunkt, Eingabe-/Ausgabeargumentschemata, Prozesstyp und Konfiguration zurück. Der Schlüssel wird standardmäßig mandantenweit aufgelöst. Übergeben Sie --folder-path oder --folder-key um die Suche auf einen Ordner zu beschränken, was eine Identität mit nur Zugriff auf einen einzelnen Ordner (z. B. eine externe App) erfordert.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). Finden Sie es mit processes list. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | – | Scope die Suche auf diesen Ordner, anstatt den Schlüssel mandantenweit aufzulösen. |
| – | --folder-key | GUID | – | Scope die Suche auf diesen Ordner, anstatt den Schlüssel mandantenweit aufzulösen. |
| – | --all-fields | Markieren | aus | Gibt die vollständige API-Nutzlast zurück. |
Beispiele
uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
--output-filter 'InputArguments'
uip or processes get c3d4e5f6-0000-0000-0000-000000000001
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes get c3d4e5f6-0000-0000-0000-000000000001 \
--output-filter 'InputArguments'
Datenform (--output json)
{
"Code": "ProcessGet",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "Processes vendor invoices",
"IsLatestVersion": true,
"ProcessType": "Process",
"EntryPointPath": "Main.xaml",
"InputArguments": "{\"invoicePath\":\"String\"}",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
"FolderPath": "Shared",
"AutoUpdate": false,
"TargetFramework": "Windows",
"JobPriority": "Normal",
"SpecificPriorityValue": 50,
"RetentionPeriod": 30,
"RetentionAction": "Delete",
"StaleRetentionPeriod": 0,
"StaleRetentionAction": "None",
"HiddenForAttendedUser": false,
"AutoCreateConnectedTriggers": false
}
}
{
"Code": "ProcessGet",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "Processes vendor invoices",
"IsLatestVersion": true,
"ProcessType": "Process",
"EntryPointPath": "Main.xaml",
"InputArguments": "{\"invoicePath\":\"String\"}",
"FolderKey": "a1b2c3d4-0000-0000-0000-000000000001",
"FolderPath": "Shared",
"AutoUpdate": false,
"TargetFramework": "Windows",
"JobPriority": "Normal",
"SpecificPriorityValue": 50,
"RetentionPeriod": 30,
"RetentionAction": "Delete",
"StaleRetentionPeriod": 0,
"StaleRetentionAction": "None",
"HiddenForAttendedUser": false,
"AutoCreateConnectedTriggers": false
}
}
uip oder Prozessressourcen
Listenpaketressourcen – Warteschlangen, Assets, Buckets, Verbindungen und andere Paketanforderungen – auf die von einem Prozess verwiesen wird. Löst den Ordner des Prozesses automatisch auf; Kein Ordner-Flag erforderlich.
ResourceName, FolderPath und ResourceId geben an, was das Paket deklariert. Wenn der Prozess eine Ressource erneut an ein anderes Ziel bindet, ist IsOverwritten true und die Felder Overwrite* beschreiben das Ziel, an das der Prozess gebunden wird:
| Feld | Beschreibung |
|---|---|
IsOverwritten | true wenn der Prozess die Ressource neu bindet; false andernfalls. |
OverwriteName | Anzeigename der Zielressource. Leer, wenn die Ressource nicht zurückgestuft wird. |
OverwriteEntityId | Orchestrator-ID der Zielressource. Leer, wenn die Ressource nicht zurückgestuft wird. |
OverwriteFolderId | ID des Ordners, der die Zielressource enthält. null wenn die Ressource nicht zurückgestuft wird. |
OverwriteProperties | Eigenschaftsname/Wert-Paare, die das Ziel definieren, z. B. name und folderPath. Schlüssel werden genau so zurückgegeben, wie sie vom Orchestrator gespeichert werden. {} wenn die Ressource nicht zurückgestuft wird. |
Bei --all-fields enthält jede Zeile die unformatierte API-Ressource plus ein Overwrite -Objekt (null , wenn die Ressource nicht zurückgestuft wird).
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). Finden Sie es mit processes list. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --all-fields | Markieren | aus | Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück. |
Beispiele
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001
uip or processes resources c3d4e5f6-0000-0000-0000-000000000001 --all-fields
Datenform (--output json)
{
"Code": "ProcessResources",
"Data": [
{
"ResourceType": "Queue",
"ResourceName": "InvoiceQueue",
"FolderPath": "Shared",
"ValidationResult": "Success",
"ValidationError": "",
"IsOverwritable": true,
"ResourceKey": "InvoiceQueue",
"ResourceId": "123456",
"Id": 0,
"IsOverwritten": false,
"OverwriteName": "",
"OverwriteEntityId": "",
"OverwriteFolderId": null,
"OverwriteProperties": {}
}
]
}
{
"Code": "ProcessResources",
"Data": [
{
"ResourceType": "Queue",
"ResourceName": "InvoiceQueue",
"FolderPath": "Shared",
"ValidationResult": "Success",
"ValidationError": "",
"IsOverwritable": true,
"ResourceKey": "InvoiceQueue",
"ResourceId": "123456",
"Id": 0,
"IsOverwritten": false,
"OverwriteName": "",
"OverwriteEntityId": "",
"OverwriteFolderId": null,
"OverwriteProperties": {}
}
]
}
Eine Ressource, die der Prozess erneut an einen anderen Ordner bindet:
{
"Code": "ProcessResources",
"Data": [
{
"ResourceType": "App",
"ResourceName": "ApprovalApp",
"FolderPath": "Dev/Apps",
"ValidationResult": "Success",
"ValidationError": "",
"IsOverwritable": true,
"ResourceKey": "Dev/Apps.ApprovalApp",
"ResourceId": "555001",
"Id": 0,
"IsOverwritten": true,
"OverwriteName": "ApprovalApp",
"OverwriteEntityId": "777002",
"OverwriteFolderId": 4412,
"OverwriteProperties": {
"name": "ApprovalApp",
"folderPath": "Prod/Apps"
}
}
]
}
{
"Code": "ProcessResources",
"Data": [
{
"ResourceType": "App",
"ResourceName": "ApprovalApp",
"FolderPath": "Dev/Apps",
"ValidationResult": "Success",
"ValidationError": "",
"IsOverwritable": true,
"ResourceKey": "Dev/Apps.ApprovalApp",
"ResourceId": "555001",
"Id": 0,
"IsOverwritten": true,
"OverwriteName": "ApprovalApp",
"OverwriteEntityId": "777002",
"OverwriteFolderId": 4412,
"OverwriteProperties": {
"name": "ApprovalApp",
"folderPath": "Prod/Apps"
}
}
]
}
UIP oder Prozessversionsverlauf
Listen Sie den chronologischen Paketversionsverlauf auf, der einem Prozess zugeordnet ist. Der Ordner ist optional – wenn er nicht angegeben ist, wird er aus dem Prozessschlüssel abgeleitet.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | abgeleitet | Überspringen Sie die automatische Erkennung, und verwenden Sie diesen Ordner. |
| – | --folder-key | GUID | abgeleitet | Überspringen Sie die automatische Erkennung, und verwenden Sie diesen Ordner. |
| – | --all-fields | Markieren | aus | Geben Sie die vollständige API-Nutzlast anstelle der kuratierten Zusammenfassung zurück. |
Beispiele
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
Datenform (--output json)
{
"Code": "ProcessVersionHistory",
"Data": [
{
"Version": "1.0.0",
"CreatedAt": "2024-01-10T08:30:00.000Z",
"ReleaseName": "InvoiceProcessing",
"ReleaseId": 101,
"Id": 1001
},
{
"Version": "1.0.2",
"CreatedAt": "2024-01-15T09:45:00.000Z",
"ReleaseName": "InvoiceProcessing",
"ReleaseId": 101,
"Id": 1002
}
]
}
{
"Code": "ProcessVersionHistory",
"Data": [
{
"Version": "1.0.0",
"CreatedAt": "2024-01-10T08:30:00.000Z",
"ReleaseName": "InvoiceProcessing",
"ReleaseId": 101,
"Id": 1001
},
{
"Version": "1.0.2",
"CreatedAt": "2024-01-15T09:45:00.000Z",
"ReleaseName": "InvoiceProcessing",
"ReleaseId": 101,
"Id": 1002
}
]
}
UIP oder Prozesse erstellen
Binden Sie ein Paket als Prozess an einen Ordner. Erfordert --folder-path oder --folder-key und drei erforderliche Paketoptionen. Verwenden Sie uip or packages list für den Paketschlüssel und uip or packages versions für verfügbare Versionen.
Die Auftragsaufbewahrung wird nach 30 Tagen standardmäßig auf Delete festgelegt. Um Aufträge stattdessen zu archivieren, übergeben Sie --retention-action Archive mit --retention-bucket <bucket-key>. Um veraltete Aufträge zu archivieren, übergeben Sie --stale-retention-action Archive mit --stale-retention-period <days> und --stale-retention-bucket <bucket-key>.
Optionen
Erforderlich
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --name | text | – | Prozessname innerhalb des Ordners. |
| – | --package-key | text | – | Paketschlüssel (der PackageId aus packages list). |
| – | --package-version | Version | – | Paketversion (z. B. 1.0.0). |
Identität und Scope
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | – | Zielordner nach Pfad. |
| – | --folder-key | GUID | – | Zielordner nach Schlüssel. |
Prozesseinstellungen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --description | text | – | Prozessbeschreibung. |
| – | --entry-point | Pfad | – | Workflow-Pfad des Einstiegspunkts (für Pakete mit mehreren Einstiegspunkten). |
| – | --input-arguments | JSON | – | Standardeingabeargumente als JSON. |
| – | --job-priority | ENUM | – | Low, Normal, High. Sich gegenseitig mit --specific-priority ausschließen. |
| – | --specific-priority | 1–100 | – | Numerische Priorität. Sich gegenseitig mit --job-priority ausschließen. |
| – | --robot-size | ENUM | – | Cloud-Robotergröße: Small, Standard, Medium, Large. |
| – | --tags | CSV | – | Durch Kommas getrennte Tag-Namen. |
| – | --environment-variables | text | – | Umgebungsvariablen als durch neue Zeilen getrennte KEY=VALUE -Paare (nicht JSON), z. B. $'FOO=bar\nBAZ=qux'). |
| – | --auto-update / --no-auto-update | Markieren | – | Aktivieren/Deaktivieren der automatischen Aktualisierung auf die neueste Paketversion. |
| – | --hidden-for-attended / --visible-for-attended | Markieren | – | Für Attended-Benutzer ausblenden oder anzeigen. Sich gegenseitig ausschließen. |
| – | --auto-create-triggers / --no-auto-create-triggers | Markieren | – | Erstellen Sie automatisch verbundene Trigger bei der Bereitstellung. |
Aufbewahrung
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --retention-period | Tage (1–180) | 30 | Aufbewahrungszeitraum des Auftrags. |
| – | --retention-action | ENUM | Delete | Delete, Archive oder None. Archive erfordert --retention-bucket. |
| – | --retention-bucket | Bucket-Schlüssel (GUID) | – | Speicher-Bucket-Schlüssel für archivierte Aufträge. Erforderlich, wenn --retention-action Archive ist, und abgelehnt für Delete oder None. Der Bucket muss sich im Prozessordner befinden oder für diesen freigegeben sein. Rufen Sie den Schlüssel von uip or buckets list ab. |
| – | --stale-retention-period | Tage | 180 für Delete/None | Aufbewahrungszeitraum für veraltete Aufträge. Erfordert --stale-retention-action. Erforderlich, wenn die veraltete Aktion Archive ist. |
| – | --stale-retention-action | ENUM | – | Delete, Archive oder None. Archive erfordert --stale-retention-bucket. |
| – | --stale-retention-bucket | Bucket-Schlüssel (GUID) | – | Speicher-Bucket-Schlüssel für archivierte veraltete Aufträge. Erforderlich, wenn --stale-retention-action Archive ist. Der Bucket muss sich im Prozessordner befinden oder für diesen freigegeben sein. Holen Sie sich den Schlüssel von uip or buckets list. |
Beispiele
uip or processes create --folder-path "Shared" \
--name "InvoiceProcessing" \
--package-key InvoiceProcessing --package-version 1.0.2
uip or processes create --folder-path "Production/EU" \
--name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
--job-priority High --auto-update --tags "finance,eu"
uip or processes create --folder-path "Shared" \
--name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
--output-filter 'Key'
uip or processes create --folder-path "Shared" \
--name "InvoiceProcessing" \
--package-key InvoiceProcessing --package-version 1.0.2
uip or processes create --folder-path "Production/EU" \
--name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
--job-priority High --auto-update --tags "finance,eu"
uip or processes create --folder-path "Shared" \
--name "InvoiceProcessing" --package-key InvoiceProcessing --package-version 1.0.2 \
--output-filter 'Key'
Datenform (--output json)
{
"Code": "ProcessCreated",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000010",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "",
"IsLatestVersion": true,
"RetentionPeriod": 30,
"RetentionAction": "Delete"
}
}
{
"Code": "ProcessCreated",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000010",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"ProcessVersion": "1.0.2",
"Description": "",
"IsLatestVersion": true,
"RetentionPeriod": 30,
"RetentionAction": "Delete"
}
}
UIP oder Prozessaktualisierungsversion
Aktualisieren Sie einen oder mehrere Prozesse auf die neueste Paketversion oder auf eine bestimmte Version mit --package-version. Der Ordner ist optional – wenn er nicht angegeben ist, wird er aus dem ersten Prozessschlüssel abgeleitet.
- Ein Schlüssel + kein
--package-version→ auf den neuesten Stand aktualisieren (einmaliger API-Aufruf). - Ein Schlüssel +
--package-version→ Aktualisierung auf diese Version (einmaliger API-Aufruf). - Mehrere Schlüssel + kein
--package-version→ Massenaktualisierung auf den neuesten Stand. - Mehrere Schlüssel +
--package-version→ abgelehnt (Validierungsfehler).
Laufende Aufträge sind nicht betroffen; nur neue Aufträge verwenden die aktualisierte Version.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-keys...> | ja | Ein oder mehrere Prozessschlüssel (GUIDs). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | abgeleitet | Überspringen Sie die automatische Erkennung, und verwenden Sie diesen Ordner. |
| – | --folder-key | GUID | abgeleitet | Überspringen Sie die automatische Erkennung, und verwenden Sie diesen Ordner. |
| – | --package-version | Version | – | Bestimmte Version. Nur mit einem einzelnen Schlüssel gültig. |
Beispiele
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
--package-version 1.0.3
uip or processes update-version \
c3d4e5f6-0000-0000-0000-000000000001 \
c3d4e5f6-0000-0000-0000-000000000002 \
--output-filter 'Version'
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001
uip or processes update-version c3d4e5f6-0000-0000-0000-000000000001 \
--package-version 1.0.3
uip or processes update-version \
c3d4e5f6-0000-0000-0000-000000000001 \
c3d4e5f6-0000-0000-0000-000000000002 \
--output-filter 'Version'
Datenform (--output json)
Einzelschlüssel:
{
"Code": "ProcessVersionUpdated",
"Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
{
"Code": "ProcessVersionUpdated",
"Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
Massenhaftes Geben Code: "ProcessVersionsUpdated" mit ProcessKeys, Version und einem Result -Objekt zurück, das von der API zurückgegeben wird.
UIP oder Prozessaktualisierung
Aktualisieren Sie die Prozesseinstellungen nach Schlüssel. Liest aktuelle Werte, wendet die bereitgestellten PATCH-Felder an und speichert. Nur bereitgestellte Felder werden geändert; Felder, die in der CLI weggelassen werden, werden im aktuellen Status beibehalten. Der Schlüssel wird standardmäßig mandantenweit aufgelöst. Übergeben Sie --folder-path oder --folder-key um die Suche auf einen Ordner zu beschränken, was eine Identität mit nur Zugriff auf einen einzelnen Ordner (z. B. eine externe App) erfordert.
edit ist ein registrierter Alias für dieses Verb – uip or processes edit funktioniert identisch mit uip or processes update.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). |
Optionen
Die gleichen Felder wie processes create , mit Ausnahme der drei erforderlichen Paketoptionen und --tags. Die Regeln für den gegenseitigen Ausschluss und die Validierung stimmen mit create überein (--job-priority vs. --specific-priority, --hidden-for-attended vs. --visible-for-attended). Die Archivaufbewahrung erfordert einen Speicher-Bucket: Während die Aktion Archive bleibt, wird der aktuelle Bucket beibehalten, und wenn sich die Aktion zu Delete oder None ändert, wird der Bucket gelöscht.
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | – | Scope die Schlüsselsuche auf diesen Ordner, anstatt sie mandantenweit aufzulösen. |
| – | --folder-key | GUID | – | Scope die Schlüsselsuche auf diesen Ordner, anstatt sie mandantenweit aufzulösen. |
-n | --name | text | – | Neuer Anzeigename. |
-d | --description | text | – | Neue Beschreibung. |
| – | --entry-point | Pfad | – | Neuer Einstiegspunktpfad. |
| – | --input-arguments | JSON | – | Standardmäßige Eingabeargumente. |
| – | --environment-variables | text | – | Durch neue Zeilen getrennte KEY=VALUE -Paare (nicht JSON). Übergeben Sie '', um sie zu löschen. |
| – | --job-priority | ENUM | – | Low, Normal, High. |
| – | --specific-priority | 1–100 | – | Numerische Priorität. |
| – | --robot-size | ENUM | – | Cloud-Robotergröße: Small, Standard, Medium, Large. |
| – | --auto-update / --no-auto-update | Markieren | – | Schalten Sie die automatische Aktualisierung um. |
| – | --hidden-for-attended / --visible-for-attended | Markieren | – | Attended-Sichtbarkeit. |
| – | --auto-create-triggers / --no-auto-create-triggers | Markieren | – | Automatische Erstellung mit verbundenem Trigger. |
| – | --healing-agent / --no-healing-agent | Markieren | – | Aktivieren oder deaktivieren Sie Healing Agent (Autopilot for Robots) für diesen Prozess. Zukünftige Aufträge verwenden es standardmäßig, sobald es aktiviert ist; Autopilot auf Mandantenebene muss bereits aktiviert sein. |
| – | --retention-period | Tage (1–180) | – | Aufbewahrungszeitraum des Auftrags. |
| – | --retention-action | ENUM | – | Delete, Archive, None. Der Wechsel zu Archive erfordert --retention-bucket , es sei denn, der Prozess wird bereits archiviert. |
| – | --retention-bucket | Bucket-Schlüssel (GUID) | – | Speicher-Bucket-Schlüssel für archivierte Aufträge. Ohne Angabe, um den aktuellen Bucket beizubehalten. Der Bucket muss sich im Prozessordner befinden oder für diesen freigegeben sein. Rufen Sie den Schlüssel von uip or buckets list ab. |
| – | --stale-retention-period | Tage | – | Aufbewahrungszeitraum für veraltete Aufträge. Lassen Sie weg, um den aktuellen Zeitraum beizubehalten. Wenn kein Zeitraum gespeichert wird, erfordert Delete/None die Verwendung 180 und Archive diese Option. |
| – | --stale-retention-action | ENUM | – | Delete, Archive, None. Archive erfordert --stale-retention-bucket. |
| – | --stale-retention-bucket | Bucket-Schlüssel (GUID) | – | Speicher-Bucket-Schlüssel für archivierte veraltete Aufträge. Ohne Angabe, um den aktuellen Bucket beizubehalten. Der Bucket muss sich im Prozessordner befinden oder für diesen freigegeben sein. Rufen Sie den Schlüssel von uip or buckets list ab. |
Beispiele
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--description "Monthly invoice batch"
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--job-priority High --retention-period 60
# Archive completed jobs to a storage bucket after 60 days
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--retention-action Archive --retention-period 60 \
--retention-bucket b1b2c3d4-0000-0000-0000-000000000001
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--auto-update --output-filter 'Status'
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--description "Monthly invoice batch"
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--job-priority High --retention-period 60
# Archive completed jobs to a storage bucket after 60 days
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--retention-action Archive --retention-period 60 \
--retention-bucket b1b2c3d4-0000-0000-0000-000000000001
uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
--auto-update --output-filter 'Status'
Datenform (--output json)
{
"Code": "ProcessUpdated",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"Status": "Updated successfully"
}
}
{
"Code": "ProcessUpdated",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"Status": "Updated successfully"
}
}
UIP oder Prozesse löschen
Löschen Sie eine Prozessbindung nach Schlüssel. Dadurch wird die Release-Bindung aus ihrem Ordner entfernt – das zugrunde liegende Paket wird dadurch nicht gelöscht.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). Finden Sie es mit processes list. |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
-y | --yes | Markieren | – | Erforderlich. Bestätigt diesen nicht rückgängig zu machenden Vorgang – die CLI fordert Sie nie auf. |
Beispiele
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
Datenform (--output json)
{
"Code": "ProcessDeleted",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"Status": "Deleted successfully"
}
}
{
"Code": "ProcessDeleted",
"Data": {
"Key": "c3d4e5f6-0000-0000-0000-000000000001",
"Name": "InvoiceProcessing",
"ProcessKey": "InvoiceProcessing",
"Status": "Deleted successfully"
}
}
UIP oder Prozess-Rollback
Einen Prozess auf die vorherige Paketversion zurücksetzen. Der Ordner ist optional – wenn er nicht angegeben ist, wird er aus dem Prozessschlüssel abgeleitet.
Argumente
| Name | Erforderlich | Zweck |
|---|---|---|
<process-key> | ja | Prozessschlüssel (GUID). |
Optionen
| Short | Long | Wert | Standard | Beschreibung |
|---|---|---|---|---|
| – | --folder-path | Pfad | abgeleitet | Automatische Erkennung überspringen. |
| – | --folder-key | GUID | abgeleitet | Automatische Erkennung überspringen. |
Beispiele
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
--output-filter 'Status'
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
--folder-path "Shared"
uip or processes rollback c3d4e5f6-0000-0000-0000-000000000001 \
--output-filter 'Status'
Datenform (--output json)
{
"Code": "ProcessRolledBack",
"Data": {
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Status": "Rolled back to previous version"
}
}
{
"Code": "ProcessRolledBack",
"Data": {
"ProcessKey": "c3d4e5f6-0000-0000-0000-000000000001",
"Status": "Rolled back to previous version"
}
}
Exitcodes
Siehe Exitcodes. Keine Verb-spezifischen Überschreibungen über die Standardvalidierungsfehler hinaus.
Zugehörige Befehle
uip or packages– finden Sie Paketschlüssel (packages list), Versionen (packages versions) und Einstiegspunkte (packages entry-points), bevor Sieprocesses createaufrufen.uip or jobs– insbesonderejobs start, für das ein Prozessschlüssel benötigt wird.uip or folders– erstellen oder suchen Sie den Zielordner vor der Bindung.
Siehe auch
- Zusammenfassung
- Verben
- UIP oder Prozessliste
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozesse abrufen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- uip oder Prozessressourcen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozessversionsverlauf
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozesse erstellen
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozessaktualisierungsversion
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozessaktualisierung
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozesse löschen
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- UIP oder Prozess-Rollback
- Argumente
- Optionen
- Beispiele
- Datenform (--output json)
- Exitcodes
- Zugehörige Befehle
- Siehe auch