Comment démarrer une tâche

Une tâche est l'exécution d'un processus à l'aide d'un ou plusieurs robots. L'implémentation du processus Démarrer la tâche ( Start Job ) permet la création d'une nouvelle tâche en réponse à des événements qui se produisent au sein de votre plate-forme (hors de la plate-forme UiPath).

Points de terminaison et entrées

Le démarrage d'une tâche nécessite l'utilisation de requêtes GET et POST vers plusieurs points de terminaison de l'API Orchestrator. Les requêtes GET permettent de récupérer les valeurs des paramètres d'entrée requises pour la requête POST vers le point de terminaison StartJobs .

Que sont les paramètres d'entrée de StartJob ?

Pour envoyer avec succès des requêtes POST au point de terminaison StartJob , vous devez fournir au minimum une ReleaseKey (identifiant de processus) et une Stratégie (comment exécuter le processus) comme paramètres d'entrée. Selon la stratégie, il peut y avoir des paramètres d'entrée supplémentaires, notamment JobsCount ou RobotIds.

Comment obtenir les valeurs du paramètre d'entrée StartJob ?

Pour récupérer les paramètres d'entrée requis notés ci-dessus (c'est-à-dire, ReleaseKey et Stratégie), vous collectez les informations suivantes :

Nom de processus

Le nom du processus qui s'exécutera lors d'une requête StartJob réussie (pour plus d'informations sur les processus, consultez À propos des processus dans le guide Orchestrator).

Le nom du processus est utilisé pour récupérer la valeur ReleaseKey .

Il peut y avoir plusieurs instances d'un même processus qui se différencient par l'environnement dans lequel elles sont publiées. Pour cette raison, un seul Nom de processus peut entraîner plusieurs ReleaseKeys. Dans le cas où plusieurs ReleaseKeys sont associées à un processus, l' EnvironmentName peut être utilisé pour identifier la ReleaseKey du processus que l'utilisateur souhaite exécuter ( EnvironmentName est également utilisé pour identifier les robots disponibles, nous y reviendrons dans le prochain point) .

Pour récupérer à la fois la clé de version et le nom d' environnement d'un processus donné, envoyez une requête GET au point de terminaison Versions ( Releases ) en utilisant le nom du processus comme paramètre d'entrée (par exemple,

{{base
                           url}}/odata/Releases?$filter=ProcessKey eq
                           {{ProcessName}}

Remarque : La réponse de la requête Releases GET inclut également les exigences d'argument d'entrée pour le processus spécifique. Pour plus d'informations, consultez la puce Arguments d'entrée ( Input Arguments ) ci-dessous.

Strategy

Spécifie comment la tâche exécute le processus ; il y a trois options :

1. Spécifique

Le processus s'exécute sur un ou plusieurs robots spécifiques.

Lorsque Spécifique est sélectionné, le point de terminaison StartJob requiert le RobotId du robot que vous souhaitez utiliser pour exécuter le processus.

Pour récupérer l' IDRobot, envoyez une requête GET au point de terminaison GetEnvironments en utilisant le NomEnvironnement ( EnvironmentName ) comme paramètre d'entrée (p. ex.

{{base
                           url}}/odata/Environments?$expand=Robots&$filter=Name eq
                           {{_EnvironmentName_}}

Plusieurs RobotIds peuvent être inclus dans la réponse GetEnvironments . Pour identifier le RobotId correct, vous pouvez utiliser le nom du robot. Pour cette raison, il est recommandé de collecter ces informations lorsque Spécifique (Specific) est sélectionné.

2. NombreTâches (JobsCount)

Le processus s'exécute un nombre spécifié de fois à l'aide du prochain robot disponible.

Lorsque JobsCount est sélectionné, le point de terminaison StartJob requiert que le paramètre d'entrée JobsCount inclue une valeur. Pour cette raison, il est recommandé de fournir aux utilisateurs le moyen de saisir un nombre.

3. Tout

Le processus s'exécutera une fois sur tous les robots.

Arguments d'entrée (facultatif)

Le processus, spécifié par le Nom du processus (Process Name), peut nécessiter des arguments d'entrée. Ces arguments d'entrée sont généralement mappés aux champs de données associés à un objet d'application.

Par exemple, un système de gestion des problèmes peut avoir un objet Incident . Cet objet d' incident comprend plusieurs champs de données qui contiennent des informations pertinentes pour le processus (par exemple, IncidentId, DateCreated, Owner, etc.).

Comme indiqué ci-dessus, vous pouvez déterminer si un processus requiert des arguments d'entrée en analysant le bloc Arguments dans la réponse GET Releases (voir l'exemple de réponse ci-dessous).

Pour inclure ces valeurs de champ de données dans la requête StartJob POST, il est recommandé de fournir les moyens de sélectionner l'objet d'application et ses champs de données pertinents requis pour le processus. Lorsque la tâche est invoquée, le connecteur récupère les valeurs des champs de données et les ajoute à la requête POST en tant que valeur de paramètre InputArgument .

Remarque :

Vous pouvez également envoyer une requête GET au point de terminaison Processes_GetArgumentsByKey pour identifier si un processus comporte des arguments requis. L'avantage de ce point de terminaison est que la réponse inclut uniquement les détails de l'argument (c'est-à-dire, Entrée ( Input ) et Sortie ( Output).

L'inconvénient de ce point de terminaison, et la raison pour laquelle il n'est pas utilisé dans nos exemples, est qu'il nécessiterait que le connecteur effectue des requêtes GET supplémentaires pour récupérer les informations qui ont déjà été fournies dans la précédente réponse GET Releases (qui est nécessaire pour obtenir la valeur ReleaseKey ) .

{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }{
  "@odata.context": "https://platform.uipath.com/twTenantTest/twTenantTest/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "99587436-4ce5-480d-988c-6d7f43787a2c",
      "ProcessKey": "SupportTriage",
      "ProcessVersion": "1.0.1",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": "",
      "Name": "SupportTriage_QuickstartDemo",
      "EnvironmentId": 128912,
      "EnvironmentName": "QuickstartDemo",
      "InputArguments": null,
      "ProcessType": "Process",
      "SupportsMultipleEntryPoints": false,
      "RequiresUserInteraction": true,
      "AutoUpdate": false,
      "JobPriority": "Normal",
      "Id": 312722,
      "Arguments": {
        "Input": "[{\)\)"name\)\)":\)\)"IncidentId\)\)",\)\)"type\)\)":\)\)"System.String, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089\)\)",\)\)"required\)\)":true,\)\)"hasDefault\)\)":false}]",
        "Output": null
      },
      "ProcessSettings": null
    }

Exemples

Cette section fournit des liens vers des exemples d'interfaces utilisateur de connecteur et les requêtes de l'API Orchestrator correspondantes pour chaque champ d'entrée.

Dans ces exemples, nous introduisons le concept de Template. Un modèle représente l'association d'un objet et/ou d'un événement d'application avec un processus ou une file d'attente UiPath. Conceptuellement, un modèle vous donne la possibilité d'invoquer différentes ressources Orchestrator (par exemple, démarrer une tâche, ajouter un élément de file d'attente) lorsque différents événements se produisent dans votre application (par exemple, un nouvel objet créé, un changement de statut d'objet) tout en maintenant une seule connexion authentifiée.