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]

Verbes

Verbe	Objectif
list	Répertoriez les processus dans un dossier.
get	Récupérez un processus par clé, y compris les schémas d'arguments et la rétention.
resources	List package resources (queues, assets, buckets, connections) required by a process.
version-history	List the chronological package-version history for a process.
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)	Update process settings (PATCH semantics on selected fields).
delete	Delete a process binding by key (does not delete the 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. Nécessite --folder-path ou --folder-key. Renvoie la clé du processus, le nom, la version et les métadonnées de base.

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é	Tenant-wide listing. Mutually exclusive with --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 --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"

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,
      "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 ou processus obtenir

Récupérez un processus par clé GUID. Renvoie la version, le point d'entrée, les schémas d'arguments d'entrée/de sortie, le type de processus et la configuration. Aucun contexte de dossier requis — la clé est résolue dans plusieurs dossiers.

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.

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

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.

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

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

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.

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

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

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.

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	—	Environment variables as newline-separated KEY=VALUE pairs (not JSON), e.g. $'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 ou None
—	--retention-bucket	ID de compartiment	—	ID de compartiment de stockage. Requis lorsque --retention-action Archive.
—	--stale-retention-period	jours	—	Période de rétention de la tâche obsolète.
—	--stale-retention-action	ENUM	—	Delete, Archive ou None

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

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

Format des données (--sortie json)

Clé unique:

{
  "Code": "ProcessVersionUpdated",
  "Data": { "ProcessKey": "c3d4e5f6-…-000001", "Version": "latest" }
}

Bulk renvoie Code: "ProcessVersionsUpdated" avec ProcessKeys, Version et un objet Result renvoyé par l'API.

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.

Arguments

Nom	Requis	Objectif
<process-key>	oui	Clé de processus.

Options

Mêmes champs que processes create , à l'exception des trois options de package et indicateurs d'étendue requis. 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 de Archive nécessite --retention-bucket).

Short	Long	Valeur (Value)	Default	Description
-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	—	Newline-separated KEY=VALUE pairs (not JSON). Pass '' to clear them.
—	--job-priority	ENUM	—	Low, Normal, High
—	--specific-priority	1 à 100	—	Priorité numérique.
—	--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	—	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	jours (1 à 180)	—	Période de rétention de la tâche.
—	--retention-action	ENUM	—	Delete, Archive, None
—	--retention-bucket	ID de compartiment	—	Requis lorsque --retention-action Archive.
—	--stale-retention-period	jours	—	Période de rétention de la tâche obsolète.
—	--stale-retention-action	ENUM	—	Delete, Archive, None

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

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

Format des données (--sortie 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.

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

Exemples

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

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

Format des données (--sortie json)

{
  "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'appeler processes create.
• uip or jobs — en particulier jobs start, qui prend une clé de processus.
• uip or folders — crée ou localise le dossier cible avant la liaison.

Voir également

• Options globales.
• Sessions.