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.

All the examples displayed in the Arguments Description chapter are constructed from the assumption that you performed this action.

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:

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>	Mandatory. Starts the execution of a local project file. The target file can be .json, .xaml, or .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"
--folder <Orchestrator_Folder_ID>	Optional. Allows you to specify the Orchestrator folder from which to install and execute the target process. It can only be used together with the --process argument. Ejemplo: UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Input_Parameters>	Optional. Allows you to specify input arguments for execution. It can be used with the --process or --file arguments. 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	Permite seleccionar el punto de entrada de un proceso cuando se inicia a través de la línea de comandos. Ejemplos: 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\Project.json"
• UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml"

El comando Empaquetar

Nota:

For Studio v2018.4.4 and later releases we recommend publishing using the command UiPath.Studio.CommandLine.exe publish instead of UiRobot.exe pack. For more information, see Mass Update Command Line Parameters in the Studio guide.

• 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 comando connect 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

Used to connect the robot to Orchestrator, must be used with the --url, --key, or --clientID --clientSecret arguments. If the arguments are not specified, the Orchestrator configuration in Assistant is used to establish the connection. 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

• UiRobot.exe disconnect

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

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.