UIP-Lösungsressourcen

Syntax und Optionen für „UIP-Lösungsressourcen“, die die Orchestrator- und Data Service-Ressourcen verwalten, von denen eine lokale Lösung abhängt.

uip solution resources verwaltet die Ressourcen – Warteschlangen, Assets, Buckets, Prozesse, Verbindungen, Entitäten, Auswahlsätze und andere Orchestrator- und Data Service-Objekte –, von denen eine lokale Lösung abhängt. Die Ressourcenbindungen jedes Projekts werden in der Lösungsbasierten Ressourcenliste aggregiert; Verwenden Sie diese Befehlsgruppe, um sie zu überprüfen, zu ergänzen, zu bearbeiten oder nach der Bearbeitung von Projektbindungen erneut zu synchronisieren.

Hinweis:

Nicht zu verwechseln mit uip or

uip or stellt CRUD über die serverseitigen Warteschlangen, Assets, Buckets usw. von Orchestrator auf einem Live-Mandanten bereit. uip solution resources überprüft und bearbeitet die deklarierte Liste dieser Ressourcen der lokalen Lösung – seine eigene Datei auf dem Datenträger, nicht der Live-Mandant. list --source remote und add --source remote rufen den Orchestrator auf, um nachzuschlagen, aber das Ergebnis wird immer in die lokale Lösung geschrieben.

Zusammenfassung

uip solution resources list      [--solution-folder <path>] [--kind <kind>] [--search <term>] [--source <all|local|remote>] [--include-version] [--login-validity <minutes>]
uip solution resources get       <resource-key> [--solution-folder <path>] [--include-dependencies] [--login-validity <minutes>]
uip solution resources add       --source <local|remote> --kind <kind> --name <name> [--type <type>] [--folder-path <path>] [--cloud-key <guid>] [--solution-folder <path>] [--login-validity <minutes>]
uip solution resources remove    <resource-key> [--solution-folder <path>]
uip solution resources edit      <resource-key> --patch <json> [--solution-folder <path>]
uip solution resources refresh   [--solution-folder <path>] [--login-validity <minutes>]

Alle sechs Verben verwenden --solution-folder <path> (standardmäßig das aktuelle Verzeichnis) – keines akzeptiert ein Positionalpfadargument.

Liste

Listen Sie die Ressourcen in der Lösung und/oder in Orchestrator verfügbar auf. Gibt standardmäßig (--source all) sowohl die lokal deklarierten Ressourcen als auch die Orchestrator-Ressourcen für den zugeordneten Remotemandanten zurück; sind beide aufgeführt, wird ein Remote-Eintrag, der einem lokalen Eintrag nach Kind:Name (keine Beachtung von Groß-/Kleinschreibung) entspricht, zugunsten des lokalen Eintrags dedupliziert.

Optionen

Long	Wert	Standard	Beschreibung
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.
--kind	text	–	Filtern Sie nach Ressourcenart (z. B. Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Jede Art der SDK-Indizes wird akzeptiert – dies ist keine feste Aufzählung.
--search	text	–	Enthält Übereinstimmung für Ressourcennamen.
--source	all | local | remote	all	Welche Seite aufgelistet werden soll.
--include-version	Markieren	aus	Melden Sie auch die bereitgestellte Version jeder Ressource für Arten, die eine enthalten (app, appVersion, package, process). Kosten einen zusätzlichen Aufruf pro Ressource und sind daher standardmäßig deaktiviert.
--login-validity	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

Beispiele

# All resources the current solution knows about
uip solution resources list

# Only queues declared locally
uip solution resources list --kind Queue --source local

# Deployed version per folder for classic Apps
uip solution resources list --kind app --source remote --include-version

Datenform (--output json)

{
  "Code": "ResourceList",
  "Data": [
    {
      "Source": "Remote",
      "Key": "0c2b7f04-1d3e-4a55-9f77-2b1a6d9e4c81",
      "Name": "InvoiceQueue",
      "Kind": "queue",
      "Folder": "Shared"
    },
    {
      "Source": "Remote",
      "Key": "a9c9d05f-6d85-41cd-8a54-a479d494bedc",
      "Name": "Validation App",
      "Kind": "app",
      "Folder": "Shared/Validation",
      "FolderKey": "0932a1f4-5cd1-44d4-9f02-cdc92244a6d2",
      "Version": "12.0.0"
    }
  ]
}

Hinweis:

--source remote (und all) erfordert eine authentifizierte Sitzung mit Zugriff auf den Ziel-Orchestrator der Lösung.

get

Rufen Sie die Konfiguration einer Lösungsressource nach Schlüssel ab – die Spezifikationen, Sperren und Metadaten, wie das SDK sie bereitstellt. Wenn sich der Schlüssel nicht in der lokalen Lösung befindet, wird auf eine Live-Suche im Orchestrator/Ressourcenkatalog zurückgegriffen, sodass der Befehl für Ressourcen, die noch nicht an die Lösung gebunden sind, weiterhin nützlich ist.

Argumente

Name	Erforderlich	Zweck
<resource-key>	ja	Lösungsressourcenschlüssel – eine GUID oder ein zusammengesetzter Schlüssel wie TestRPA.process.TestRPA:1.0.0 für Pakete.

Optionen

Long	Wert	Standard	Beschreibung
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.
--include-dependencies	Markieren	aus	Geben Sie außerdem Konfigurationen für jede Abhängigkeit zurück, auf die die Ressourcenreferenzen verweisen.
--login-validity	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

Beispiele

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f

uip solution resources get fb39bc38-255e-4fea-93c6-7c7eb44d766f \
  --solution-folder ./my-solution --include-dependencies

Datenform (--output json)

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "fb39bc38-255e-4fea-93c6-7c7eb44d766f",
    "spec": { "name": "RPA Workflow", "type": "Process" },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1",
    "isOverridable": true
  }
}

Wenn die verknüpfte Live-Ressource von der lokalen Deklaration abgewichen ist, fügt die Antwort liveSpec (die aktuelle Live-Spezifikation) neben dem veralteten spec und resourceOverwrite.matchingOverwriteConfiguration: false hinzu:

{
  "Code": "ResourceConfiguration",
  "Data": {
    "key": "0f8a1c9e-2b47-4d0a-9c31-5e2f6d8a7b10",
    "spec": { "name": "Approval App", "version": "7.0.0" },
    "liveSpec": { "name": "Approval App", "version": "12.0.0" },
    "resourceOverwrite": { "matchingOverwriteConfiguration": false }
  }
}

--include-dependencies gibt Code: "ResourceConfigurations" stattdessen mit einem resources -Array zurück, wobei jeder Eintrag name, kind und dependencies hinzufügt.

Hinzufügen

Fügen Sie der Lösung eine Ressource hinzu. --source local erstellt einen virtuellen Hub ohne Remotesuche; --source remote importiert eine vorhandene Orchestrator-Ressource. Idempotent: Eine Ressource, die mit derselben (kind, name, folder) übereinstimmt – oder auf dem Remotepfad mit demselben aufgelösten Cloudschlüssel – wird unverändert zurückgegeben, anstatt dupliziert zu werden.

Optionen

Long	Wert	Standard	Beschreibung
--source	local | remote	–	Erforderlich. local erstellt einen virtuellen Hub; remote Importe aus Orchestrator.
--kind	text	–	Erforderlich. Ressourcenart (z. B. Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Groß-/Kleinschreibung wird nicht beachtet.
--name	text	–	Erforderlich. Ressourcenname (max. 256 Zeichen; darf nicht / \ : * ? " < > | oder Steuerzeichen enthalten).
--type	text	–	Ressourcenuntertyp (z. B. Text/Bool/Integer für Asset, ein Connectortyp für Connection). Erforderlich für Arten der SDK-Indizes nach (kind, type), es sei denn, sie können von einer Remoteübereinstimmung aufgelöst werden.
--folder-path	Pfad	–	Orchestrator-Ordnerpfad für die Remotesuche; ist mehrdeutig, wenn mehr als eine Remote-Übereinstimmung vorhanden ist. Nicht gültig mit --source local.
--cloud-key	GUID	–	Überspringen Sie die Suche nach dem Remote-Namen und importieren Sie genau diesen Ressourcenschlüssel. Nur mit --source remote gültig.
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.
--login-validity	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

Wenn eine Remote-Namensuche mit mehr als einer Ressource übereinstimmt, schlägt der Befehl fehl und listet den Ordner, den Typ und den Schlüssel jedes Kandidaten auf, sodass Sie ihn mit --cloud-key unterscheiden können.

Beispiele

# Create a local virtual stub (no remote lookup)
uip solution resources add --source local --kind Queue --name InvoiceQueue

# Import an existing remote queue, disambiguated by folder path
uip solution resources add --source remote --kind Queue --name InvoiceQueue \
  --folder-path Sales/CRM

Datenform (--output json)

{
  "Code": "ResourceAdded",
  "Data": {
    "Key": "8f3a1b2c-0000-0000-0000-000000000001",
    "Kind": "queue",
    "Type": null,
    "Name": "InvoiceQueue",
    "Folder": "solution_folder",
    "FolderKey": "5c2d61f4-0000-0000-0000-000000000001",
    "Source": "local",
    "Status": "Added"
  }
}

Status ist einer von Added, Updated oder Unchanged (der idempotente No-Op-Fall).

remove

Entfernen Sie eine Ressource anhand ihres Schlüssels aus der Lösung. Rein lokal – keine Authentifizierung erforderlich und der bindings_v2.json eines Projekts wird nicht beeinträchtigt.

Argumente

Name	Erforderlich	Zweck
<resource-key>	ja	Lösungsressourcenschlüssel (GUID). Verwenden Sie resources list oder resources get, um ihn zu erkennen.

Optionen

Long	Wert	Standard	Beschreibung
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.

Beispiele

uip solution resources remove 8f3a1b2c-1234-4abc-9def-0123456789ab

Datenform (--output json)

{
  "Code": "ResourceRemoved",
  "Data": {
    "Key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "Kind": "queue",
    "Name": "InvoiceQueue",
    "Folder": "solution_folder"
  }
}

Bearbeiten

Bearbeiten Sie die Spezifikationseigenschaften einer Ressource nach Schlüssel. --patch nimmt ein JSON-Objekt von Eigenschaft → Wert, das in die vorhandene Spezifikation zusammengeführt wird; Eigenschaften, die das SDK als Referenz/schreibgeschützt/unbekannt markiert, werden im Hintergrund ignoriert. Die Datenstrukturen get und edit stimmen überein, sodass ein Round Trip „Abrufen → Ändern → Bearbeiten“ direkt möglich ist. --source remote übernimmt die Werte aus der Clouddefinition, aus der die Ressource importiert wurde, anstelle von --patch.

Argumente

Name	Erforderlich	Zweck
<resource-key>	ja	Lösungsressourcenschlüssel (GUID).

Optionen

Long	Wert	Standard	Beschreibung
--patch	JSON oder -	–	JSON-Objekt der Spezifikationseigenschaft → Wert. Übergeben Sie stattdessen -, um die JSON aus „stin“ zu lesen.
--source	local | remote	local	Woher die neuen Werte stammen: --patch (local) oder die Clouddefinition (remote).
--force	Markieren	aus	Schreiben Sie mit --source remote die Cloud-Definition über die lokale.
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.
--login-validity	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen. Wird nur von --source remote verwendet.

Beispiele

uip solution resources edit 8f3a1b2c-1234-4abc-9def-0123456789ab \
  --patch '{"maxNumberOfRetries":5}'

# Pipeline-friendly: patch from stdin
echo '{"slaInHours":"4"}' | uip solution resources edit 8f3a1b2c-... --patch -

# Pull the cloud definition: report the differences, then overwrite
uip solution resources edit 8f3a1b2c-... --source remote
uip solution resources edit 8f3a1b2c-... --source remote --force

Datenform (--output json)

{
  "Code": "ResourceEdited",
  "Data": {
    "key": "8f3a1b2c-1234-4abc-9def-0123456789ab",
    "spec": { "name": "InvoiceQueue", "maxNumberOfRetries": 5 },
    "locks": [],
    "apiVersion": "orchestrator.uipath.com/v1"
  }
}

Mit --source remote und keinem --force schreibt der Befehl nichts: Er beendet 1 und benennt die unterschiedlichen Eigenschaften. Wenn sich nichts unterscheidet, ist der Vorgang mit Code: "ResourceRemoteDrift" und Applied: false erfolgreich. Mit --force ist die Antwort ResourceEdited und enthält Changed, Skipped (Eigenschaften, die die Ressourcenart das SDK nicht schreiben lässt) und Applied: true.

refresh

Scannen Sie jedes Projekt in der Lösung erneut und synchronisieren Sie die Ressourcendeklarationen aus ihren bindings_v2.json -Dateien. Bindungen, die noch nicht in der Ressourcenliste der Lösung enthalten sind, werden erstellt; Bindungen, die einer vorhandenen Orchestrator-Ressource entsprechen, werden importiert; doppelte Kopien der eigenen Projekte der Lösung, die eine frühere Ausführung aus einem bereitgestellten Ordner importiert hat, bereinigt werden. Führen Sie dies aus, nachdem Sie Projektbindungen bearbeitet haben, um den Ressourcenbestand der Lösung wieder in Betrieb zu bringen.

Optionen

Long	Wert	Standard	Beschreibung
--solution-folder	Pfad	aktuelles Verzeichnis	Pfad zum Lösungsstammordner.
--login-validity	Minuten	10	Mindestens Minuten vor dem Tokenablauf, um eine Aktualisierung auszulösen.

Beispiele

uip solution resources refresh

Datenform (--output json)

{
  "Code": "ResourceRefresh",
  "Data": {
    "Created": 2,
    "Imported": 1,
    "Skipped": 5,
    "Pruned": 0,
    "Warnings": [],
    "Status": "Synced 3 resources (5 already in solution)"
  }
}

Created ist die Anzahl der brandneuen Lösungsressourcen; Imported ist die Anzahl, die mit dem Orchestrator abgeglichen wird; Skipped zählt Bindungen, die bereits einen übereinstimmenden Lösungseintrag hatten; Pruned zählt doppelte Projektkopien entfernt (nur in Status benannt, wenn nicht Null). Warnings ist eine Liste von visuell lesbaren Hinweisen aus der Synchronisierung (bei einer Neuausführung leer).

Exitcodes

Siehe Austrittscodes für den gemeinsamen Vertrag.

Zugehörige Befehle

• uip solution pack – Das Verpacken liest die Ressourcenliste der Lösung.
• uip solution deploy – Bereitstellung von Ressourcen auf dem Zielmandanten.
• uip or – das serverseitige CRUD-Tool für Live-Orchestrator-Ressourcen.

Siehe auch

• Globale Optionen – --output, --output-filter, --log-level, --log-file.
• Austrittscodes – Standard-Austrittscode-Vertrag.