Interface de ligne de commande

L'Interface de ligne de commande du Robot (Robot Command Line Interface) (UiRobot.exe) est une application de console qui peut demander le démarrage des tâches et attendre leur sortie. Il s'agit d'un client direct du service Robot, et la communication s'effectue via un canal WCF.

Afin de pouvoir utiliser les arguments de ligne de commande pris en charge par les Robots, veuillez vérifier que le service du Robot UiPath est bien en cours d'exécution. Si ce n'est pas le cas, executez-le à partir du composant enfichable dans Services Microsoft Management Console.

Pour faciliter l'emploi des arguments de ligne de commande, utilisez la commande CD (Change Directory) pour accéder au dossier d'installation du Robot. Par exemple, si vous n'avez pas modifié le répertoire par défaut du robot, le chemin sera : 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.

Description des arguments

our simplifier la gestion des arguments de ligne de commande, accédez au répertoire dans lequel le Robot est installé à l'aide de la commande change directory. Par exemple, si vous n'avez pas modifié le répertoire par défaut du Robot, vous pouvez utiliser la commande suivante :

cd C:\Program Files\UiPath\Studio.

Tous les exemples affichés ici sont basés sur l'hypothèse selon laquelle vous avec exécuté la commande ci-dessus.

Les Robots Attended doivent uniquement s'exécuter sous supervision d'un humain.

Commande Execute

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

Cette commande est utilisée pour démarrer l'exécution d'un processus ou d'un fichier (.json, .xaml ou .nupkg). Notez que les arguments --process (-p) et --file (-f) ne peuvent pas être utilisés simultanément à l'aide de la commande execute. Elle prend en charge les arguments suivants :

Argument	Description
-p--process <Package_ID>	Obligatoire. Démarre l'exécution d'un processus local ou d'Orchestrator. Exemples : 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. Exemples : 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. Exemple : 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. Exemples : 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	Permet de sélectionner le point d'entrée d'un processus lorsque vous le démarrez via la ligne de commande. Exemples : 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 Portable:

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

Commande Pack

Remarque :

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

Cette commande est utilisée pour empaqueter un fichier Project.json dans un fichier .nupkg. Elle prend en charge les arguments suivants :

Argument	Description
-o --output <Destination_Folder>	Obligatoire. Permet de spécifier l'emplacement de création du fichier .nupkg. Exemple : UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"
-v <Project_Version>	Facultatif. Permet de spécifier une version du fichier .nupkg. Exemple : UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

Commande Connect

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

  Remarque :

  Si le robot est déjà connecté, l’exécution de la commande connect renvoie le message suivant : Orchestrator already connected!.

Cette commande permet de connecter le Robot à une instance d'Orchestrator. Elle prend en charge les arguments suivants :

Argument

Description

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. Exemple : UiRobot.exe connect Exemple de clé de machine : UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00 Exemple d'ID de client et de clé secrète du client : UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

Commande Disconnect

• UiRobot.exe disconnect

Cette commande permet de déconnecter le Robot de l'instance d'Orchestrator actuelle.

Commande Trace

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

Cette commande permet d'activer ou de désactiver le traçage de niveau inférieur (détaillé) pour le Robot. Elle prend en charge les arguments suivants :

Argument	Description
--enableLowLevel	Activer le traçage de niveau inférieur. Active le traçage de niveau inférieur. Un fichier .etl est généré, qui peut être ouvert à l'aide de l'Observateur d’événements, pour vous aider à résoudre les incidents et les erreurs. Cela active le traçage détaillé pour l'exécuteur et le service Robot dans l'Observateur d’événements. Exemple : UiRobot.exe trace --enableLowLevel
--disableLowLevel	Désactiver le traçage de niveau inférieur. Un fichier .etl est généré dans le Poste de travail après l'avoir arrêté. Celui-ci peut être ouvert à l'aide de l'Observateur d’événements, pour vous aider à résoudre les incidents et les erreurs rencontrés. Exemple : UiRobot.exe trace --disableLowLevel

La commande PiP

Vous permet d’activer ou de désactiver la fonctionnalité Incrustation d'image sur la machine. Ce paramètre est appliqué sur la machine locale et affecte tous les utilisateurs, et est utilisé pour modifier les installations existantes.

Vous devez disposer de droits d'administrateur pour exécuter ces commandes.

Commande	Description
PiP --enable	Active la fonctionnalité Incrustation d'image sur la machine.
PiP --disable	Désactive la fonctionnalité Incrustation d'image de la machine.

La commande ENABLE_PIP

Vous permet d’activer la fonctionnalité Incrustation d'image de la machine lors de l’installation de la ligne de commande UiPath.

Commande	Description
ENABLE_PIP=1	Active la fonctionnalité Incrustation d'image sur la machine.
ENABLE_PIP=0	N'active pas la fonctionnalité Incrustation d'image de la machine.

Commandes diverses

Les commandes suivantes sont purement informatives et n’ont pas le moindre impact sur vos projets d’automatisation :

Argument	Description
--version	Affiche des informations sur la version de Robot.
--help	Affiche la liste des commandes prises en charge, ainsi que les informations et exemples correspondants.
logs --flush	Envoie tous les journaux en attente à Orchestrator.