robot

2024.10

true

Robot admin guide

Last updated 18 de nov. de 2024

Interfaz de la línea de comandos de Robot

La interfaz de línea de comandos de UiPath Robot es una herramienta que te permite interactuar con el UiPath Robot desde un terminal de línea de comandos. Utiliza el archivo UiRobot.exe para iniciar, detener o supervisar automatizaciones atendidas y desatendidas directamente desde la línea de comandos. También puedes obtener detalles sobre los paquetes instalados, crear registros o actualizar configuraciones.

Cómo funciona

Para utilizar la CLI, asegúrate de los siguientes aspectos:

El servicio de UiPath Robot se está ejecutando
Estás en el directorio en el que está instalado el UiPath Robot.

A continuación, escribe instrucciones o comandos que se refieran al programa UiRobot.exe junto con los parámetros necesarios, dependiendo de lo que quieras que logre tu automatización.

Por ejemplo, para iniciar un proceso desde la línea de comandos, utilizarías el siguiente comando:

UiRobot.exe -file "C:\UiPath\Projects\YourProject\Main.xaml".UiRobot.exe -file "C:\UiPath\Projects\YourProject\Main.xaml".

Comandos comunes de UiRobot.exe

Ejecutar

Utiliza este comando para iniciar la ejecución de un archivo de proyecto de los siguientes tipos:

JSON
XAML
NUPKG

Nota:

Con la versión de UiPath Robot 2023.4 y posteriores, UiPath actualiza la lista de procesos al mismo tiempo que se ejecuta un proceso. Si hay una actualización de proceso disponible al inicio del trabajo, el trabajo utiliza la versión anterior del proceso. Las ejecuciones posteriores aplican el proceso actualizado.

El comando de ejecución utiliza los siguientes argumentos:

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

-p--process <Package_ID> (obligatorio): inicia la ejecución de un proceso local o de Orchestrator.

Ejemplos:

UiRobot.exe execute --process UiPathDemoProcessUiRobot.exe execute --process UiPathDemoProcess

UiRobot.exe execute -p UiPathDemoProcessUiRobot.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\Project.json"

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

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

--folder <Orchestrator_Folder_ID> (opcional): te permite especificar la carpeta de Orchestrator desde la que instalar y ejecutar el proceso de destino. Solo se puede utilizar junto con el argumento --process .

Ejemplo:
```
UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
```

--input <Input_Parameters> (opcional): te permite especificar argumentos de entrada para la ejecución. Se puede utilizar con los argumentos --process o --file .

Ejemplos:

UiRobot.exe execute --process UiPathDemoProcess --input "{'inArg' : 'value' , 'Integer' : 3}"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 --process UiPathDemoProcess --folder OrchFolder1 --input "{'inArg' : 'value' , 'Integer' : 3}"

UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"UiRobot.exe execute --file "C:\UiPath\Automation\Main.xaml" --input "{'inArg' : 'value' , 'Integer' : 3}"

--entry <entrypoint> (opcional): te permite seleccionar el punto de entrada de un proceso al iniciarlo 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"UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"

Importante:

Los siguientes comandos no son compatibles con proyectos de Windows o multiplataforma:

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

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

No puedes utilizar los argumentos --process (-p) y --file (-f) simultáneamente en el comando de ejecución.

Proceso de instalación

Utilice este comando para instalar un proceso. Si el robot está conectado a Orchestrator, busca el proceso en la fuente de Orchestrator. Sin una conexión de Orchestrator, el robot utiliza la fuente local.

El comando del proceso de instalación utiliza los siguientes argumentos:

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

--process-name <process_name> (obligatorio): el nombre del proceso que quieres instalar.

Ejemplo:
```
UiRobot installprocess --process-name MyProcessUiRobot installprocess --process-name MyProcess
```
--folder <orchestrator_folder> (opcional): el nombre de la carpeta de Orchestrator que contiene el proceso que quieres instalar. Este argumento solo se aplica cuando la conexión a Orchestrator está activa. Si solo una carpeta contiene el proceso de instalación, omite este parámetro.

Ejemplo:
```
UiRobot installprocess -p MyProcess --folder MyOrchestratorFolderUiRobot installprocess -p MyProcess --folder MyOrchestratorFolder
```

Conectar

Utiliza este comando para conectar tu UiPath Robot a una instancia de Orchestrator. Si tu robot ya está conectado a Orchestrator y ejecutas este comando, devuelve el mensaje "Orchestrator ya está conectado".

El comando de conexión utiliza los siguientes argumentos:

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

connect : establece la conexión con Orchestrator. Deben utilizarse juntos los argumentos --url, --key o --clientID --clientSecret . Si no especificas estos argumentos, el comando utiliza la configuración de Ajustes de Orchestrator .

Ejemplos:

// no arguments

UiRobot.exe connect// no arguments

UiRobot.exe connect

//using the machine key

UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00//using the machine key

UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00

//using the client ID and secret

UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N//using the client ID and secret

UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

Desconectar

Utiliza este comando para desconectar el UiPath Robot de la instancia actual de Orchestrator.

El comando de desconexión utiliza los siguientes argumentos:

UiRobot.exe disconnect --force | --waitUiRobot.exe disconnect --force | --wait

disconnect : desconecta el robot de Orchestrator solo cuando no hay trabajos en ejecución en la máquina del robot.

Ejemplo:
```
UiRobot.exe disconnectUiRobot.exe disconnect
```
--force : cancela todos los trabajos en ejecución en la máquina y luego desconecta el UiPath Robot de Orchestrator.

Ejemplo:
```
UiRobot.exe disconnect --forceUiRobot.exe disconnect --force
```
--wait : espera a que se completen los trabajos en ejecución antes de desconectar el UiPath Robot de Orchestrator.

Ejemplo:
```
UiRobot.exe disconnect --waitUiRobot.exe disconnect --wait
```

Trace

Utiliza este comando para habilitar o deshabilitar el seguimiento de bajo nivel para el UiPath Robot.

El comando de seguimiento utiliza los siguientes argumentos:

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

--enableLowLevel : habilita el seguimiento detallado para el ejecutor de robot y el servicio en el visor de eventos. Genera un archivo ETL que puedes abrir con el Visor de eventos para obtener ayuda en la resolución de fallos y errores.

Ejemplo:
```
UiRobot.exe trace --enableLowLevelUiRobot.exe trace --enableLowLevel
```
--disableLowLevel : deshabilita el seguimiento detallado para el ejecutor y el servicio de UiPath Robot. Genera un archivo ETL que puedes abrir con el Visor de eventos para obtener ayuda en la resolución de fallos y errores.

Ejemplo:
```
UiRobot.exe trace --disableLowLevelUiRobot.exe trace --disableLowLevel
```

PiP

Utiliza este comando para habilitar o deshabilitar la sesión de UiPath Robot o la capacidad de imagen en imagen en la máquina. Esta configuración modifica las instalaciones existentes y se aplica a todos los usuarios en la máquina local. Requiere privilegios de administrador.

El comando PiP utiliza los siguientes argumentos:

UiRobot.exe pip --enable | --disableUiRobot.exe pip --enable | --disable

--enable : habilita la sesión de UiPath Robot (funcionalidad PiP) de la máquina.

Ejemplo:
```
UiRobot.exe pip --enableUiRobot.exe pip --enable
```
--disable : deshabilita la sesión de UiPath Robot (funcionalidad PiP) de la máquina.

Ejemplo:
```
UiRobot.exe pip --disableUiRobot.exe pip --disable
```

Otros argumentos

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

--version : muestra información sobre la versión del robot.
--help : muestra la lista de comandos compatibles, así como la información y los ejemplos correspondientes.
flushlogs [--timeout <timeout_in_seconds>] : envía todos los registros pendientes a Orchestrator.