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]

Verben

Verb	Zweck
list	Listen Sie Prozesse in einem Ordner auf.
get	Rufen Sie einen Prozess nach Schlüssel ab, einschließlich Argumentschemas und Aufbewahrung.
resources	List package resources (queues, assets, buckets, connections) required by a process.
version-history	List the chronological package-version history for a process.
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)	Update process settings (PATCH semantics on selected fields).
delete	Delete a process binding by key (does not delete the package).
rollback	Einen Prozess auf die vorherige Paketversion zurücksetzen.

UIP oder Prozessliste

Listen Sie Prozesse in einem Ordner auf. Erfordert --folder-path oder --folder-key. Gibt den Prozessschlüssel (GUID), den Namen, die Version und die grundlegenden Metadaten 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	Tenant-wide listing. Mutually exclusive with --folder-path/--folder-key.
-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 --folder-path "Shared" \
    --output-filter 'Data[].{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,
      "RetentionPeriod": 30,
      "RetentionAction": "Delete"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

FolderId is added to each row only when --all-folders is used.

UIP oder Prozesse abrufen

Rufen Sie einen Prozess nach GUID-Schlüssel ab. Gibt Version, Einstiegspunkt, Eingabe-/Ausgabeargumentschemata, Prozesstyp und Konfiguration zurück. Kein Ordnerkontext erforderlich – der Schlüssel wird ordnerübergreifend aufgelöst.

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	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 'Data.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
  }
}

uip or processes resources

List package resources — queues, assets, buckets, connections, and other package requirements — referenced by a process. Resolves the process's folder automatically; no folder flag needed.

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

Datenform (--output json)

{
  "Code": "ProcessResources",
  "Data": [
    {
      "ResourceType": "Queue",
      "ResourceName": "InvoiceQueue",
      "FolderPath": "Shared",
      "ValidationResult": "Success",
      "ValidationError": "",
      "IsOverwritable": true,
      "ResourceKey": "InvoiceQueue",
      "ResourceId": "123456",
      "Id": 0
    }
  ]
}

uip or processes version-history

List the chronological package-version history associated with a process. Folder is optional — if not provided, it is inferred from the process key.

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

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

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.

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	–	Environment variables as newline-separated KEY=VALUE pairs (not JSON), e.g. $'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.
–	--retention-bucket	Bucket-ID	–	Die ID des Speicher-Buckets. Erforderlich, wenn --retention-action Archive.
–	--stale-retention-period	Tage	–	Aufbewahrungszeitraum für veraltete Aufträge.
–	--stale-retention-action	ENUM	–	Delete, Archive oder None.

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 'Data.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"
  }
}

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 'Data.Version'

Datenform (--output json)

Einzelschlüssel:

{
  "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 or processes update

Update process settings by key. Reads current values, applies the PATCH fields provided, and saves. Only provided fields are changed; fields omitted on the CLI are preserved from the current state. No folder flag needed — the key resolves cross-folder.

edit is a registered alias for this verb — uip or processes edit works identically to 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 Scope-Flags. 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, Archive Aufbewahrung erfordert --retention-bucket).

Short	Long	Wert	Standard	Beschreibung
-n	--name	text	–	Neuer Anzeigename.
-d	--description	text	–	Neue Beschreibung.
–	--entry-point	Pfad	–	Neuer Einstiegspunktpfad.
–	--input-arguments	JSON	–	Standardmäßige Eingabeargumente.
–	--environment-variables	text	–	Newline-separated KEY=VALUE pairs (not JSON). Pass '' to clear them.
–	--job-priority	ENUM	–	Low, Normal, High.
–	--specific-priority	1–100	–	Numerische Priorität.
–	--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	–	Enable or disable Healing Agent (Autopilot for Robots) for this process. Future jobs use it by default once enabled; tenant-level Autopilot must already be on.
–	--retention-period	Tage (1–180)	–	Aufbewahrungszeitraum des Auftrags.
–	--retention-action	ENUM	–	Delete, Archive, None.
–	--retention-bucket	Bucket-ID	–	Erforderlich, wenn --retention-action Archive.
–	--stale-retention-period	Tage	–	Aufbewahrungszeitraum für veraltete Aufträge.
–	--stale-retention-action	ENUM	–	Delete, Archive, None.

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

uip or processes update c3d4e5f6-0000-0000-0000-000000000001 \
    --auto-update --output-filter 'Data.Status'

Datenform (--output json)

{
  "Code": "ProcessUpdated",
  "Data": {
    "Key": "c3d4e5f6-0000-0000-0000-000000000001",
    "Name": "InvoiceProcessing",
    "Status": "Updated successfully"
  }
}

uip or processes delete

Delete a process binding by key. This removes the release binding from its folder — it does not delete the underlying package.

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	–	Required. Confirms this irreversible operation — the CLI never prompts.

Beispiele

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

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 'Data.Status'

Datenform (--output json)

{
  "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 Sie processes create aufrufen.
• uip or jobs – insbesondere jobs start, für das ein Prozessschlüssel benötigt wird.
• uip or folders – erstellen oder suchen Sie den Zielordner vor der Bindung.

Siehe auch

• Globale Optionen.
• Sitzungen.