Interfaz de línea de comandos

La interfaz de línea de comandos del robot (UiRobot.exe) es una aplicación de consola que puede solicitar el inicio de trabajos y esperar a su salida. Es un cliente directo del mantenimiento de robot de UiPath, y la comunicación se realiza mediante un canal WCF.

Para usar los argumentos de línea de comandos admitidos por UiPath Robots, comprueba que el servicio UiPath Robot se está ejecutando. De lo contrario, inícialo desde el complemento de Consola de administración de servicios de Microsoft.

Para hacerte más sencillo trabajar con argumentos de línea de comandos, navega hasta el directorio en el que se instaló el robot usando el comando cambiar de directorio. Por ejemplo, si no has cambiado la ubicación predeterminada del robot, puedes usar lo siguiente: cd C:\Program Files\UiPath\Studio.

Todos los ejemplos que se muestran en el capítulo Descripción de argumentos se construyen desde la asunción de que has realizado esta acción.

Descripción de argumentos

Para hacerte más sencillo trabajar con argumentos de línea de comandos, navega hasta el directorio en el que se instaló el robot usando el comando cambiar de directorio. Por ejemplo, si no has cambiado la ubicación predeterminada del robot, puedes usar el siguiente comando:

cd C:\Program Files\UiPath\Studio.

Todos los ejemplos mostrados aquí se han construido desde la asunción de que has ejecutado primero el comando anterior.

Los robots atendidos deben ejecutarse solo bajo supervisión humana.

El comando Ejecutar

• UiRobot.exe execute [--process <Package_ID> | --file <File_Path>] [--folder <Orchestrator_Folder_ID>] [--input <Input_Parameters>]

Este comando se usa para iniciar la ejecución de un proceso o un archivo (.json, .xaml o .nupkg). Ten en cuenta que los argumentos --process (-p) y --file (-f) no se pueden usar simultáneamente con el comando execute. Es compatible con los siguientes argumentos:

Nota: A partir de la versión 2023.4 La lista de procesos se actualiza en paralelo con la ejecución del proceso; anteriormente, la lista de procesos se actualizaba antes de iniciarse el proceso. Esto significa que al ejecutar un proceso para el que existe una actualización disponible, el trabajo puede ejecutarse con la versión anterior del proceso.

Argumento	Descripción
-p--process <Package_ID>	Obligatorio. Inicia la ejecución de un proceso local o de Orchestrator. Ejemplos: UiRobot.exe execute --process UiPathDemoProcess UiRobot.exe execute -p UiPathDemoProcess
-f--file <File_Path>	Obligatorio. Inicia la ejecución de un archivo de proyecto local. El archivo de destino puede ser .json, .xaml, o .nupkg. Ejemplos: UiRobot.exe execute --file "C:\UiPath\Automation\Project.json" UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" UiRobot.exe execute --file "C:\UiPath\Automation\Notepad.1.0.6682.21636.nupkg"
--carpeta <ID_Carpeta_Orchestrator>	Opcional.Te permite especificar la carpeta de Orchestrator desde la que instalar y ejecutar el proceso de destino. Solo puede utilizarse con el argumento --proceso. Ejemplo: UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Parámetros_entrada>	Opcional.Te permite especificar argumentos de entrada para la ejecución. Se puede utilizar con los argumentos --proceso o --archivo. Ejemplos: UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}" UiRobot.exe execute --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}" UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"
--entry <entrypoint>	Permite seleccionar el punto de entrada de un proceso cuando se inicia a través de la línea de comandos. Ejemplo: UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"

Importante: Los siguientes comandos no se admiten en proyectos Windows o portátiles:

• UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"
• UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"

El comando de proceso de instalación

• UiRobot installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]

El comando installprocess se utiliza para instalar un proceso. Cuando el UiPath Robot está conectado a Orchestrator, solo busca el proceso en la fuente de Orchestrator. Cuando el robot no está conectado a Orchestrator, se utiliza la fuente local.

Se admiten los siguientes argumentos:

Argumento	Descripción
--process-name <process_name>	Obligatorio. El nombre del proceso a instalar. Ejemplo: UiRobot installprocess --process-name MyProcess
--folder <orchestrator_folder>	Opcional. El nombre de la carpeta de Orchestrator en la que se encuentra el proceso a instalar. Este argumento solo se puede utilizar cuando el UiPath Robot está conectado a Orchestrator. Si el proceso a instalar se encuentra en una sola carpeta, no se necesita el parámetro. Ejemplo: UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder

El comando Empaquetar

Nota: para Studio v2018.4.4 y versiones posteriores recomendamos publicar usando el comando en UiPath.Studio.CommandLine.exe publishlugar de UiRobot.exe pack. Para obtener más información, consulta Parámetros de línea de comandos de actualización masiva en la guía de Studio.

• UiRobot.exe pack <Project_Path> --output <Destination_Folder> [-v <Project_Version>]

Este comando se usa para empaquetar un archivo Project.json en un archivo .nupkg. Es compatible con los siguientes argumentos:

Argumento	Descripción
-o --output <Destination_Folder>	Obligatorio. Te permite especificar dónde se crea el archivo .nupkg. Ejemplo: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"
-v <Project_Version>	Opcional. Te permite especificar una versión para el archivo .nupkg. Ejemplo: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

El comando Conectar

• UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

  Nota: si el robot ya está conectado, ejecutar el connectcomando devuelve el siguiente mensaje: Orchestrator already connected!.

Este comando se usa para conectar el robot a una instancia de Orchestrator. Es compatible con los siguientes argumentos:

Argumento

Descripción

connect

Se utiliza para conectar el UiPath Robot a Orchestrator; debe utilizarse con los argumentos --url, --key, o --clientID --clientSecret. Si no se especifican los argumentos, se utilizará la configuración de Orchestrator para establecer la conexión. Ejemplo: UiRobot.exe connect Ejemplo de clave de máquina: UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00 Ejemplo de ID de cliente y secreto de cliente: UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

El comando Desconectar

Este comando se usa para desconectar el robot de la instancia actual de Orchestrator.

Tabla 1.

Argumento	Descripción
UiRobot.exe disconnect	Desconecta el UiPath Robot de Orchestrator. Este comando solo funciona si no hay trabajos en ejecución en la máquina del robot.
robot.exe disconnect --force	Desconecta el UiPath Robot de Orchestrator. Si hay un trabajo en ejecución en la máquina, el trabajo se elimina y solo después se desconecta el robot
robot.exe disconnect --wait	Desconecta el UiPath Robot de Orchestrator. Si hay un trabajo en ejecución en la máquina, el robot solo se desconecta cuando se completa el trabajo.

El comando Rastrear

• UiRobot.exe trace --enableLowLevel | --disableLowLevel

Este comando se usa para habilitar o deshabilitar el seguimiento de bajo nivel (verboso) para el robot. Es compatible con los siguientes argumentos:

Argumento	Descripción
--enableLowLevel	Habilita el seguimiento de bajo nivel. Se genera un archivo .etl, que puede abrirse con el Visor de eventos, para ayudarte a solucionar problemas de bloqueos y errores. Esto permite el seguimiento verboso para el ejecutor de robot y el servicio en el Visor de eventos. Ejemplo: UiRobot.exe trace --enableLowLevel
--disableLowLevel	Deshabilita el seguimiento de bajo nivel. Se genera un archivo .etl en el escritorio después de detenerlo. Este archivo puede abrirse en el Visor de eventos, para ayudarte a resolver problemas de bloqueos y errores. Ejemplo: UiRobot.exe trace --disableLowLevel

El comando PiP

Te permite habilitar o deshabilitar la funcionalidad de Imagen en imagen en la máquina. Este ajuste se aplica en la máquina local y afecta a todos los usuarios. Se usa para modificar instalaciones existentes.

Se necesitan derechos de administrador para ejecutar estos comandos.

Comando	Descripción
PiP --enable	Habilita la funcionalidad Imagen en imagen de la máquina.
PiP --disable	Deshabilita la funcionalidad Imagen en imagen de la máquina.

El comando ENABLE_PIP

Te permite habilitar la funcionalidad Imagen en imagen de la máquina durante la instalación de línea de comandos de UiPath.

Comando	Descripción
ENABLE_PIP=1	Habilita la funcionalidad Imagen en imagen de la máquina.
ENABLE_PIP=0	No habilita la funcionalidad Imagen en imagen de la máquina.

Comandos variados

Los siguientes comandos son puramente informativos y no tienen influencia en tus proyectos de automatización:

Argumento	Descripción
--version	Muestra información sobre la versión de Robot.
--help	Muestra la lista de comandos admitidos, además de información y ejemplos pertinentes.
logs --flush	Envía todos los registros pendientes a Orchestrator.