Ausführen eines Auftrags im Orchestrator

Voraussetzungen und Schritte zum Ausführen eines Auftrags innerhalb des Orchestrators mithilfe der CLI.

Voraussetzungen

• Erstellen Sie einen Prozess im Orchestrator.
• Führen Sie die CLI-Datei exe (für Windows) oder dll (für Linux) aus.
• Fügen Sie die erforderlichen Anwendungs-Scopes für den Zugriff auf die Orchestrator-API hinzu.

Um einen Auftrag innerhalb des Orchestrators auszuführen, führen Sie die folgenden Schritte aus:

1. Führen Sie die job-Aufgabe mit uipcli job aus. Jetzt sehen Sie eine Liste der verfügbaren Unteraufgaben.
2. Geben Sie die erforderlichen Parameter an, und führen Sie die Unteraufgabe run aus. Siehe die Liste der Parameter unten.

Parameter	Beschreibung
-i oder --input_path (Nur erforderlich , wenn der Einstiegspunkt des Workflows Eingabeparameter hat)	Der vollständige Pfad zur JSON-Eingabedatei, die dem auszuführenden Prozess entspricht. Weitere Informationen zur Dateistruktur finden Sie unter JSON-Format der Eingabeparameter .
-P , or --priority	Die Priorität, mit der Sie den Auftrag ausführen möchten:- Niedrig.- Normal (Standard).- Hoch.
-r , or --robots	Eine durch Kommas getrennte Liste bestimmter Roboternamen.
-j , or --jobscount	Die Häufigkeit, mit der Sie den Prozess ausführen möchten. Die Standardanzahl der Prozessausführungen ist eins.
-U , or --user	Der Name des Benutzers. Dies sollte ein Maschinenbenutzer sein, kein Orchestrator-Benutzer. Für lokale Benutzer ist das Format MaschinenName\\BenutzerName .
-M , or --machine	Der Name der Maschine, auf der Sie den Prozess ausführen möchten.
-R , or --result_path	Der vollständige Pfad zu einer JSON-Datei oder zu einem Ordner, in dem Sie die Ergebnisse des Auftrags speichern möchten. Die Ergebnisse werden als JSON-Dateien zurückgegeben.
-W , or --timeout	Das Timeout für Auftragsausführungen (Sekunden). Der Standardwert ist 1800 Sekunden.
-f , or --fail_when_job_fails	Der Befehl schlägt fehl, wenn ein Auftrag fehlschlägt. Der Standardwert dafür ist True .
-w , or --wait	Der Befehl wartet auf das Ende des Auftrags. Der Standardwert dafür ist True .
-b oder --job_type (nur für moderne Ordner)	Der Typ der Laufzeit für den Auftrag. Der Standardwert ist Unattended. Für diesen Befehl unterstützte Werte: Unattended, NonProduction
-u oder --username ( Erforderlich , wenn Sie die Standardauthentifizierung verwenden, über einen Benutzernamen und ein Kennwort)	Der Benutzername, der für die Authentifizierung bei Orchestrator verwendet wird. Sie müssen es mit dem entsprechenden Kennwort koppeln.
-p oder --password ( Erforderlich , wenn Sie die Standardauthentifizierung verwenden, über einen Benutzernamen und ein Kennwort)	Das Kennwort, das für die Authentifizierung beim Orchestrator verwendet wird. Sie müssen es mit dem entsprechenden Benutzernamen koppeln.
-t oder --token ( Erforderlich , wenn Sie tokenbasierte Authentifizierung verwenden )	Das OAuth2-Aktualisierungstoken, das für die Authentifizierung bei Orchestrator verwendet wird. Sie müssen es mit dem Kontonamen und der Client-ID koppeln.
-a oder --accountName ( Erforderlich , wenn Sie tokenbasierte Authentifizierung verwenden )	Der Name des Orchestrator CloudRPA-Kontos. Sie müssen es mit dem OAuth2-Aktualisierungstoken und der Client-ID koppeln.
-A , or --accountForApp	Der Name des Orchestrator CloudRPA-Kontos (Organisationsname). Sie müssen ihn mit der Anwendungs-ID, dem Anwendungsgeheimnis und dem Anwendungs-Scope für eine externe Anwendung koppeln.
-I oder --applicationId ( Erforderlich , wenn Sie die Authentifizierung einer externen Anwendung verwenden )	Die ID der externen Anwendung. Sie müssen es mit dem Anwendungskonto, dem Anwendungsgeheimnis und dem Anwendungs-Scope koppeln.
-S oder --applicationSecret ( Erforderlich , wenn Sie die Authentifizierung einer externen Anwendung verwenden )	Das Geheimnis externen Anwendung. Sie müssen es mit dem Anwendungskonto, der Anwendungs-ID und dem Anwendungs-Scope koppeln.
--applicationScope ( Erforderlich , wenn Sie die Authentifizierung einer externen Anwendung verwenden )	Die Liste der Anwendungs-Scopes, getrennt durch einzelne Leerzeichen. Sie müssen es mit dem Anwendungskonto, der Anwendungs-ID und dem Anwendungsgeheimnis für eine externe Anwendungen koppeln.
-o , or --organizationUnit	Der Name des Orchestrator-Ordners (Organisationseinheit). Um Unterordner einzugeben, geben Sie sowohl den Namen des übergeordneten Ordners als auch den Namen des Unterordners ein. Zum Beispiel AccountingTeam\TeamJohn.
-l , --language	Die Orchestrator-Sprache.
-y , --disableTelemetry	Deaktivieren der Telemetriedaten.
--traceLevel	Zeigt die Ablaufverfolgung der Ereignisse an.
--identityUrl ( Erforderlich für PaaS- oder MSI- Bereitstellungen)	Die URL Ihres Identitätsservers.
--help	Zeigt die Parameter und Beispiele für diesen Befehl an.
--version	Zeigt Versionsinformationen an.
Process Name (pos.0) ( Erforderlich )	Der Name des Prozesses, den Sie ausführen möchten.
Orchestrator URL (pos.1) ( Erforderlich )	Die URL der Orchestrator-Instanz.
Orchestrator Tenant (pos.2) ( Erforderlich ) für SaaP-Bereitstellungen. ( Optional ) für PaaS-Bereitstellungen.	Der Mandant der Orchestrator-Instanz, in der Sie Prozesse ausführen möchten.

Nutzung

job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-l <language>] [-b <RuntimeType>]

Beispiele

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Low
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Normal -o MyFolder
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P High -o MyFolder
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -f false -W 0
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P High -j 3 -w false
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P Low -r robotName -R C:\Temp
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -r robotName -R C:\Temp\status.json
• job run ProcessName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -r robotName -R C:\Temp\status.json