Ejecutar un trabajo dentro de Orchestrator

Requisitos previos y pasos para ejecutar un trabajo dentro de Orchestrator utilizando la CLI.

Ejecutar un trabajo dentro de Orchestrator

Requisitos previos

• Crea un proceso en Orchestrator.
• 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 ejecutar un trabajo dentro de Orchestrator, sigue los siguientes pasos:

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

Parámetro	Descripción
Process Name (pos. 0) ( Obligatorio )	El nombre del proceso que desea ejecutar.
Orchestrator URL (pos. 1) ( Obligatorio )	La URL de la instancia de Orchestrator.
Orchestrator Tenant (pos. 2)	El tenant de la instancia de Orchestrator, donde quieres ejecutar procesos. Obligatorio cuando se orienta a Automation Cloud. Opcional para Automation Suite y Orchestrator independiente (MSI local), donde el tenant forma parte de la URL.
-i o --input_path ( Obligatorio solo si el punto de entrada del flujo de trabajo tiene parámetros de entrada)	La ruta completa al archivo de entrada JSON correspondiente al proceso que desea ejecutar. Consulta Formato JSON de parámetros de entrada para obtener más información sobre la estructura de archivos.
-P , or --priority	La prioridad con la que desea ejecutar el trabajo: - Baja. Normal (predeterminado). Alto.
-r , or --robots	Una lista de nombres de robots específicos, separados por comas.
-j , or --jobscount	El número de veces que desea ejecutar el proceso. El número predeterminado de veces que se ejecuta el proceso es una.
-U , or --user	El nombre del usuario. Debe ser un usuario de la máquina, no un usuario de Orchestrator. Para los usuarios locales, el formato es MachineName\\UserName .
-M , or --machine	El nombre de la máquina en la que desea ejecutar el proceso.
-R , or --result_path	La ruta completa a un archivo JSON o a una carpeta donde quieres almacenar los resultados del trabajo. Los resultados se devuelven como archivos JSON.
-W , or --timeout	El tiempo de espera para las ejecuciones de trabajos (segundos). El valor predeterminado es 1800 segundos.
-f , or --fail_when_job_fails	El comando falla cuando falla un trabajo. El valor predeterminado es Verdadero .
-w , or --wait	El comando espera a que finalice el trabajo. El valor predeterminado es Verdadero .
-b o --job_type (solo para carpetas modernas)	El tipo de runtime para el trabajo. El valor predeterminado es Unattended. Valores admitidos: Runtimes de automatización unattended: Unattended, NonProduction, TestAutomation, Development, Headless Tiempos de ejecución de automatización atendidos: Attended, AssistantWeb Licencias de desarrollador: RpaDeveloper, RpaDeveloperPro, CitizenDeveloper Licencias de Studio: Studio, StudioX, StudioPro, AttendedStudioWeb Tiempos de ejecución en la nube/sin servidor: AutomationCloud, Serverless, AutomationKit, ServerlessTestAutomation, AutomationCloudTestAutomation Prueba: AppTest, PerformanceTest Otro: AgentService, Hosting, ProcessOrchestration
-u o --username ( obligatorio si 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 ( obligatorio si 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.
-t o --token ( Obligatorio si utilizas la autenticación basada en tokens )	El token de actualización OAuth2 utilizado para autenticarse en Orchestrator. Debes emparejarlo con el Nombre de cuenta y el ID de cliente .
-a o --accountName ( Obligatorio si utilizas la autenticación basada en tokens )	El nombre de la cuenta de Orchestrator CloudRPA. Debes emparejarlo 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). Debes emparejarlo con el ID de la aplicación, el Secreto de la aplicación y el Ámbito de la aplicación para aplicaciones externas.
-I o --applicationId ( Obligatorio si utilizas 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.
-S o --applicationSecret ( Obligatorio si utilizas 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 Ámbito de la aplicación.
--applicationScope ( Obligatorio si utilizas la autenticación de aplicación externa )	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. Debes emparejarlo con la cuenta de la aplicación , el ID de la aplicación y el secreto de la aplicación para la aplicación externa.
-o , or --organizationUnit	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 .
-l , --language	El lenguaje de Orchestrator.
-y , --disableTelemetry	Deshabilitar los datos de telemetría.
--traceLevel	Mostrar el seguimiento de los eventos.
--identityUrl	La URL de tu servidor de identidad. Necesario cuando Orchestrator se ejecuta en UiPath Automation Suite o en Orchestrator independiente (MSI local). No es necesario para Automation Cloud : la CLI resuelve el servidor de identidad desde la URL de la nube.
--ca-cert	Uno o más archivos de certificado de CA raíz de confianza (PEM, DER o PKCS#7) utilizados al validar los certificados TLS de Orchestrator e Identity Server. Repite el marcador o separa con comas varias rutas. Consulta Confiar en certificados personalizados para obtener más detalles.
--pinnedpubkey	Anclar la clave pública del certificado de hoja del servidor. Formato: sha256//<base64>. Se comprueba además de la validación de certificados estándar. Consulta Confiar en certificados personalizados para obtener más detalles.

Consejo:

Para las instancias de Orchestrator firmadas por una autoridad de certificación privada (como UiPath Automation Suite), este comando también acepta los parámetros --ca-cert y --pinnedpubkey . Consulta Confiar en certificados personalizados para escenarios y ejemplos.

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 job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S 'mySecret$123' -o "MyFolder"

# Incorrect - double quotes allow variable expansion
uipcli job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S "mySecret$123" -o "MyFolder"

Uso

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-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>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <RuntimeType>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Ejemplos de comandos mínimos

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "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"
• uipcli job run ProcessName "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"
• uipcli job run ProcessName "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"