robot

2024.10

true

Robot admin guide

Last updated 18. Nov. 2024

Roboter-Befehlszeilenschnittstelle

Die UiPath-Roboter-Befehlszeilenschnittstelle ist ein Tool, mit dem Sie über ein Befehlszeilenterminal mit dem Roboter interagieren können. Es verwendet die UiRobot.exe -Datei, um Attended- und Unattended-Automatisierungen direkt über die Befehlszeile zu starten, zu stoppen oder zu überwachen. Sie können auch Details zu installierten Paketen abrufen, Protokolle erstellen oder Konfigurationen aktualisieren.

Wie es funktioniert

Um die CLI zu verwenden, stellen Sie die folgenden Aspekte sicher:

Der Roboterdienst wird ausgeführt
Sie befinden sich in dem Verzeichnis, in dem der Roboter installiert ist.

Geben Sie dann Anweisungen oder Befehle ein, die sich auf das UiRobot.exe -Programm beziehen, zusammen mit den erforderlichen Parametern, je nachdem, was Ihre Automatisierung erreichen soll.

Um beispielsweise einen Prozess über die Befehlszeile zu starten, würden Sie den folgenden Befehl verwenden:

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

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>]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 UiPathDemoProcessUiRobot.exe execute --process UiPathDemoProcess

UiRobot.exe execute -p UiPathDemoProcessUiRobot.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"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 OrchFolder1UiRobot.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 --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> (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"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\Main.xaml"

UiRobot.exe execute --file "C:\UiPath\Automation\Project.json"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 install process verwendet die folgenden Argumente:

UiRobot.exe installprocess [--process-name <process_name>] [--folder <orchestrator_folder>]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 MyProcessUiRobot 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 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 MyOrchestratorFolderUiRobot 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>]UiRobot.exe connect [--url <Orchestrator_Server_URL> --key <Machine_Key>] | [--connectionString <Connection_String>]

connect : Stellt die Verbindung zum Orchestrator her. Muss zusammen mit den Argumenten --url, --key oder --clientID --clientSecret verwendet werden. Wenn Sie diese Argumente nicht angeben, verwendet der Befehl die Konfiguration der Orchestrator-Einstellungen .

Beispiele:

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

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 | --waitUiRobot.exe disconnect --force | --wait

disconnect – Trennt den Roboter nur dann vom Orchestrator, wenn keine Aufträge auf der Robotermaschine ausgeführt werden.

Beispiel:
```
UiRobot.exe disconnectUiRobot.exe disconnect
```
--force – Beendet alle ausgeführten Aufträge auf der Maschine und trennt dann den Roboter vom Orchestrator.

Beispiel:
```
UiRobot.exe disconnect --forceUiRobot.exe disconnect --force
```
--wait – Wartet auf den Abschluss ausgeführter Aufträge, bevor der Roboter vom Orchestrator getrennt wird.

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

Ablaufverfolgung

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 | --disableLowLevelUiRobot.exe trace --enableLowLevel | --disableLowLevel

--enableLowLevel – Aktiviert eine ausführliche Ablaufverfolgung für den Roboter-Executor und -Dienst in der Ereignisanzeige. Sie generiert eine ETL-Datei, die Sie mit der Ereignisanzeige öffnen können, um Abstürzen und Fehler zu beheben.

Beispiel:
```
UiRobot.exe trace --enableLowLevelUiRobot.exe trace --enableLowLevel
```
--disableLowLevel : Deaktiviert die ausführliche Ablaufverfolgung für den Roboter-Executor und -Dienst. Sie generiert eine ETL-Datei, die Sie mit der Ereignisanzeige öffnen können, um Abstürzen und Fehler zu beheben.

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

BiB

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 | --disableUiRobot.exe pip --enable | --disable

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

Beispiel:
```
UiRobot.exe pip --enableUiRobot.exe pip --enable
```
--disable : Deaktiviert die Robotersitzung (BiB-Funktion) der Maschine.

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

Andere Argumente

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

--version – Zeigt Informationen über die 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.