robot

2024.10

true

Robot admin guide

Last updated 18 nov. 2024

Interface de ligne de commande du Robot

L' Interface de ligne de commande du Robot UiPath est un outil qui permet d'interagir avec le Robot à partir d'un terminal de ligne de commande. Il utilise le fichier UiRobot.exe pour démarrer, arrêter ou surveiller les automatisations assistées et non assistées directement à partir de la ligne de commande. Vous pouvez également obtenir des détails sur les packages installés, créer des journaux ou mettre à jour les configurations.

Mode de fonctionnement

Pour utiliser la CLI, assurez-vous des aspects suivants :

Le service de robot UiPath est en cours d'exécution
Vous êtes dans le répertoire dans lequel le Robot est installé.

Entrez ensuite les instructions ou les commandes qui font référence au programme UiRobot.exe ainsi que les paramètres nécessaires, en fonction de l'objectif de votre automatisation.

Par exemple, pour démarrer un processus à partir de la ligne de commande, vous utiliseriez la commande suivante :

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

Commandes UiRobot.exe courantes

Exécuter

Utilisez cette commande pour démarrer l’exécution d’un fichier de projet des types suivants :

JSON
XAML
NUPKG

Remarque :

À partir de la version 2023.4 de Robot et des versions ultérieures, UiPath actualise la liste des processus au moment où un processus s'exécute. Si une mise à jour de processus est disponible au démarrage de la tâche, celle-ci utilise l'ancienne version du processus. Les exécutions suivantes appliquent le processus mis à jour.

La commande d'exécution utilise les arguments suivants :

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> (obligatoire) - Démarre l'exécution d'un processus local ou d'Orchestrator.

Exemples :

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

UiRobot.exe execute -p UiPathDemoProcessUiRobot.exe execute -p UiPathDemoProcess

-f--file <File_Path> (obligatoire) - Démarre l'exécution d'un fichier projet local. Le fichier cible peut être JSON, XAML ou NUPKG.

Exemples :

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> (facultatif) : permet de spécifier le dossier Orchestrator à partir duquel installer et exécuter le processus cible. Il ne peut être utilisé qu'avec l'argument --process .

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

--input <Input_Parameters> (facultatif) : permet de spécifier des arguments d'entrée pour l'exécution. Il peut être utilisé avec les arguments --process ou --file .

Exemples :

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> (facultatif) - Permet de sélectionner le point d'entrée d'un processus lorsque vous le démarrez via la ligne de commande.

Exemple :

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"

Important :

Les commandes suivantes ne sont pas prises en charge pour les projets Windows ou multiplateformes :

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"

Vous ne pouvez pas utiliser les arguments --process (-p) et --file (-f) simultanément dans la commande d'exécution.

Installer le processus

Utilisez cette commande pour installer un processus. Si le robot est connecté à Orchestrator, il recherche le processus dans le flux Orchestrator. Sans connexion à Orchestrator, le robot utilise le flux local.

La commande de processus d'installation utilise les arguments suivants :

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

--process-name <process_name> (obligatoire) : le nom du processus que vous souhaitez installer.

Exemple :
```
UiRobot installprocess --process-name MyProcessUiRobot installprocess --process-name MyProcess
```
--folder <orchestrator_folder> (facultatif) - Le nom du dossier Orchestrator contenant le processus que vous souhaitez installer. Cet argument s'applique uniquement lorsque la connexion à Orchestrator est active. Si un seul dossier contient le processus d'installation, ignorez ce paramètre.

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

Se connecter (Connect)

Utilisez cette commande pour connecter votre Robot à une instance d'Orchestrator. Si votre robot est déjà connecté à Orchestrator et que vous exécutez cette commande, il renvoie le message « Orchestrator déjà connecté ».

La commande de connexion utilise les arguments suivants :

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 - Établit la connexion à Orchestrator. Doit être utilisé avec les arguments --url, --key ou --clientID --clientSecret . Si vous ne spécifiez pas ces arguments, la commande utilise la configuration Paramètres d'Orchestrator (Orchestrator Settings).

Exemples :

// 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

Se déconnecter (Disconnect)

Utilisez cette commande pour déconnecter le Robot de l'instance d'Orchestrator actuelle.

La commande de déconnexion utilise les arguments suivants :

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

disconnect : déconnecte le Robot d'Orchestrator uniquement lorsqu'il n'y a pas de tâches en cours d'exécution sur la machine robot.

Exemple :
```
UiRobot.exe disconnectUiRobot.exe disconnect
```
--force - Arrête toutes les tâches en cours d'exécution sur la machine, puis déconnecte le Robot d'Orchestrator.

Exemple :
```
UiRobot.exe disconnect --forceUiRobot.exe disconnect --force
```
--wait - attend la fin des tâches en cours d'exécution avant de déconnecter le Robot d'Orchestrator.

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

Traçage (Trace)

Utilisez cette commande pour activer ou désactiver le traçage de niveau inférieur pour le Robot.

La commande de traçage utilise les arguments suivants :

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

--enableLowLevel - Active le traçage détaillé pour l'exécuteur et le service Robot dans l'observateur d'événements. Il génère un fichier ETL que vous pouvez ouvrir avec l'Observateur d'événements pour obtenir de l'aide dans la résolution des incidents et des erreurs.

Exemple :
```
UiRobot.exe trace --enableLowLevelUiRobot.exe trace --enableLowLevel
```
--disableLowLevel : désactive le traçage détaillé pour l'exécuteur et le service Robot. Il génère un fichier ETL que vous pouvez ouvrir avec l'Observateur d'événements pour obtenir de l'aide dans la résolution des incidents et des erreurs.

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

PiP

Utilisez cette commande pour activer ou désactiver la session Robot ou la capacité d’incrustation d’image sur la machine. Ce paramètre modifie les installations existantes et s'applique à tous les utilisateurs de la machine locale. Nécessite des privilèges administrateurs.

La commande PiP utilise les arguments suivants :

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

--enable : active la session Robot (fonctionnalité PiP) de la machine.

Exemple :
```
UiRobot.exe pip --enableUiRobot.exe pip --enable
```
--disable – désactive la session Robot (fonctionnalité PiP) de la machine.

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

Autres arguments

Les arguments suivants sont purement informatifs et n’ont aucun impact sur vos projets d’automatisation :

--version : affiche des informations concernant la version du Robot.
--help - Affiche la liste des commandes prises en charge, ainsi que les informations et exemples correspondants.
flushlogs [--timeout <timeout_in_seconds>] : envoie tous les journaux en attente à Orchestrator.