- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Utilisation de la UiPath CLI
- Guides pratiques
- Revenus CI/CD
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Options globales
- agent codé uip
- encodeur UIP
- uip ancrage dans le contexte
- UiPath Docsai
- Fonction UiP
- garde-fous UiP
- configuration llm uip
- uip llm-passerelle
- Création uip maestro
- Registre Maestro uip
- uip model-hub
- Tâches (Jobs)
- Dossiers
- Processus
- ROI du processus
- Paquets
- Machines
- Utilisateurs
- Rôles
- Licences
- Flux
- Pièces jointes (Attachments)
- Sessions
- Calendriers
- magasins d'informations d’identification
- journaux-audit
- paramètres
- Actifs
- Compartiments
- Compartiment-fichiers
- Bibliothèques
- Files d'attente (Queues)
- ROI de la file d'attente
- éléments de la file d'attente
- Déclencheurs (Triggers)
- Webhooks
- Activités - Rechercher
- activités get-Default-xaml
- Analyser
- liste règles-analyseurs
- Construire
- Nettoyage
- Installation de entités data-fabrics
- liste des entités data-fabrics
- Diff de fichiers
- Get-Library-Object-Repository
- Récupérer le référentiel d'objets
- Init
- liste des instances
- Créer un package
- Vérification des paquets
- Installation des paquets
- Versions de paquets
- Publier
- Distant
- restore
- exécuter, déboguer et amp; Exécution
- paramètres
- Début de Studio
- Recherche de modèles
- entité ajoutée aux données de test
- Ajouter une file d'attente de données de test
- variation d'ajout de données de test
- TM
- UIA
- Valider
- exemples de workflow - Obtenir
- liste d'exemples de workflow
- tâches UIP
- pièce jointe
- Champ personnalisé
- Défauts (Defects)
- Exécutions
- exporter-tâches
- Migration
- Libellé Objet
- Créer un package
- scénarios-perf
- groupes-de-charge-scénarios-perf
- données d’exécution de perf-scenario
- rapport de scénarios de performances
- Projet
- autorisations-projet
- Invites
- Rapport
- Prérequis
- Résultat
- Exécuter
- Planifications (Schedules)
- Journaux de cas de test
- Cas de test
- Ensembles de tests
- Journal des étapes de test
- Utilisateur (User)
- Attendre
- Traçages UIP
- Commentaires sur les traces UIP
- Migration
- Référence et assistance
UIP ou processus
Syntaxe et options pour `uip ou processes`, qui gère la liaison de dossiers des packages aux processus exécutables dans Orchestrator.
uip or processes gère les liaisons exécutables des packages aux dossiers - ce qu'Orchestrator appelle en interne Versions. Un processus est ce que uip or jobs start cible; un package est l'artefact .nupkg sous-jacent (voir uip or packages).
Synthèse
uip or processes <verb> [options]
uip or processes <verb> [options]
Verbes
| Verbe | Objectif |
|---|---|
list | Répertoriez les processus dans un dossier ou dans chaque dossier du locataire. |
get | Récupérez un processus par clé, y compris les schémas d'arguments et la rétention. |
resources | Répertoriez les ressources de package (files d'attente, ressources, compartiments, connexions) requises par un processus. |
version-history | Répertorie l'historique chronologique des versions de packages d'un processus. |
create | Liez un package à un dossier en tant que nouveau processus. |
update-version | Déplacez un ou plusieurs processus vers la dernière version (ou une version spécifique) du paquet. |
update (alias edit) | Mettre à jour les paramètres du processus (sémantique PATCH sur les champs sélectionnés). |
delete | Supprimer une liaison de processus par clé (ne supprime pas le package). |
rollback | Rétablir la version de package précédente d'un processus. |
liste des processus ou UiP
Répertoriez les processus dans un dossier (--folder-path ou --folder-key), ou dans chaque dossier du locataire avec --all-folders. Renvoie la clé du processus, le nom, la version, le dossier et les paramètres de rétention.
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | — | Dossier cible par chemin. |
| — | --folder-key | GUID | — | Dossier cible par clé. |
| — | --all-folders | Drapeau | désactivé | Liste à l'échelle du locataire. Capture mutuellement exclusive avec --folder-path/--folder-key. |
-n | --name | text | — | Contient une correspondance sur le nom du processus. |
| — | --process-type | ENUM | — | Process, Agent, Flow, TestAutomationProcess, WebApp, Api, MCPServer, BusinessRules, CaseManagement, Function |
| — | --all-fields | Drapeau | désactivé | Renvoyez la charge utile complète de l'API. |
-l | --limit | Numérique | 50 | Taille de la page. |
| — | --offset | Numérique | 0 | Nombre d'ignorers. |
| — | --sort-by | Champ | Id desc | Tri OData. |
Exemples
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"
Format des données (--sortie 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 est ajouté à chaque ligne uniquement lorsque --all-folders est utilisé.
uip ou processus obtenir
Fetch one process by GUID key. Returns version, entry point, input/output argument schemas, process type, and configuration. The key resolves tenant-wide by default. Pass --folder-path or --folder-key to scope the lookup to one folder, which an identity with access to a single folder only (such as an external app) requires.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. Recherchez-le avec processes list. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | — | Étenduez la recherche à ce dossier au lieu de résoudre la clé à l’échelle du locataire. |
| — | --folder-key | GUID | — | Étenduez la recherche à ce dossier au lieu de résoudre la clé à l’échelle du locataire. |
| — | --all-fields | Drapeau | désactivé | Renvoyez la charge utile complète de l'API. |
Exemples
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'
Format des données (--sortie 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
}
}
ressources de l’interface utilisateur ou des processus
Répertoriez les ressources du package (files d'attente, ressources, compartiments, connexions et autres exigences du package) référencées par un processus. Résout automatiquement le dossier du processus; aucun indicateur de dossier nécessaire.
ResourceName, FolderPath et ResourceId rapportent ce que le package déclare. Lorsque le processus lie une ressource à une cible différente, IsOverwritten est true et les champs Overwrite* décrivent la cible à laquelle le processus se lie:
| Champ | Description |
|---|---|
IsOverwritten | true lorsque le processus lie la ressource; false dans le cas contraire. |
OverwriteName | Display name of the target resource. Empty when the resource is not rebound. |
OverwriteEntityId | Orchestrator ID of the target resource. Empty when the resource is not rebound. |
OverwriteFolderId | ID of the folder that holds the target resource. null when the resource is not rebound. |
OverwriteProperties | Property name/value pairs that define the target, for example name and folderPath. Keys are returned exactly as Orchestrator stores them. {} when the resource is not rebound. |
With --all-fields, each row carries the raw API resource plus an Overwrite object (null when the resource is not rebound).
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. Recherchez-le avec processes list. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --all-fields | Drapeau | désactivé | Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné. |
Exemples
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
Format des données (--sortie 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": {}
}
]
}
Une ressource que le processus renvoie à un dossier différent:
{
"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 ou process historique des versions
Répertorie l'historique chronologique des versions de package associé à un processus. Le dossier est facultatif — s'il n'est pas fourni, il est déduit de la clé du processus.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | déduit | Ignorez la détection automatique et utilisez ce dossier. |
| — | --folder-key | GUID | déduit | Ignorez la détection automatique et utilisez ce dossier. |
| — | --all-fields | Drapeau | désactivé | Renvoyez la charge utile complète de l'API au lieu du résumé sélectionné. |
Exemples
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
uip or processes version-history c3d4e5f6-0000-0000-0000-000000000001
Format des données (--sortie 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 ou processus créer
Liez un package à un dossier en tant que processus. Nécessite --folder-path ou --folder-key et trois options de package requises. Utilisez uip or packages list pour la clé de package et uip or packages versions pour les versions disponibles.
La rétention de la tâche est définie par défaut sur Delete après 30 jours. Pour archiver les tâches à la place, transmettez --retention-action Archive avec --retention-bucket <bucket-key>. Pour archiver les tâches obsolètes, transmettez --stale-retention-action Archive avec --stale-retention-period <days> et --stale-retention-bucket <bucket-key>.
Options
Requis
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --name | text | — | Nom du processus dans le dossier. |
| — | --package-key | text | — | Clé de package (le PackageId de packages list). |
| — | --package-version | version | — | Version du package (par exemple, 1.0.0). |
Identité et étendue
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | — | Dossier cible par chemin. |
| — | --folder-key | GUID | — | Dossier cible par clé. |
Paramètres du projet
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --description | text | — | Description du processus. |
| — | --entry-point | Chemin d'accès | — | Chemin d'accès au workflow avec le point d'entrée (pour les packages multi-points d'entrée). |
| — | --input-arguments | JSON | — | Les arguments d’entrée par défaut au format JSON. |
| — | --job-priority | ENUM | — | Low, Normal, High Capture mutuellement exclusive avec --specific-priority |
| — | --specific-priority | 1 à 100 | — | Priorité numérique. Capture mutuellement exclusive avec --job-priority |
| — | --robot-size | ENUM | — | Taille du robot cloud: Small, Standard, Medium, Large. |
| — | --tags | CSV | — | Noms de balises séparés par des virgules. |
| — | --environment-variables | text | — | Variables d'environnement sous forme de paires KEY=VALUE séparées par des retours (non JSON), par exemple $'FOO=bar\nBAZ=qux'. |
| — | --auto-update / --no-auto-update | Drapeau | — | Activez/désactivez la mise à jour automatique vers la dernière version du package. |
| — | --hidden-for-attended / --visible-for-attended | Drapeau | — | Masquez ou affichez les utilisateurs Attended. Captures mutuellement exclusives. |
| — | --auto-create-triggers / --no-auto-create-triggers | Drapeau | — | Créez automatiquement des déclencheurs connectés lors du déploiement. |
Rétention
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --retention-period | jours (1 à 180) | 30 | Période de rétention de la tâche. |
| — | --retention-action | ENUM | Delete | Delete, Archive, or None. Archive requires --retention-bucket. |
| — | --retention-bucket | clé de compartiment | — | Clé de compartiment de stockage pour les tâches archivées. Obligatoire lorsque --retention-action est Archive et rejeté pour Delete ou None. Le compartiment doit se trouver dans le dossier de processus ou partagé avec celui-ci. Obtenez la clé de uip or buckets list. |
| — | --stale-retention-period | jours | 180 pour Delete/None | Période de rétention de la tâche obsolète. Nécessite --stale-retention-action. Requis lorsque l'action obsolète est Archive. |
| — | --stale-retention-action | ENUM | — | Delete, Archive, or None. Archive requires --stale-retention-bucket. |
| — | --stale-retention-bucket | clé de compartiment | — | Clé de compartiment de stockage pour les tâches obsolètes archivées. Requis lorsque la --stale-retention-action est Archive. Le compartiment doit se trouver dans le dossier de processus ou partagé avec celui-ci. Obtenez la clé de uip or buckets list. |
Exemples
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'
Format des données (--sortie 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 ou processus update-version
Mettez à jour un ou plusieurs processus vers la dernière version du package ou vers une version spécifique avec --package-version. Le dossier est facultatif; si ce champ n'est pas indiqué, il est déduit de la première clé de processus.
- Une clé + non
--package-version→ mettre à jour vers la dernière version (appel d'API unique). - Une clé +
--package-version→ mettre à jour vers cette version (appel d'API unique). - Plusieurs clés + aucune
--package-version→ mise à jour groupée vers la dernière. - Clés multiples +
--package-version→ rejetées (erreur de validation).
Les tâches en cours d'exécution ne sont pas affectées; seules les nouvelles tâches utilisent la version mise à jour.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-keys...> | oui | Une ou plusieurs clés de processus. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | déduit | Ignorez la détection automatique et utilisez ce dossier. |
| — | --folder-key | GUID | déduit | Ignorez la détection automatique et utilisez ce dossier. |
| — | --package-version | version | — | Version spécifique. Uniquement valide avec une seule clé. |
Exemples
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'
Format des données (--sortie json)
Clé unique:
{
"Code": "ProcessVersionUpdated",
"Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
{
"Code": "ProcessVersionUpdated",
"Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}
Bulk renvoie Code: "ProcessVersionsUpdated" avec ProcessKeys, Version et un objet Result renvoyé par l'API.
mise à jour de l’IU ou des processus
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. The key resolves tenant-wide by default. Pass --folder-path or --folder-key to scope the lookup to one folder, which an identity with access to a single folder only (such as an external app) requires.
edit est un alias enregistré pour ce verbe - uip or processes edit fonctionne de manière identique à uip or processes update.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. |
Options
Mêmes champs que processes create , à l'exception des trois options de package requises et --tags. Les règles d’exclusion mutuellement et de validation correspondent à create (--job-priority vs --specific-priority, --hidden-for-attended vs --visible-for-attended). La rétention des archives a besoin d'un compartiment de stockage: tant que l'action reste Archive, le compartiment actuel est conservé, et lorsque l'action passe à Delete ou None, le compartiment est effacé.
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | — | Étenduez la recherche de clé à ce dossier au lieu de la résoudre à l’échelle du locataire. |
| — | --folder-key | GUID | — | Étenduez la recherche de clé à ce dossier au lieu de la résoudre à l’échelle du locataire. |
-n | --name | text | — | Nouveau nom complet. |
-d | --description | text | — | Nouvelle description. |
| — | --entry-point | Chemin d'accès | — | Nouveau chemin du point d’entrée. |
| — | --input-arguments | JSON | — | Arguments d'entrée par défaut. |
| — | --environment-variables | text | — | Paires KEY=VALUE séparées par une nouvelle ligne (non JSON). Transmettez '' pour les effacer. |
| — | --job-priority | ENUM | — | Low, Normal, High |
| — | --specific-priority | 1 à 100 | — | Priorité numérique. |
| — | --robot-size | ENUM | — | Taille du robot cloud: Small, Standard, Medium, Large. |
| — | --auto-update / --no-auto-update | Drapeau | — | Activer/désactiver la mise à jour automatique. |
| — | --hidden-for-attended / --visible-for-attended | Drapeau | — | Visibilité assistée. |
| — | --auto-create-triggers / --no-auto-create-triggers | Drapeau | — | Création automatique de déclencheurs connectés. |
| — | --healing-agent / --no-healing-agent | Drapeau | — | Activez ou désactivez Healing Agent (Autopilot pour Robots) pour ce processus. Les tâches futures l’utilisent par défaut une fois activé; Autopilot doit déjà être activé au niveau du locataire. |
| — | --retention-period | jours (1 à 180) | — | Période de rétention de la tâche. |
| — | --retention-action | ENUM | — | Delete, Archive, None Le passage à Archive nécessite --retention-bucket sauf si le processus archive déjà. |
| — | --retention-bucket | clé de compartiment | — | Storage bucket key for archived jobs. Omit to keep the current bucket. The bucket must be in, or shared to, the process folder. Get the key from uip or buckets list. |
| — | --stale-retention-period | jours | — | Stale-job retention period. Omit to keep the current period. When no period is stored, Delete/None use 180 and Archive requires this option. |
| — | --stale-retention-action | ENUM | — | Delete, Archive, None. Archive requires --stale-retention-bucket. |
| — | --stale-retention-bucket | clé de compartiment | — | Clé de compartiment de stockage pour les tâches obsolètes archivées. Omettez pour conserver le compartiment actuel. Le compartiment doit se trouver dans le dossier de processus ou partagé avec celui-ci. Obtenez la clé de uip or buckets list. |
Exemples
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'
Format des données (--sortie 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"
}
}
suppression d’IU ou de processus
Supprimez une liaison de processus par clé. Cela supprime la liaison de version de son dossier - cela ne supprime pas le package sous-jacent.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. Recherchez-le avec processes list. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
-y | --yes | Drapeau | — | Requis. Confirme cette opération irréversible — la CLI ne s'affiche jamais. |
Exemples
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
uip or processes delete c3d4e5f6-0000-0000-0000-000000000001 --yes
Format des données (--sortie 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"
}
}
Restauration d’UIP ou de processus
Rétablir la version de package précédente d'un processus. Le dossier est facultatif; lorsqu'il n'est pas indiqué, il est déduit de la clé du processus.
Arguments
| Nom | Requis | Objectif |
|---|---|---|
<process-key> | oui | Clé de processus. |
Options
| Short | Long | Valeur (Value) | Default | Description |
|---|---|---|---|---|
| — | --folder-path | Chemin d'accès | déduit | Ignorer la détection automatique. |
| — | --folder-key | GUID | déduit | Ignorer la détection automatique. |
Exemples
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'
Format des données (--sortie 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"
}
}
Codes de sortie
Voir Codes de sortie. Aucun remplacement spécifique aux verbes au-delà des erreurs de validation standard.
Commandes associées
uip or packages: recherchez les clés de package (packages list), les versions (packages versions) et les points d'entrée (packages entry-points) avant d'appelerprocesses create.uip or jobs— en particulierjobs start, qui prend une clé de processus.uip or folders— crée ou localise le dossier cible avant la liaison.
Voir également
- Synthèse
- Verbes
- liste des processus ou UiP
- Options
- Exemples
- Format des données (--sortie json)
- uip ou processus obtenir
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- ressources de l’interface utilisateur ou des processus
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- uip ou process historique des versions
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- uip ou processus créer
- Options
- Exemples
- Format des données (--sortie json)
- uip ou processus update-version
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- mise à jour de l’IU ou des processus
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- suppression d’IU ou de processus
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- Restauration d’UIP ou de processus
- Arguments
- Options
- Exemples
- Format des données (--sortie json)
- Codes de sortie
- Commandes associées
- Voir également