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 permet la création d'une nouvelle tâche en réponse à des événements qui se produisent sur votre plate-forme (en dehors 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 sont utilisées pour récupérer les valeurs des paramètres d'entrée requises pour la requête POST au point de terminaison StartJobs .

What are the StartJob input parameters?

To successfully send POST requests to the StartJob endpoint, you must provide at a minimum, a ReleaseKey (process identifier) and Strategy (how to run the process) as input parameters. Depending on the Strategy, there may be additional input parameters including JobsCount or RobotIds.

How do I get the StartJob input parameter values?

To retrieve the required input parameters noted above (i.e., ReleaseKey and Strategy), you collect the following information:

Nom de processus

The name of the process that will run upon a successful StartJob request (for more information, about processes see About Processes in the Orchestrator Guide).

The process name is used to retrieve the ReleaseKey value.

There may be multiple instances of the same process that are differentiated by the environment they're published in. Because of this, a single Process Name can result in multiple ReleaseKeys. In the event that there are multiple ReleaseKeys associated with a process, the EnvironmentName can be used to identify the ReleaseKey of the process the user wants to run (the EnvironmentName is also used to identify the available robots, more on that in the next bullet).

Pour récupérer à la fois les variables ReleaseKey et EnvironmentName d’un processus donné, envoyez une requête GET au point de terminaison Releases en utilisant le Nom du processus comme paramètre d’entrée (par ex., {{base url}}/odata/Releases?$filter=ProcessKey eq {{ProcessName}}).

• API
• Swagger
• Facteur

Remarque :

La réponse de la requête GET de version inclut également les exigences d’argument d’entrée pour le processus spécifique. Pour plus d'informations, consultez la section Arguments d'entrée 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.

When Specific is selected, the StartJob endpoint requires the RobotId of the robot that you want to use to run the process.

Pour récupérer l' objet RobotId, envoyez une requête GET au point de terminaison GetEnvironments en utilisant EnvironmentName comme paramètre d'entrée (par exemple, {{base url}}/odata/Environments?$expand=Robots&$filter=Name eq {{_EnvironmentName_}}).

• API
• Swagger
• Facteur

Multiple RobotIds may be included in the GetEnvironments response. To identify the correct RobotId, you can use the Robot Name. Because of this, it's recommended that you collect this information when Specific is selected.

2. NombreTâches (JobsCount)

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

When JobsCount is selected, the StartJob endpoint requires the JobsCount input parameter to include a value. Because of this, it's recommended that you provide means for a user to enter a number.

3. Tout

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

Arguments d'entrée (facultatifs)

The process, specified by the Process Name, may require input arguments. These input arguments typically map to data fields associated with an application object.

For example, an issue management system may have an Incident object. This Incident object includes several data fields that contain information relevant to the process (e.g., IncidentId, DateCreated, Owner, etc.).

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

To include these data field values in the StartJob POST request, it's recommended that you provide the means to select the application object and its relevant data fields required for the process. When the job is invoked, the connector retrieves the data field values and adds them in the POST request as the InputArgument parameter value.

Remarque :

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

L'inconvénient de ce point de terminaison, et pourquoi il n'est pas utilisé dans nos exemples, est que cela nécessiterait que le connecteur effectue des requêtes GET supplémentaires pour récupérer des 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
    }

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.

In these examples, we introduce the concept of a Template. A template represents an association of an application object and/or event with a UiPath process or queue. Conceptually, a template gives you the ability to invoke different Orchestrator resources (e.g., start a job, add a Queue item) when different events occur within your application (e.g., new object created, object status change) while maintaining a single authenticated connection.

• Démarrer une tâche - Spécifique
• Démarrer une tâche - JobsCount
• Démarrer une tâche - Tout