Ressources de solution uip

Syntaxe et options pour `uip solution resource`, qui gère les ressources d'Orchestrator et de Data Service dont dépend une solution locale.

uip solution resources gère les ressources - files d'attente, ressources, compartiments, processus, connexions, entités, ensembles de choix et autres objets Orchestrator et Data Service - dont dépend une solution locale . Les liaisons de ressources de chaque projet sont agrégées dans la propre liste de ressources de la solution; Utilisez ce groupe de commandes pour l'inspecter, l'ajouter, le modifier ou le synchroniser à nouveau après avoir modifié les liaisons du projet.

Remarque :

Ne pas confondre avec uip or

uip or fournit un CRUD sur les files d'attente, les ressources, les compartiments, etc. du serveur d'Orchestrator sur un locataire actif. uip solution resources inspecte et modifie la liste déclarée de ces ressources de la solution locale — son propre fichier sur le disque, et non le locataire actif. list --source remote et add --source remote appellent Orchestrator pour rechercher, mais le résultat est toujours écrit dans la solution locale.

Synthèse

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

Les six verbes prennent --solution-folder <path> (par défaut vers le répertoire actuel) — aucun ne prend un argument de chemin positionnel.

List

Répertoriez les ressources dans la solution et/ou disponibles dans Orchestrator. Par défaut (--source all), renvoie à la fois les ressources déclarées localement et les ressources signalées par Orchestrator pour le locataire distant associé; lorsque les deux sont répertoriées, une entrée distante correspondant à une entrée locale par Kind:Name (insensible à la casse) est dédupliquée en faveur de l'entrée locale.

Options

Long	Valeur (Value)	Default	Description
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.
--kind	text	—	Filtrez par type de ressource (par exemple Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Tout type d'index du SDK est accepté, il ne s'agit pas d'une énumération fixe.
--search	text	—	Contient une correspondance sur le nom de la ressource.
--source	all | local | remote	all	Quel côté lister.
--include-version	Drapeau	désactivé	Indiquez également la version déployée de chaque ressource pour les types qui en comportent une (app, appVersion, package, process). Coûte un appel supplémentaire par ressource, il est donc désactivé par défaut.
--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples

# 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

Format des données (--sortie 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"
    }
  ]
}

Remarque :

--source remote (et all) nécessite une session authentifiée avec accès à l'instance Orchestrator cible de la solution.

get

Obtenez la configuration d’une ressource de solution par clé — les spécifications, les verrous et les métadonnées tels que le SDK les expose. Si la clé ne se trouve pas dans la solution locale, elle revient à une recherche active d'Orchestrator/de catalogue de ressources afin que la commande soit toujours utile pour les ressources qui ne sont pas encore liées à la solution.

Arguments

Nom	Requis	Objectif
<resource-key>	oui	Clé de ressource de solution — un GUID ou une clé composite comme TestRPA.process.TestRPA:1.0.0 pour les packages.

Options

Long	Valeur (Value)	Default	Description
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.
--include-dependencies	Drapeau	désactivé	Renvoyez également les configurations pour chaque dépendance référencée par la ressource.
--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples

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

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

Format des données (--sortie json)

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

Si la ressource dynamique liée a dérivé de la déclaration locale, la réponse ajoute liveSpec (la spécification dynamique actuelle) à côté de l'obsolescence spec, et resourceOverwrite.matchingOverwriteConfiguration: false:

{
  "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 renvoie Code: "ResourceConfigurations" avec un tableau resources à la place, chaque entrée ajoutant name, kind et dependencies.

Ajouter (Add)

Ajoutez une ressource à la solution. --source local crée un sbut virtuel sans recherche à distance; --source remote importe une ressource Orchestrator existante. Idmpotent: une ressource correspondant au même (kind, name, folder) — ou, sur le chemin distant, à la même clé cloud résolue — est renvoyée inchangée plutôt que dupliquée.

Options

Long	Valeur (Value)	Default	Description
--source	local | remote	—	Requis. local crée un s Robot virtuel; remote importations depuis Orchestrator.
--kind	text	—	Requis. Type de ressource (par exemple Queue, Asset, Bucket, Process, Connection, App, Index, Trigger, Entity, ChoiceSet). Insensible à la casse.
--name	text	—	Requis. Nom de la ressource (256 caractères maximum; ne peut pas contenir de / \ : * ? " < > | caractères de contrôle).
--type	text	—	Sous-type de ressource (par exemple Text/Bool/Integer pour Asset, un type de connecteur pour Connection). Obligatoire pour saisir les index SDK par (kind, type), sauf si résolvable à partir d'une correspondance à distance.
--folder-path	Chemin d'accès	—	Chemin du dossier Orchestrator pour la recherche à distance; dissipe l'ambiguïté lorsqu'il existe plusieurs correspondances à distance. Non valide avec --source local.
--cloud-key	GUID	—	Ignorez la recherche de nom à distance et importez cette clé de ressource exacte. Uniquement valide avec --source remote.
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.
--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Si une recherche de nom à distance correspond à plus d'une ressource, la commande échoue et répertorie le dossier, le type et la clé de chaque candidat afin que vous puissiez désambiguer avec --cloud-key.

Exemples

# 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

Format des données (--sortie 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 est l’un des éléments Added, Updated ou Unchanged (le cas idempotent sans opération).

remove

Supprimer une ressource de la solution par sa clé. Purement local — aucune authentification requise et il ne affecte pas le bindings_v2.json d'un projet.

Arguments

Nom	Requis	Objectif
<resource-key>	oui	Clé de ressource de solution. Utilisez resources list ou resources get pour le découvrir.

Options

Long	Valeur (Value)	Default	Description
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.

Exemples

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

Format des données (--sortie json)

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

Modifier (Edit)

Modifiez les propriétés spécifiques d'une ressource par clé. --patch prend un objet JSON de propriété → valeur, fusionné dans la spécification existante; que le SDK marque comme référence/lecture seule/inconnu sont ignorés en mode silencieux. Les formes de données get et edit correspondent, de sorte qu’un aller-retour → modifier → modifier est simple. --source remote prend les valeurs de la définition Cloud à partir de laquelle la ressource a été importée au lieu de --patch.

Arguments

Nom	Requis	Objectif
<resource-key>	oui	Clé de ressource de solution.

Options

Long	Valeur (Value)	Default	Description
--patch	JSON ou -	—	Objet JSON de la propriété spécifiée → valeur. Transmettez - pour lire plutôt le fichier JSON de stbin.
--source	local | remote	local	D'où proviennent les nouvelles valeurs: --patch (local) ou la définition du cloud (remote).
--force	Drapeau	désactivé	Avec --source remote, écrivez la définition Cloud au-dessus de la définition locale.
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.
--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation. Utilisé uniquement par --source remote.

Exemples

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

Format des données (--sortie json)

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

Avec --source remote et sans --force, la commande n'écrit rien: elle quitte 1 et nomme les propriétés qui diffèrent. Si rien ne diffère, il réussit avec Code: "ResourceRemoteDrift" et Applied: false. Avec --force, la réponse est ResourceEdited, qui porte Changed, Skipped (propriétés, le type de ressource ne permet pas au SDK d'écrire) et Applied: true.

refresh

Analysez à nouveau chaque projet dans la solution et synchronisez les déclarations de ressources à partir de leurs bindings_v2.json fichiers. Les liaisons qui ne sont pas encore créées dans la liste des ressources de la solution; les liaisons correspondant à une ressource Orchestrator existante sont importées; les copies en double des propres projets de la solution dans lesquels une exécution antérieure importée à partir d’un dossier déployé est supprimée. Exécutez cette option après avoir modifié les liaisons du projet afin de rétablir l’inventaire des ressources de la solution.

Options

Long	Valeur (Value)	Default	Description
--solution-folder	Chemin d'accès	Répertoire actuel	Chemin d’accès au dossier racine de la solution.
--login-validity	minutes	10	Nombre minimum de minutes avant l’expiration du jeton pour déclencher une actualisation.

Exemples

uip solution resources refresh

Format des données (--sortie json)

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

Created correspond au nombre de nouvelles ressources de solution; Imported est le nombre correspondant à Orchestrator; Skipped compte les liaisons qui avaient déjà une entrée de solution correspondante; Pruned compte les copies de projet en double supprimées (nommées uniquement dans Status lorsqu'elles sont non nulles). Warnings est une liste de notes lisibles par un humain provenant de la synchronisation (vides lors de l'exécution).

Codes de sortie

Voir Codes de sortie pour le contrat partagé.

Commandes associées

• uip solution pack — l'empaquetage lit la liste des ressources de la solution.
• uip solution deploy — déployer des ressources d'enregistrement sur le locataire cible.
• uip or — l'outil CRUD côté serveur pour les ressources Orchestrator actives.

Voir également

• Options globales — --output, --output-filter, --log-level, --log-file.
• Codes de sortie — contrat de code de sortie standard.