Ausführen eines Auftrags im Orchestrator

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

Ausführen eines Auftrags im Orchestrator

Voraussetzungen

• Erstellen Sie einen Prozess im Orchestrator.
• Führen Sie die CLI-Datei exe (für Windows Legacy) oder dll (für Windows/Linux/maOS) 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 run -Unteraufgabe aus. In der folgenden Tabelle sind die erforderlichen Parameter beschrieben.

Parameter	Beschreibung
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)	Der Mandant der Orchestrator-Instanz, in der Sie Prozesse ausführen möchten. Erforderlich, wenn Sie die Automation Cloud als Ziel haben. Optional für die Automation Suite und den eigenständigen Orchestrator (lokale MSI), bei denen der Mandant Teil der URL ist.
-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. Unterstützte Werte: Runtimes der unbeaufsichtigten Automatisierung: Unattended, NonProduction, TestAutomation, Development, Headless Laufzeiten der beaufsichtigten Automatisierung: Attended, AssistantWeb Entwicklerlizenzen: RpaDeveloper, RpaDeveloperPro, CitizenDeveloper Studio-Lizenzen: Studio, StudioX, StudioPro, AttendedStudioWeb Cloud-/serverlose Laufzeiten: AutomationCloud, Serverless, AutomationKit, ServerlessTestAutomation, AutomationCloudTestAutomation Tests: AppTest, PerformanceTest Sonstiges: AgentService, Hosting, ProcessOrchestration
-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. Optional, wenn die Authentifizierung einer externen Anwendung verwendet wird, da Standard-Scopes automatisch angewendet werden. 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	Die URL Ihres Identity Servers. Erforderlich, wenn der Orchestrator auf der UiPath Automation Suite oder einem eigenständigen Orchestrator (lokale MSI) ausgeführt wird. Nicht erforderlich für Automation Cloud – die CLI löst den Identitätsserver von der Cloud-URL auf.
--ca-cert	Eine oder mehrere vertrauenswürdige Stammzertifikatdateien von Zertifizierungsstellen (PEM, DER oder PKCS#7), die beim Validieren der Orchestrator- und Identity Server-TLS-Zertifikate verwendet werden. Wiederholen Sie das Flag oder trennen Sie mehrere Pfade durch Komma. Weitere Informationen finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten .
--pinnedpubkey	Heften Sie den öffentlichen Schlüssel des Serverblattzertifikats an. Format: sha256//<base64>. Wird zusätzlich zur Standardzertifikatvalidierung aktiviert. Weitere Informationen finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten .

Tipp:

Für Orchestrator-Instanzen, die von einer privaten Zertifizierungsstelle signiert wurden (z. B. UiPath Automation Suite), akzeptiert dieser Befehl auch --ca-cert und --pinnedpubkey Parameter. Szenarien und Beispiele finden Sie unter Vertrauenswürdigen benutzerdefinierten Zertifikaten .

Hinweis:

Wenn Sie die Authentifizierung einer externen Anwendung verwenden, ohne den Parameter --applicationScope anzugeben, wendet die CLI automatisch diese standardmäßigen Orchestrator-Scopes an:

OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read

Warnung:

Wenn Sie den Parameter --applicationSecret in PowerShell-Skripten verwenden, können Sonderzeichen wie $ aufgrund der Variablenerweiterung von PowerShell in Zeichenfolgen mit doppelten Anführungszeichen zu unerwartetem Verhalten führen.

Verwenden Sie einfache Anführungszeichen ('') anstelle von doppelten Anführungszeichen ("") beim Übergeben des Parameters --applicationSecret , um zu verhindern, dass PowerShell Sonderzeichen interpretiert:

# Correct - single quotes treat the string literally
uipcli job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S 'mySecret$123' -o "MyFolder"

# Incorrect - double quotes allow variable expansion
uipcli job run ProcessName "https://cloud.uipath.com/" "default" -A "myOrg" -I "app-id" -S "mySecret$123" -o "MyFolder"

Nutzung

uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <RuntimeType>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Minimale Befehlsbeispiele

• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"
• uipcli job run ProcessName "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel "Information"