Befehlszeilenschnittstelle

Die Roboter-Befehlszeilenschnittstelle (UiRobot.exe) ist eine Konsolenanwendung, die Aufträge starten kann und auf ihre Ausgabe wartet. Es handelt sich um einen direkten Client des Roboterdienstes, und die Kommunikation erfolgt über einen WCF-Kanal.

Um die von den Robotern unterstützten Kommandozeilenargumente nutzen zu können, müssen Sie sicherstellen, dass der UiPath^® Robot-Dienst läuft. Wenn dies nicht der Fall ist, starten Sie ihn über das Snap-In der Microsoft Management Console für Dienste.

Um sich die Arbeit mit Kommandozeilenargumenten zu erleichtern, navigieren Sie mithilfe des Befehls Verzeichnis wechseln (cd) zu dem Verzeichnis, in dem der Roboter installiert ist. Wenn Sie zum Beispiel das Standardverzeichnis des Roboters nicht verändert haben, können Sie Folgendes verwenden: cd C:\Program Files\UiPath\Studio.

Alle im Kapitel Beschreibung der Argumente dargestellten Beispiele bauen darauf auf, dass Sie diese Aktion durchgeführt haben.

Beschreibung der Argumente

Um sich die Arbeit mit Befehlszeilenargumenten zu erleichtern, navigieren Sie mithilfe des Befehls "Verzeichnis wechseln" (cd) zu dem Verzeichnis, in dem der Roboter installiert ist. Wenn Sie zum Beispiel das Standardverzeichnis des Roboters nicht verändert haben, können Sie den folgenden Befehl verwenden:

cd C:\Program Files\UiPath\Studio.

Alle hier dargestellten Beispiele bauen auf der Annahme auf, dass Sie zuerst den Befehl oben ausgeführt haben.

Attended-Roboter dürfen nur unter Aufsicht eines Mitarbeiters laufen.

Der Execute-Befehl

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

Dieser Befehl wird verwendet, um die Ausführung eines Prozesses oder einer Datei (.json, .xaml, oder .nupkg) zu starten. Bitte beachten Sie, dass die Argumente --process (-p) und --file (-f) nicht gleichzeitig mit dem execute-Befehl verwendet werden können. Er unterstützt die folgenden Argumente:

Hinweis: Ab Version v2023.4 wird die Prozessliste parallel zur Prozessausführung aktualisiert, davor wurde die Prozessliste vor dem Start des Prozesses erneuert. Das bedeutet, dass beim Ausführen eines Prozesses, für den ein Update verfügbar ist, der Auftrag möglicherweise mit der älteren Version des Prozesses ausgeführt wird.

Argument	Beschreibung
-p--process <Package_ID>	Obligatorisch. Startet die Ausführung eines lokalen oder Orchestrator-Prozesses. Beispiele: UiRobot.exe execute --process UiPathDemoProcess UiRobot.exe execute -p UiPathDemoProcess
-f--file <File_Path>	Obligatorisch. Startet die Ausführung einer lokalen Projektdatei. Die Zieldatei kann .json, .xaml oder .nupkg sein. Beispiele: 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. Hier können Sie den Orchestrator-Ordner angeben, aus dem der Zielprozess installiert und ausgeführt werden soll. Kann nur zusammen mit dem Argument --process verwendet werden. Beispiel: UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1
--input <Input_Parameters>	Optional. Ermöglicht das Angeben von Eingabeargumenten für die Ausführung. Kann mit den Argumenten --process oder --file verwendet werden. Beispiele: 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>	Ermöglicht es Ihnen, den Einstiegspunkt eines Prozesses auszuwählen, wenn Sie ihn über die Befehlszeile starten. Beispiel: UiRobot execute --file "C:\UiPath\Project\project.1.0.3.nupkg" --input "{'inArg':'value','integer':3}" --entry "OtherEntryPoint.xaml"

Wichtig: Die folgenden Befehle werden für Windows- oder Portable-Projekte nicht unterstützt:

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

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

Der Install Process-Befehl

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

Der Befehl installprocess wird verwendet, um einen Prozess zu installieren. Wenn der Roboter mit dem Orchestrator verbunden ist, sucht der Roboter nur im Orchestrator-Feed nach dem Prozess. Wenn der Roboter nicht mit dem Orchestrator verbunden ist, wird der lokale Feed verwendet.

Die folgenden Argumente werden unterstützt:

Argument	Beschreibung
--process-name <process_name>	Obligatorisch. Der Name des zu installierenden Prozesses. Beispiel: UiRobot installprocess --process-name MyProcess
--folder <orchestrator_folder>	Optional. Der Name des Orchestrator-Ordners, in dem sich der zu installierende Prozess befindet. Dieses Argument kann nur verwendet werden, wenn der Roboter mit dem Orchestrator verbunden ist. Wenn sich der zu installierende Prozess nur in einem Ordner befindet, wird der Parameter nicht benötigt. Beispiel: UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder

Der Pack-Befehl

Hinweis: Für Studio v2018.4.4 und spätere Versionen empfehlen wir die Veröffentlichung mit dem Befehl UiPath.Studio.CommandLine.exe publish anstelle von UiRobot.exe pack. Weitere Informationen finden Sie im Studio-Handbuch unter Massenhafte Aktualisierung von Befehlszeilenparametern.

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

Dieser Befehl wird verwendet, um eine Project.json-Datei in eine .nupkg-Datei zu packen. Er unterstützt die folgenden Argumente:

Argument	Beschreibung
-o --output <Destination_Folder>	Obligatorisch. Ermöglicht es Ihnen, anzugeben, wo die .nupkg-Datei erstellt wird. Beispiel: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages"
-v <Project_Version>	Optional. Ermöglicht es Ihnen, eine Version für die .nupkg-Datei anzugeben. Beispiel: UiRobot.exe pack "C:\UiPath\Automation\Project.json" --output "C:\UiPath\Automation\Packages" -v 1.0.6820.22047

Der Connect-Befehl

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

  Hinweis: Wenn der Roboter bereits verbunden ist, gibt das Ausführen des Befehls connect die folgende Meldung zurück: Orchestrator already connected!.

Dieser Befehl wird verwendet, um den Roboter mit einer Orchestrator-Instanz zu verbinden. Er unterstützt die folgenden Argumente:

Argument

Beschreibung

connect

Wird verwendet, um den Roboter mit dem Orchestrator zu verbinden, muss mit den Argumenten --url, --key oder --clientID --clientSecret verwendet werden. Wenn die Argumente nicht angegeben sind, wird die Orchestrator-Konfiguration im Assistant verwendet, um die Verbindung herzustellen. Beispiel: UiRobot.exe connect Beispiel für einen Maschinenschlüssel: UiRobot.exe connect --url https://demo.uipath.com/ --key 1122AAB3C-DD44-ABCD-1234-7788GG99HH00 Beispiel für die Client-ID und den geheimen Clientschlüssel: UiRobot.exe connect --url https://demo.uipath.com/ --clientID 696CCA0C-1234-ABCD-1234-F65BBC2F15DE --clientSecret QJX!jv12345A4q4N

Der Disconnect-Befehl

Dieser Befehl wird verwendet, um den Roboter von der aktuellen Orchestrator-Instanz zu trennen.

Argument	Beschreibung
UiRobot.exe disconnect	Trennt den Roboter vom Orchestrator. Dieser Befehl funktioniert nur, wenn keine Aufträge auf der Robotermaschine ausgeführt werden.
UiRobot.exe disconnect --force	Trennt den Roboter vom Orchestrator. Wenn auf der Maschine ein Auftrag ausgeführt wird, wird der Auftrag beendet und der Roboter erst danach getrennt.
UiRobot.exe disconnect --wait	Trennt den Roboter vom Orchestrator. Wenn auf der Maschine ein Auftrag ausgeführt wird, wird der Roboter erst nach Abschluss des Auftrags getrennt.

Der Trace-Befehl

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

Dieser Befehl wird verwendet, um Nachverfolgung auf niedriger Stufe (ausführlich) für den Roboter zu aktivieren oder zu deaktivieren. Er unterstützt die folgenden Argumente:

Argument	Beschreibung
--enableLowLevel	Ablaufverfolgung auf niedriger Ebene aktivieren. Aktiviert die Nachverfolgung auf niedriger Stufe. Eine .etl-Datei wird generiert, die in der Ereignisanzeige geöffnet werden kann, um Sie bei der Fehlersuche und -behebung von Abstürzen und Fehlern zu unterstützen. Damit wird die ausführliche Nachverfolgung für den Robot Executor und -Dienst in der Ereignisanzeige aktiviert. Beispiel: UiRobot.exe trace --enableLowLevel
--disableLowLevel	Ablaufverfolgung auf niedriger Ebene deaktivieren Nach dem Anhalten wird auf dem Desktop eine .etl-Datei generiert. Diese Datei kann in der Ereignisanzeige geöffnet werden, um Sie bei der Fehlersuche und -behebung von Abstürzen und Fehlern zu unterstützen. Beispiel: UiRobot.exe trace --disableLowLevel

Der BiB-Befehl

Ermöglicht das Aktivieren oder Deaktivieren der Bild-in-Bild-Funktion der Maschine. Diese Einstellung wird auf der lokalen Maschine angewendet und betrifft alle Benutzer und wird zum Ändern vorhandener Installationen verwendet.

Zur Durchführung dieser Anweisungen sind Administratorrechte erforderlich.

Befehl	Beschreibung
PiP --enable	Aktiviert die Bild-in-Bild-Funktion der Maschine.
PiP --disable	Deaktiviert die Bild-in-Bild-Funktion der Maschine.

Der Befehl ENABLE_PIP

Ermöglicht Ihnen die Aktivierung der Bild-in-Bild-Funktion der Maschine während der Installation der UiPath^®-Befehlszeile.

Befehl	Beschreibung
ENABLE_PIP=1	Aktiviert die Bild-in-Bild-Funktion der Maschine.
ENABLE_PIP=0	Aktiviert nicht die Bild-in-Bild-Funktion der Maschine.

Verschiedene Befehle

Die folgenden Befehle sind rein informativ und haben keinerlei Auswirkungen auf Ihre Automatisierungsprojekte:

Argument	Beschreibung
--version	Zeigt Informationen zur Roboterversion an.
--help	Zeigt die Liste der unterstützten Befehle sowie die entsprechenden Informationen und Beispiele an.
flushlogs [--timeout <timeout_in_seconds>]	Sendet alle ausstehenden Protokolle an den Orchestrator.