Déploiement d'un package sur Orchestrator

Déploiement d'un package sur Orchestrator

Prerequisites:

• Créez un package.
• Exécutez le fichier CLI exe (pour l'héritage Windows) ou dll (pour Windows/Linux/macOS).
• Ajoutez les étendues d'application d'accès à l'API Orchestrator requises.

Pour déployer un package sur Orchestrator, procédez comme suit :

1. Exécutez la tâche package à l'aide de uipcli package. Vous pouvez remarquer une liste des sous-tâches disponibles.
2. Spécifiez les paramètres requis et exécutez la sous-tâche deploy . Le tableau suivant décrit les paramètres requis.

Paramètre	Description
-c, or --createProcess	La valeur par défaut est true. Lorsqu'il est défini sur true, il crée un processus dans le dossier Orchestrator qui est transmis dans la commande. Lorsqu’il est défini sur false, il ne crée pas de processus dans le dossier Orchestrator. Par exemple : --createProcess false.
--processNames	Si vous le souhaitez, fournissez un fichier .csv avec des noms personnalisés pour les processus à créer/mettre à jour. Voici un exemple de la façon dont le fichier .csv la structure doit ressembler à. Les noms/en-têtes de colonne NomPackage, NomEntréePointEntrée et NomProcessus sont obligatoires ! PackageName EntryPointName ProcessName Mon paquet Main.xaml Mes processus EncoreUnAutrePackage CustomEntryPoint.xaml Cependant, un autre processus
--processName	Vous pouvez éventuellement fournir un nom personnalisé pour le processus à mettre à jour/créer.
--processDescription	Définissez la description du processus sur la valeur spécifiée. Prend la priorité la plus élevée sur toute autre source de description.
--use-package-description	Utilisez la description du package comme description du processus. Lors de la création, il s'agit du comportement par défaut. Lors de la mise à jour, cela remplace la description du processus existante par la description du package.
--ignoreLibraryDeployConflict	Ignorer le conflit lors du déploiement d’un package de bibliothèque avec la même version qu’un package existant. Par défaut, le déploiement échoue si une bibliothèque avec la même version existe déjà dans l'instance Orchestrator.
-e, ou --environments (pour les dossiers classiques)	La liste des environnements dans lesquels vous souhaitez déployer le package, séparés par des virgules. Si l'environnement n'appartient pas au dossier par défaut, ajoutez le préfixe de l'environnement avec le nom du dossier. Par exemple : ÉquipeComptabilité\\EnvironnementEnvironnement.
-h, or --entryPointsPath	Définissez les points d’entrée spécifiques pour créer ou mettre à jour un processus. Il s'agit du CheminFichier du point d'entrée à partir de la racine du projet. Pour les dossiers classiques, un seul point d’entrée peut être spécifié par environnement.
-u, ou --username (Requis pour l'authentification de base)	Le nom d'utilisateur utilisé pour l'authentification auprès d'Orchestrator. Doit être associé au mot de passe correspondant.
-p, ou --password (Requis pour l'authentification de base)	Le mot de passe utilisé pour l'authentification auprès d'Orchestrator. Doit être associé au nom d'utilisateur correspondant.
-t, ou --token (Requis pour l'authentification basée sur jeton)	Le jeton d’actualisation OAuth2 utilisé pour l’authentification auprès d’Orchestrator. Doit être associé au Nom du compte et à l’ ID client.
-a, ou --accountName (Requis pour l'authentification basée sur jeton )	Le nom du compte Orchestrator CloudRPA. Doit être associé au jeton d’actualisation OAuth2 et à l’ ID client.
-A, or --accountForApp	Le nom du compte Orchestrator CloudRPA (nom de l’organisation). Doit être associé à l’ ID d’application, à la clé secrète de l’application et à l’ étendue de l’application pour l’authentification d’application externe.
-I, ou --applicationId (requis pour l'authentification d'application externe)	ID d’application externe Doit être associé au compte d'application, à l'étendue de l'application ) et à l'étendue de l'application.
-S, ou --applicationSecret (requis pour l'authentification d'application externe)	La clé secrète de l'application externe. Doit être associé au compte d'application, à l'ID d'application ) et à l'étendue de l'application.
--applicationScope (Facultatif pour l'authentification d'application externe)	La liste des étendues d'application, séparées par des espaces simples. Facultatif lors de l'utilisation de l'authentification d'application externe, les étendues par défaut sont automatiquement appliquées. Doit être associé à l 'ID d'application, à la clé secrète de l' application et à l'étendue de l'application.
-o, ou --organizationUnit (Requis)	Le nom du dossier Orchestrator (unité d'organisation). Pour saisir des sous-dossiers, incluez à la fois le nom du parent et le nom du sous-dossier. Par exemple : AccountingTeam/TeamJohn.
-l, or --language	La langue utilisée dans l'interface utilisateur d'Orchestrator.
-y, or --disableTelemetry	Désactiver les données de télémétrie
--traceLevel	Afficher la trace des événements.
--identityUrl (Requis pour les déploiements PaaS ou MSI)	L'URL de votre serveur d'identité.
Package(s) Path (pos. 0) (Requis)	Le chemin d'accès à un fichier de package ou le chemin d'accès à un dossier contenant plusieurs packages.
Orchestrator URL (pos. 1) (Requis)	Il s'agit de l'URL de votre Orchestrator.
Locataire Orchestrator (pos. 2) (Required) for SaaP deployments. (Optional) for PaaS deployments.	Locataire de l'instance d'Orchestrator dans laquelle vous souhaitez supprimer une machine.
--ca-cert	One or more trusted root CA certificate files (PEM, DER, or PKCS#7) used when validating the Orchestrator and Identity Server TLS certificates. Repeat the flag or comma-separate multiple paths. See Trusting custom certificates for details.
--pinnedpubkey	Pin the server leaf certificate's public key. Format: sha256//<base64>. Checked in addition to standard certificate validation. See Trusting custom certificates for details.

Astuce :

For Orchestrator instances signed by a private Certificate Authority (such as UiPath Automation Suite), this command also accepts --ca-cert and --pinnedpubkey parameters. See Trusting custom certificates for scenarios and examples.

Remarque :

Lorsque vous utilisez l'authentification d'application externe sans spécifier le paramètre --applicationScope , la CLI applique automatiquement les étendues Orchestrator suivantes par défaut :

OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read

Avertissement :

Lors de l'utilisation du paramètre --applicationSecret dans les scripts PowerShell, des caractères spéciaux tels que $ peuvent provoquer un comportement inattendu en raison de l'expansion de la variable PowerShell dans les chaînes mises en guillemets doubles.

Utilisez des guillemets simples ('') au lieu de guillemets doubles ("") lors de la transmission du paramètre --applicationSecret , afin d'empêcher PowerShell d'interpréter des caractères spéciaux :

# Correct - single quotes treat the string literally
uipcli package deploy "C:\packages\MyPackage.nupkg" "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S 'mySecret$123' -o "MyFolder"

# Incorrect - double quotes allow variable expansion
uipcli package deploy "C:\packages\MyPackage.nupkg" "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S "mySecret$123" -o "MyFolder"

La uipcli créera un processus avec un point d’entrée default si vous n’en spécifiez pas. Si le point d’entrée est spécifié, un processus avec ce point d’entrée sera créé et _{entryPoint} sera ajouté au nom du processus. De plus, tous les processus associés au package.Id seront mis à jour vers la dernière version, que le processus ait été créé manuellement ou à partir d’un pipeline.

Utilisation :

uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>] [--processDescription <description>] [--use-package-description] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Exemples de commandes minimales:

• uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"
• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"n
• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"
• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --processNames "C:\userprofile\processNames.csv"
• uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml" --processName "MyProcessName"