Implementar un paquete en Orchestrator

Implementar un paquete en Orchestrator

Prerequisites:

• Crea un paquete.
• Ejecuta el archivo CLI exe (para Windows Legacy) o dll (para Windows/Linux/macOS).
• Añade los ámbitos de aplicación de acceso a la API de Orchestrator necesarios.

Para implementar un paquete en Orchestrator, sigue los siguientes pasos:

1. Ejecuta la tarea package , utilizando uipcli package. Puedes ver una lista de las subtareas disponibles.
2. Especifica los parámetros necesarios y ejecuta la subtarea deploy . La siguiente tabla describe los parámetros necesarios.

Parámetro	Descripción
-c, or --createProcess	El valor predeterminado es true. Cuando se establece en true, crea un proceso en la carpeta de Orchestrator que se pasa en el comando. Cuando se establece en false, no crea un proceso en la carpeta de Orchestrator. Por ejemplo: --createProcess false.
--processNames	Opcionalmente, proporcione un archivo .csv con nombres personalizados para los procesos que se crearán/actualizarán. El siguiente es un ejemplo de cómo el archivo .csv estructura debe verse. Los nombres/encabezados de columna NombreDePaquete, NombreDePuntoDeEntrada y NombreDeProceso son obligatorios. PackageName EntryPointName NombreDelProceso MiPaquete Main.xaml Mi proceso OtroPaqueteMás CustomEntryPoint.xaml Otroproceso
--processName	Opcionalmente, proporcione un nombre personalizado para el proceso que se actualizará/creará.
--processDescription	Establece la descripción del proceso en el valor especificado. Tiene la máxima prioridad sobre cualquier otra fuente de descripción.
--use-package-description	Utiliza la descripción del paquete como descripción del proceso. Al crear, este es el comportamiento predeterminado. Al actualizar, esto anula la descripción del proceso existente con la descripción del paquete.
--ignoreLibraryDeployConflict	Ignora el conflicto al implementar un paquete de biblioteca con la misma versión que uno existente. De forma predeterminada, la implementación falla si ya existe una biblioteca con la misma versión en la instancia de Orchestrator.
-eo --environments (para carpetas clásicas)	Una lista de entornos en los que quieres implementar el paquete, separados por comas. Si el entorno no pertenece a la carpeta predeterminada, prefija el entorno con el nombre de la carpeta. Por ejemplo: AccountingTeam\\TestEnvironment.
-h, or --entryPointsPath	Define los puntos de entrada específicos para crear o actualizar el proceso. Esta es la ruta del archivo del punto de entrada, comenzando desde la raíz del proyecto. Para las carpetas clásicas, solo se puede especificar un punto de entrada por entorno.
-uo --username (necesario para la autenticación básica)	El nombre de usuario utilizado para autenticarse en Orchestrator. Debe estar emparejado con la contraseña correspondiente.
-po --password (necesario para la autenticación básica)	La contraseña utilizada para autenticarse en Orchestrator. Debe estar emparejado con el nombre de usuario correspondiente.
-to --token (Obligatorio para la autenticación basada en tokens)	El token de actualización OAuth2 utilizado para autenticarse en Orchestrator. Debe estar emparejado con el Nombre de cuenta y el ID de cliente.
-ao --accountName (Obligatorio para la autenticación basada en tokens )	El nombre de la cuenta de Orchestrator CloudRPA. Debe estar emparejado con el token de actualización OAuth2 y el ID de cliente.
-A, or --accountForApp	El nombre de la cuenta de Orchestrator CloudRPA (nombre de la organización). Debe emparejarse con ID de aplicación, Secreto de aplicación y Ámbito de aplicación para la autenticación de aplicaciones externas.
-Io --applicationId (Obligatorio para la autenticación de aplicaciones externas)	El ID de la aplicación externa. Debe estar emparejado con Cuenta de aplicación, Secreto de aplicación y Ámbito de aplicación.
-So --applicationSecret (Obligatorio para la autenticación de aplicaciones externas)	El secreto de la aplicación externa. Debe estar emparejado con Cuenta de aplicación, ID de aplicación y Ámbito de aplicación.
--applicationScope (Opcional para la autenticación de aplicaciones externas)	La lista de ámbitos de aplicación, separados por espacios individuales. Opcional cuando se utiliza la autenticación de aplicaciones externas, ya que los ámbitos predeterminados se aplican automáticamente. Debe estar emparejado con Cuenta de aplicación, ID de aplicación y Secreto de aplicación.
-oo --organizationUnit (Obligatorio)	El nombre de la carpeta de Orchestrator (unidad de organización). Para introducir subcarpetas, incluye tanto el nombre de la carpeta principal como el de la subcarpeta. Por ejemplo: AccountingTeam/TeamJohn.
-l, or --language	El idioma utilizado en la interfaz de usuario de Orchestrator.
-y, or --disableTelemetry	Deshabilitar los datos de telemetría.
--traceLevel	Mostrar el seguimiento de los eventos.
--identityUrl (Obligatorio para implementaciones de PaaS o MSI)	La URL de su servidor de identidad.
Package(s) Path (pos. 0) (Obligatorio)	La ruta a un archivo de paquete o la ruta a una carpeta que contiene varios paquetes.
Orchestrator URL (pos. 1) (Obligatorio)	La URL de la instancia de Orchestrator.
Tenant de Orchestrator (pos. 2) (Required) for SaaP deployments. (Optional) for PaaS deployments.	El tenant de la instancia de Orchestrator donde desea eliminar la máquina.
--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.

Consejo:

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.

Nota:

Al utilizar la autenticación de aplicaciones externas sin especificar el parámetro --applicationScope , la CLI aplica automáticamente estos ámbitos predeterminados de Orchestrator:

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

ADVERTENCIA:

Al utilizar el parámetro --applicationSecret en los scripts de PowerShell, los caracteres especiales como $ pueden provocar un comportamiento inesperado debido a la expansión de variables de PowerShell en cadenas entre comillas dobles.

Utiliza comillas simples ('') en lugar de comillas dobles ("") al pasar el parámetro --applicationSecret para evitar que PowerShell interprete caracteres especiales:

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

El uipcli crea un proceso con un punto de entrada default si no especifica uno. Si se especifica el punto de entrada, se crea un proceso con ese punto de entrada y _{entryPoint} se anexa al nombre del proceso. Además, todos los procesos asociados con package.Id se actualizan a la última versión, independientemente de si el proceso se creó manualmente o desde un proceso.

Uso:

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

Ejemplos de comandos mínimos:

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