Exécuter une tâche dans Orchestrator

Prérequis :

• Créez un processus dans Orchestrator.
• Exécutez le fichier CLI exe (pour Windows) ou dll (pour Linux).
• Ajoutez les étendues d'application d'accès à l'API Orchestrator requises.

Pour exécuter une tâche dans Orchestrator, procédez comme suit :

1. Exécutez la tâche job à l'aide de uipcli job. Vous pouvez maintenant remarquer une liste des sous-tâches disponibles.
2. Spécifiez les paramètres requis et exécutez la sous-tâche run .

   Le tableau suivant décrit les paramètres requis.

   Paramètre	Description
   -i ou --input_path (requis uniquement si le point d'entrée du workflow a des paramètres d'entrée)	Le chemin d'accès complet au fichier d'entrée JSON correspondant au processus que vous souhaitez exécuter. Exemple de format de fichier JSON : { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
   -P ou --priority	La priorité avec laquelle vous souhaitez exécuter la tâche :- Faible.- Normal (par défaut).- Élevé.
   -r ou --robots	Une liste de noms de robots spécifiques, séparés par des virgules.
   -j ou --jobscount	Le nombre de fois que vous souhaitez exécuter le processus. Le nombre d'exécutions par défaut du processus est de un.
   -U ou --user	Le nom de l’utilisateur. Il doit s’agir d’un utilisateur de machine, et non d’un utilisateur Orchestrator. Pour les utilisateurs locaux, le format doit être MachineName\UserName.
   -M ou --machine	Le nom de la machine sur laquelle vous souhaitez exécuter le processus.
   -R ou --result_path	Chemin d'accès complet à un fichier JSON ou à un dossier dans lequel vous souhaitez stocker les résultats de la tâche. Les résultats sont renvoyés sous forme de fichiers JSON.
   -W ou --timeout	Délai d’expiration des exécutions de tâches (secondes). La valeur par défaut est de 1 800 secondes.
   -f ou --fail_when_job_fails	La commande échoue lorsqu'une tâche échoue. La valeur par défaut est True.
   -w ou --wait	La commande attend que la tâche soit terminée. La valeur par défaut est True.
   -b ou --job_type (pour les dossiers modernes uniquement)	Type de runtime de la tâche. Vous pouvez choisir :- Unattended - NonProduction .
   -u ou --username (Requis si vous utilisez l'authentification de base, via un nom d'utilisateur et un mot de passe)	Le nom d'utilisateur utilisé pour l'authentification auprès d'Orchestrator. Vous devez l'associer au mot de passe correspondant.
   -p ou --password (Requis si vous utilisez l'authentification de base, via un nom d'utilisateur et un mot de passe)	Le mot de passe utilisé pour l'authentification auprès d'Orchestrator. Vous devez l'associer au nom d'utilisateur correspondant.
   -t ou --token (requis si vous utilisez l'authentification par jeton)	Jeton d'actualisation OAuth2 utilisé pour l'authentification auprès d'Orchestrator. Vous devez l'associer au Nom du compte et à l ' ID client.
   -a ou --accountName (requis si vous utilisez l'authentification par jeton)	Le nom du compte Orchestrator CloudRPA. Vous devez l'associer au jeton d'actualisation OAuth2 et à l' ID client.
   -A ou --accountForApp	Le nom du compte Orchestrator CloudRPA (nom de l’organisation). Vous devez l'associer à l 'ID d'application, à la clé secrète de l' application et à l'étendue de l'application pour l'application externe.
   -I ou --applicationId (requis si vous utilisez l'authentification d'application externe)	ID d’application externe Vous devez l'associer au compte d'application, à l'ID d'application et à l'étendue de l'application.
   -S ou --applicationSecret (requis si vous utilisez l'authentification d'application externe)	La clé secrète de l'application externe. Vous devez l'associer au compte d'application, à l'ID d'application et à l'étendue de l'application.
   --applicationScope (requis si vous utilisez l'authentification d'application externe)	La liste des étendues d'application, séparées par des espaces simples. Vous devez l’associer à l’ID d’application, à la clé secrète de l’ application et à l’étendue de l’application pour l’application externe
   -o ou --organizationUnit	Le nom du dossier Orchestrator (unité d'organisation). Pour saisir des sous-dossiers, assurez-vous de saisir à la fois le nom du dossier parent et le nom du sous-dossier. Par exemple, utilisez AccountingTeam\TeamJohn.
   -l, --language	La langue d'Orchestrator.
   -y, --disableTelemetry	Désactiver les données de télémétrie
   --traceLevel	Afficher la trace des événements.
   --identityUrl (Required for PaaS or MSI deployments)	L'URL de votre serveur d'identité.
   Process Name (pos.0) (requis)	Le nom du processus que vous souhaitez exécuter.
   Orchestrator URL (pos.1) (requis)	Il s'agit de l'URL de votre Orchestrator.
   Orchestrator Tenant (pos.2) (Obligatoire) pour les déploiements SaaP. (Facultatif) pour les déploiements PaaS.	Le locataire de l'instance d'Orchestrator, où vous souhaitez exécuter des processus.

Utilisation :

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 <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]

Exemples de commandes minimaux :

• 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 NomProcessus "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"