Bereitstellung der UIP-Lösung

uip solution deploy nimmt ein veröffentlichtes Lösungspaket (siehe uip solution publish) und installiert es in Orchestrator: Erstellt einen Ordner, stellt Ressourcen (Warteschlangen, Assets, Prozesse, Buckets, Verbindungen) bereit und aktiviert die Bereitstellung.

Diese Seite deckt jeden Unterbefehl unter deploy sowie die oberste Ebene uip solution delete ab, die Studio Web-Lösungen (keine Bereitstellungen) verwaltet.

Unterbefehl	Zweck
run	Stellen Sie ein veröffentlichtes Paket in Orchestrator bereit.
status	Überprüfen Sie den Status einer Pipelinebereitstellung.
list	Listen Sie Vorhandene Bereitstellungen auf.
activate	Aktivieren Sie eine Bereitstellung, die ohne automatische Aktivierung installiert wurde.
uninstall	Eine Bereitstellung und ihre bereitgestellten Ressourcen entfernen.
config get	Rufen Sie die Standardbereitstellungskonfiguration für ein Paket ab.
config set	Legen Sie eine Ressourceneigenschaft in einer Bereitstellungskonfigurationsdatei fest.
config link	Verknüpfen Sie eine Lösungsressource mit einer vorhandenen Orchestrator-Ressource.
config unlink	Entfernen Sie einen Ressourcenlink aus einer Bereitstellungskonfigurationsdatei.

Außerdem auf dieser Seite dokumentiert:

• uip solution delete – ein Verb auf höchster Ebene, das eine Lösung nach ID aus Studio Web löscht. Es ist kein Bereitstellungsunterbefehl; sie wird zusammen mit diesen Befehlen aus Gruppierungsgründen dokumentiert.

Jeder Unterbefehl ist authentifiziert. Führen Sie zuerst uip login aus, oder übergeben Sie --tenant um einen bestimmten Mandanten anzuvisieren.

Typischer Workflow

deploy config get  →  deploy config set / link  →  deploy run  →  deploy status
                                                       │
                                                       ├─→ deploy activate   (if not auto-activated)
                                                       └─→ deploy uninstall  (tear down)

---

Ausführung der Bereitstellung der UIP-Lösung

Stellen Sie ein veröffentlichtes Lösungspaket in Orchestrator bereit. Erstellt einen neuen Ordner (unter --folder-path oder --folder-key), stellt jede Ressource bereit, die im Paket (oder in --config-file) beschrieben ist, und fragt ab, bis die Bereitstellung einen Endstatus erreicht.

Zusammenfassung

uip solution deploy run \
  --name <deployment-name> \
  --package-name <name> \
  --package-version <version> \
  --folder-name <name> \
  [--folder-path <path> | --folder-key <guid>] \
  [--config-file <path>] \
  [--tenant <tenant-name>] \
  [--timeout <seconds>] \
  [--poll-interval <ms>] \
  [--login-validity <minutes>]

Optionen

• -n, --name <deployment-name> (erforderlich) – Name für die Bereitstellung. Wird von deploy status, activate und uninstall verwendet, um diese Installation zu identifizieren.
• --package-name <name> (erforderlich) – Name des Lösungspakets. Verwenden Sie packages list , um verfügbare Namen zu finden.
• --package-version <version> (erforderlich) – Version des Lösungspakets. Verwenden Sie packages list , um verfügbare Versionen zu finden.
• --folder-name <name> (erforderlich) – Name des neuen Orchestrator-Ordners, der für diese Bereitstellung erstellt wurde (unter --folder-path).
• --folder-path <path> – Übergeordneter Ordnerpfad (z. B. Shared). Der Bereitstellungsordner wird darunter erstellt.
• --folder-key <key> – Übergeordneter Ordnerschlüssel (GUID). Alternative zu --folder-path.
• --config-file <path> – JSON-Konfigurationsdatei. Generieren Sie es mit deploy config get, bearbeiten Sie es mit config set / config link und übergeben Sie es dann hier.
• -t, --tenant <tenant-name> – Mandant, in dem bereitgestellt werden soll.
• --timeout <seconds> – Timeout bei der Bereitstellung. Die Standardeinstellung ist 360.
• --poll-interval <ms> – Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist 5000.
• --login-validity <minutes> – Mindestens Minuten vor dem Ablauf des Tokens, um eine Aktualisierung auszulösen. Die Standardeinstellung ist 10.

Beispiele

Allgemein

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared"

Mit einer benutzerdefinierten Konfiguration

uip solution deploy config get my-package -d ./deploy-config.json
uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

uip solution deploy run \
  --name my-deployment \
  --package-name my-package \
  --package-version 1.0.0 \
  --folder-name MySolution \
  --folder-path "Shared" \
  --config-file ./deploy-config.json

Skripting – Erfassen Sie die Bereitstellungs-ID für Folgeaufrufe

PIPELINE_ID=$(uip solution deploy run \
  --name my-deployment \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution --folder-path "Shared" \
  --output-filter "Data.PipelineDeploymentId" --output plain)

uip solution deploy status "$PIPELINE_ID"

Datenform (--output json)

{
  "Code": "SolutionDeployRun",
  "Data": {
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "FolderName": "MySolution",
    "FolderPath": "Shared/MySolution"
  }
}

Terminalbereitstellungsstatus: DeploymentSucceeded, DeploymentFailed, ValidationFailed, ConflictFixingError, DeploymentScheduleError. Nicht erfolgreiche Endzustände werden mit 1 beendet und fassen die Validierungs-/Konflikt-/Zeitplan-/Workflow-Fehler im Feld Instructions zusammen.

Timeout-Verhalten

Wenn die Bereitstellung keinen Endstatus erreicht, bevor --timeout abläuft, wird der Befehl ungleich Null mit einem Verweis auf deploy status <pipeline-deployment-id> beendet, sodass Sie die Überwachung fortsetzen können.

---

Bereitstellungsstatus der UIP-Lösung

Überprüfen Sie den aktuellen Status einer Pipelinebereitstellung. Gibt den Bereitstellungsstatus und, falls verfügbar, den Namen/das Paket/die Version der Bereitstellung sowie eine verkettete Fehlerzusammenfassung zurück.

Argumente

• <pipeline-deployment-id> (erforderlich) – Der von PipelineDeploymentId zurückgegebene deploy run.

Optionen

• -t, --tenant <tenant-name> – Der abzufragende Mandant.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy status b2c3d4e5-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "SolutionDeployStatus",
  "Data": {
    "PipelineDeploymentId": "b2c3d4e5-0000-0000-0000-000000000001",
    "Status": "DeploymentSucceeded",
    "DeploymentKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "ConfigurationKey": "...",
    "InstanceId": "c3d4e5f6-0000-0000-0000-000000000001",
    "DeploymentResult": {
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "Status": "Successful",
      "StartDate": "2026-04-15T10:30:00Z",
      "EndDate": "2026-04-15T10:31:12Z",
      "Errors": null
    }
  }
}

---

Bereitstellungsliste der UIP-Lösung

Listen Sie Lösungsbereitstellungen auf. Zeigt Bereitstellungsname, Status, Paketversion und Ordnerpfad an.

Optionen

• -t, --tenant <tenant-name> – Der abzufragende Mandant.
• --folder-path <path> – Filtern nach dem Pfad des übergeordneten Ordners. Die Filterung wird nach dem Abrufen angewendet; Erhöhen Sie --take wenn die Ergebnisse bei Verwendung dieses Filters unvollständig erscheinen.
• --folder-key <key> – Filtern nach übergeordnetem Ordnerschlüssel (GUID). Alternative zu --folder-path.
• --take <number> – Max. abzurufende Bereitstellungen. Die Standardeinstellung ist 10.
• --order-by <column> – Spalte, nach der sortiert werden soll. Die Standardeinstellung ist startTime.
• --order-direction <direction> – Ascending oder Descending. Standardmäßig auf Descending.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy list --take 20 --folder-path "Shared/Production"

Datenform (--output json)

{
  "Code": "SolutionDeployList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "InstallDeploymentKey": "…",
      "Name": "my-deployment",
      "PackageName": "my-package",
      "PackageVersion": "1.0.0",
      "OperationStatus": "Successful",
      "ActivationStatus": "Activated",
      "FolderPath": "Shared/Production",
      "FolderKey": "…",
      "CreatedAt": "2026-04-15T10:30:00Z"
    }
  ]
}

---

Aktivierung der Bereitstellung der UIP-Lösung

Aktivieren Sie eine Bereitstellung, die ohne automatische Aktivierung installiert wurde. Die Aktivierung stellt alle Lösungskomponenten bereit. activate gibt zuerst die von Orchestrator gemeldeten Voraktivierungsschritte aus (an ständigrr, über --log-level info), dann aktiviert es und ruft bis zu einem Endstatus (SuccessfulActivate oder FailedActivate) auf.

Argumente

• <deployment-name> (erforderlich) – Name der zu aktivierenden Bereitstellung. Verwenden Sie deploy list um Bereitstellungsnamen zu finden.

Optionen

• -t, --tenant <tenant-name> – Mandant zum Ziel.
• --timeout <seconds> – Timeout bei Aktivierungsabfrage. Die Standardeinstellung ist 360.
• --poll-interval <ms> – Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist 5000.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy activate my-deployment

Datenform (--output json)

{
  "Code": "SolutionDeployActivate",
  "Data": {
    "Status": "SuccessfulActivate",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Wenn der Orchestrator kein instanceId (nichts abzurufen) meldet, ist Status Activation completed (no instance to poll) und der Befehl wird erfolgreich zurückgegeben.

---

Deinstallation der UIP-Lösung – Bereitstellung

Deinstallieren Sie eine bereitgestellte Lösung. Entfernt alle bereitgestellten Ressourcen und den Lösungsordner.

Argumente

• <deployment-name> (erforderlich) – Name der zu deinstallierenden Bereitstellung.

Optionen

• -t, --tenant <tenant-name> – Mandant zum Ziel.
• --timeout <seconds> – Deinstallieren des Timeouts für Abrufe. Die Standardeinstellung ist 360.
• --poll-interval <ms> – Millisekunden zwischen Statusabfragen. Die Standardeinstellung ist 5000.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy uninstall my-deployment

Datenform (--output json)

{
  "Code": "SolutionDeployUninstall",
  "Data": {
    "Status": "SuccessfulUninstall",
    "DeploymentName": "my-deployment",
    "InstanceId": "b2c3d4e5-0000-0000-0000-000000000001"
  }
}

Es sind zwei Kurzschließen-Antworten möglich:

• Uninstall completed immediately – Wenn der Orchestrator complete: true beim ersten Aufruf meldet; Es finden keine Abrufe.
• Uninstall scheduled – Wenn der Orchestrator die Arbeit plant, ohne eine Instanz-ID zurückzugeben; die Daten das Scheduled -Feld aus der API enthalten.

---

Abrufen der Konfigurationsbereitstellung für die UIP-Lösung

Rufen Sie die Standardbereitstellungskonfiguration für ein veröffentlichtes Lösungspaket ab. Die Konfiguration listet jede Ressource auf, die die Lösung erstellt (Warteschlangen, Assets, Prozesse, Buckets, Verbindungen, …) mit ihren Standardeinstellungen. Speichern Sie es in einer Datei (-d), passen Sie mit config set / config link an und übergeben Sie es dann an deploy run --config-file.

Argumente

• <package-name> (erforderlich) – Name des Lösungspakets. Verwenden Sie packages list.

Optionen

• --package-version <version> – Paketversion. Wenn keine Angabe erfolgt, wird die aktuelle Version verwendet.
• -d, --destination <path> – Schreiben Sie die Konfiguration in diese Datei anstelle von „stdout“.
• -t, --tenant <tenant-name> – Der abzufragende Mandant.
• --login-validity <minutes> – Standardmäßig auf 10.

Beispiel

uip solution deploy config get my-package --package-version 1.0.0 -d ./deploy-config.json

Datenform (--output json)

Wenn -d angegeben ist:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "Status": "Configuration written",
    "OutputPath": "/workspace/deploy-config.json",
    "PackageName": "my-package"
  }
}

Wenn -d weggelassen wird, ist die Konfiguration in die Antwort eingebettet:

{
  "Code": "SolutionDeployConfig",
  "Data": {
    "PackageName": "my-package",
    "Configuration": { "resources": [ ... ] }
  }
}

---

Konfigurationssatz für die Bereitstellung der UIP-Lösung

Bearbeiten Sie eine Ressourceneigenschaft in einer Bereitstellungskonfigurationsdatei. Die Datei bleibt lokal, bis Sie sie an deploy run --config-file übergeben.

Argumente

• <file> (erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration (erstellt von config get).
• <args...> (erforderlich) – Hängt von --all ab:
  • Ohne --all: <resource> <property> <value> – z. B MyQueue maxNumberOfRetries 5.
  • Mit --all: <property> <value> – gilt für jede Ressource in der Datei. Nur für die Eigenschaft conflictFixingAction der obersten Ebene gültig.

Optionen

• --all – Wenden Sie die Eigenschaft auf alle Ressourcen in der Datei an. Nur mit conflictFixingAction zulässig (z. B UseExisting).

Beispiele

Ändern Sie Wiederholungen für eine einzelne Warteschlange

uip solution deploy config set ./deploy-config.json MyQueue maxNumberOfRetries 5

Legen Sie für jede Ressource eine Richtlinie zur Konfliktbehebung fest

uip solution deploy config set ./deploy-config.json --all conflictFixingAction UseExisting

Datenform (--output json)

Aktualisierung einer einzigen Ressource:

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "MyQueue",
    "Property": "maxNumberOfRetries",
    "OldValue": 1,
    "NewValue": 5
  }
}

Massenaktualisierung (--all):

{
  "Code": "DeployConfigSet",
  "Data": {
    "Resource": "all",
    "Property": "conflictFixingAction",
    "NewValue": "UseExisting",
    "ResourceCount": 12
  }
}

---

Konfigurationslink zur Bereitstellung der UIP-Lösung

Verknüpfen Sie eine Lösungsressource mit einer vorhandenen Orchestrator-Ressource, sodass die Bereitstellung sie wiederverwendet, anstatt eine neue zu erstellen. Änderungen sind lokal – wenden Sie sie an, indem Sie die Datei an deploy run --config-file übergeben.

Argumente

• <file> (erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration.
• <resource> (erforderlich) – Ressourcenname oder resourceKey aus der Konfigurationsdatei.

Optionen

• -n, --name <name> (erforderlich) – Name der vorhandenen Orchestrator-Ressource, mit der verknüpft werden soll.
• --folder-path <path> – Orchestrator-Ordnerpfad, in dem sich die vorhandene Ressource befindet.

Beispiel

uip solution deploy config link ./deploy-config.json MyQueue \
  --name ProductionQueue \
  --folder-path "Shared/Production"

Datenform (--output json)

{
  "Code": "DeployConfigLink",
  "Data": {
    "Resource": "MyQueue",
    "LinkedTo": {
      "name": "ProductionQueue",
      "folderPath": "Shared/Production"
    }
  }
}

---

Link zur Bereitstellung der UIP-Lösungsbereitstellung aufheben

Entfernen Sie einen Link, der zuvor mit config link festgelegt wurde. Beim nächsten deploy run --config-file wird die Ressource neu erstellt anstatt wiederverwendet.

Argumente

• <file> (erforderlich) – Der Pfad zur JSON-Datei zur Bereitstellungskonfiguration.
• <resource> (erforderlich) – Ressourcenname oder resourceKey zum Aufheben der Verknüpfung.

Beispiel

uip solution deploy config unlink ./deploy-config.json MyQueue

Datenform (--output json)

{
  "Code": "DeployConfigUnlink",
  "Data": {
    "Resource": "MyQueue",
    "UnlinkedFrom": "ProductionQueue"
  }
}

Fehlermodi

• Ressource ist derzeit nicht verknüpft. Der Befehl abgelehnt das Aufheben der Verknüpfung und verweist auf config link.

---

UIP-Lösung löschen

uip solution delete ist ein Verb auf höchster Ebene (kein deploy -Unterbefehl), das eine Lösung anhand ihrer Lösungs-ID aus Studio Web löscht. Die ID wird von uip solution upload und von flow debug in ihrer Ausgabe ausgegeben.

Eine bereitgestellte Lösung wird dadurch nicht aus dem Orchestrator deinstalliert – verwenden Sie deploy uninstall dafür.

Zusammenfassung

uip solution delete <solution-id>

Argumente

• <solution-id> (erforderlich) – Die Studio Web-Lösungs-ID (UUID).

Beispiel

uip solution delete a1b2c3d4-0000-0000-0000-000000000001

Datenform (--output json)

{
  "Code": "SolutionDelete",
  "Data": {
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001"
  }
}

---

Zugehörige Befehle

• uip solution publish – erforderlicher Schritt vor deploy run.
• uip solution packages list – Paketnamen und -versionen erkennen.
• uip resource – Überprüfen oder erstellen Sie die Orchestrator-Ressourcen, auf die deploy config link verweist.

Siehe auch

• Ihre erste Pipeline – Packen → Veröffentlichen → Bereitstellen.
• Authentifizierung und Konfiguration – Sitzungseinrichtung und Standardeinstellungen pro Mandant.
• uip solution Übersicht.