Deploying a package to Orchestrator

Prerrequisitos:

• Crea un paquete.
• Ejecuta el archivo CLI exe (para Windows) o dll (para Linux).
• 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
   -co --createProcess	El valor predeterminado para 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 debe ser la estructura. 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á.
   --ignoreLibraryDeployConflict	Ignora el conflicto al implementar un paquete de biblioteca con la misma versión que uno existente. De forma predeterminada, la implementación fallará 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 (unidad de organización), debe añadir el nombre de la carpeta como prefijo del entorno. Por ejemplo, si el entorno es EntornoDePruebay el nombre de la carpeta es EquipoDeContabilidad, escribe el entorno como EquipoDeContabilidad \ EntornoDePrueba.
   -ho --entryPointsPath	Define los puntos de entrada específicos para crear o actualizar el proceso. Esta es la ruta del archivo del punto de entrada a partir de la raíz del proyecto. Para las carpetas clásicas, solo se puede especificar un punto de entrada para cada entorno.
   -u, o --username (necesario cuando utilizas la Autenticación básica, mediante un nombre de usuario y una contraseña)	El nombre de usuario utilizado para autenticarse en Orchestrator. Debe emparejarlo con la contraseña correspondiente.
   -p, o --password (necesario cuando utilizas la Autenticación básica, mediante un nombre de usuario y una contraseña)	La contraseña utilizada para autenticarse en Orchestrator. Debes emparejarlo con el nombre de usuario correspondiente.
   -to --token (obligatorio si utiliza la autenticación basada en token)	El token de actualización OAuth2 que se usa para autenticarse en Orchestrator. Debe emparejarlo con el nombre de la cuenta y la ID del cliente.
   -ao --accountName (obligatorio si utiliza la autenticación basada en token)	El nombre de la cuenta de Orchestrator CloudRPA. Debes emparejarlo con el token de actualización de OAuth2 y el ID de cliente.
   -Ao --accountForApp	El nombre de la cuenta de Orchestrator CloudRPA (nombre de la organización). Debe emparejarlo con el ID de la aplicación,el Secreto de la aplicación y el Ámbito de la aplicación para la aplicación externa
   -Io --applicationId (obligatorio si usa la autenticación de aplicación externa)	El ID de aplicación externo. Debes emparejarlo con la Cuenta de la aplicación, el Secreto de la aplicación y el Ámbito de la aplicación.
   -So --applicationSecret (obligatorio si usa la autenticación de aplicación externa)	El Secreto de la aplicación externo. Debes emparejarlo con la Cuenta de la aplicación, ID de la aplicación y el Ámbito de la aplicación.
   --applicationScope (necesario cuando utilizas la autenticación de aplicación externa)	La lista de ámbitos de aplicación, separados por espacios individuales. Debes emparejarlo con la Cuenta de la aplicación, ID de la aplicación y el Secreto de la aplicación para aplicaciones externas.
   -o o --organizationUnit (obligatorio)	El nombre de la carpeta de Orchestrator (unidad de organización). Para introducir subcarpetas, asegúrate de introducir tanto el nombre de la carpeta principal como el nombre de la subcarpeta. Por ejemplo, AccountingTeam/TeamJohnusa .
   -lo --language	El idioma utilizado en la interfaz de usuario de Orchestrator.
   -yo --disableTelemetry	Deshabilitar los datos de telemetría.
   --traceLevel	Mostrar el seguimiento de los eventos.
   --identityUrl (Required for PaaS or MSI deployments)	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) (Obligatorio) para implementaciones de SaaP. (Opcional) para implementaciones de PaaS.	El tenant de la instancia de Orchestrator donde desea eliminar la máquina.

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