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. Ist dies nicht der Fall, starten Sie ihn über das Dienste-Snap-In der Microsoft Management Console.

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 angezeigten Beispiele basieren auf der Annahme, dass Sie diese Aktion ausgeführt haben.

Allgemeine UiRobot.exe-Befehle

Ausführen

Verwenden Sie diesen Befehl, um die Ausführung einer Projektdatei der folgenden Typen zu starten:

• JSON
• XAML
• NUPKG
  Hinweis:

  Mit der Robot-Version 2023.4 und höher aktualisiert UiPath die Prozessliste gleichzeitig, wenn ein Prozess ausgeführt wird. Wenn beim Start des Auftrags ein Prozessupdate verfügbar ist, verwendet der Auftrag die ältere Version des Prozesses. Nachfolgende Ausführungen wenden den aktualisierten Prozess an.

Der Ausführungsbefehl verwendet die folgenden Argumente:

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

• -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\Project.json"

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

• --folder <Orchestrator_Folder_ID> (optional) – Ermöglicht die Angabe des Orchestrator-Ordners, aus dem der Zielprozess installiert und ausgeführt werden soll. Kann nur zusammen mit dem --process-Argument verwendet werden.

Beispiel:

UiRobot.exe -Execute --process UiPathDemoProcess --folder OrchFolder1

• --input <Input_Parameters> (optional) – Ermöglicht das Festlegen von Eingabeargumenten für die Ausführung. Es kann mit den Argumenten --processoder --fileverwendet 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> (optional) – 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 plattformübergreifende Projekte nicht unterstützt:

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

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

• Sie können die Argumente --process (-p) und --file (-f) nicht gleichzeitig im Ausführungsbefehl verwenden.

Prozess installieren

Verwenden Sie diesen Befehl, um einen Prozess zu installieren. Wenn der Roboter mit dem Orchestrator verbunden ist, sucht er im Orchestrator-Feed nach dem Prozess. Ohne Orchestrator-Verbindung verwendet der Roboter den lokalen Feed.

Der Befehl für den Installationsprozess verwendet die folgenden Argumente:

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

• --process-name <process_name> (obligatorisch) – Der Name des Prozesses, den Sie installieren möchten.

  Beispiel:

  UiRobot installprocess --process-name MyProcess
  

• --folder <orchestrator_folder> (optional) – Der Name des Orchestrator-Ordners, der den zu installierenden Prozess enthält. Dieses Argument gilt nur, wenn die Verbindung mit dem Orchestrator aktiv ist. Wenn nur ein Ordner den Prozess für die Installation enthält, überspringen Sie diesen Parameter.

  Beispiel:

  UiRobot installprocess -p MyProcess --folder MyOrchestratorFolder
  

Verbinden

Verwenden Sie diesen Befehl, um Ihren Roboter mit einer Orchestrator-Instanz zu verbinden. Wenn Ihr Roboter bereits mit dem Orchestrator verbunden ist und Sie diesen Befehl ausführen, wird die Meldung „Orchestrator bereits verbunden“ zurückgegeben.

Der Verbindungsbefehl verwendet die folgenden Argumente:

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

• connect – Stellt die Verbindung zum Orchestrator her. Die Argumente müssen zusammen mit den Argumenten --url, --key, oder --clientID --clientSecretverwendet werden.Wenn Sie diese Argumente nicht angeben, verwendet der Befehl die Konfiguration Orchestrator-Einstellungen.

Beispiele:

// 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 client ID and secret

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

Trennen

Verwenden Sie diesen Befehl, um den Roboter von der aktuellen Orchestrator-Instanz zu trennen.

Der Befehl zum Trennen verwendet die folgenden Argumente:

UiRobot.exe disconnect --force | --wait

• disconnect – Trennt den Roboter nur dann vom Orchestrator, wenn auf der Robotermaschine keine laufenden Aufträge vorhanden sind.

  Beispiel:

  UiRobot.exe disconnect
  

• --force – Beendet alle auf der Maschine ausgeführten Aufträge und trennt dann die Verbindung des Roboters mit dem Orchestrator.

  Beispiel:

  UiRobot.exe disconnect --force
  

• --wait – Wartet auf den Abschluss von ausgeführten Aufträgen, bevor der Roboter vom Orchestrator getrennt wird.

  Beispiel:

  UiRobot.exe disconnect --wait
  

Nachverfolgung

Verwenden Sie diesen Befehl, um die Ablaufverfolgung auf niedriger Ebene für den Roboter zu aktivieren oder zu deaktivieren.

Der Ablaufverfolgungsbefehl verwendet die folgenden Argumente:

UiRobot.exe trace --enableLowLevel | --disableLowLevel

• --enableLowLevel – Aktiviert eine Verbose-Ablaufverfolgung für den Roboter-Executor und -Dienst in der Ereignisanzeige. Es wird eine ETL-Datei generiert, die Sie in der Ereignisanzeige öffnen können, die bei der Fehlerbehebung bei Abstürzen und Fehlern hilft.

  Beispiel:

  UiRobot.exe trace --enableLowLevel
  

• --disableLowLevel – Deaktiviert die Verbose-Ablaufverfolgung für den Roboter-Executor und -Dienst. Es wird eine ETL-Datei generiert, die Sie in der Ereignisanzeige öffnen können, die bei der Fehlerbehebung bei Abstürzen und Fehlern hilft.

  Beispiel:

  UiRobot.exe trace --disableLowLevel
  

PiP

Verwenden Sie diesen Befehl, um die Robotersitzung oder die Bild-in-Bild-Funktion auf der Maschine zu aktivieren oder zu deaktivieren. Diese Einstellung ändert vorhandene Installationen und gilt für alle Benutzer auf der lokalen Maschine. Erfordert Administratorrechte.

Der BiB-Befehl verwendet die folgenden Argumente:

UiRobot.exe pip --enable | --disable

• --enable – Aktiviert die Robotersitzung (PiP-Funktionalität ) der Maschine.

  Beispiel:

  UiRobot.exe pip --enable
  

• --disable – Deaktiviert die Robotersitzung (BiB-Funktion) der Maschine.

  Beispiel:

  UiRobot.exe pip --disable
  

Andere Argumente

Die folgenden Argumente sind rein informativ und haben keine Auswirkungen auf Ihre Automatisierungsprojekte:

• --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.