Gestion des déclencheurs d'API

Créer un déclencheur d'API

1. Dans un dossier, accédez à Automatisations > Déclencheurs > Déclencheurs d'API.
2. Cliquez sur Ajouter un nouveau déclencheur (Add a new trigger). La fenêtre Créer un déclencheur d'API (Create a new API Trigger) s'affiche.
3. Dans le menu déroulant Nom du processus, sélectionnez un processus sous-jacent pour votre déclencheur.
4. Le champ Nom est prérempli avec le nom du processus, suivi du type de déclencheur au format <ProcessName>_<TriggerType>. Le nom du déclencheur peut cependant être modifié si vous le souhaitez.
5. Dans le menu déroulant Priorité de la tâche (Job Priority), sélectionnez la priorité de la tâche. La valeur par défaut est Inherited, ce qui signifie que la priorité de la tâche est la même que celle définie pour le processus sélectionné.
6. Dans le menu déroulant Licence de runtime (Runtime license), sélectionnez le runtime utilisé pour exécuter les tâches lancées par le déclencheur.
7. Dans l'onglet Arguments, fournissez des valeurs pour les arguments d'entrée, si votre processus en possède. Plus de détails sur les arguments d'entrée et de sortie.
8. Dans le menu déroulant Verbe, sélectionnez l'option qui décrit l'action que votre tâche devra effectuer : DELETE, GET, POST et PUT.
9. Dans le champ Champ de données dynamique, saisissez un champ de données dynamique qui sera ajouté à l’URL de base, ce qui aura pour effet de générer l’URL finale du point de terminaison résultant, que vous allez utiliser dans votre application. Vous pouvez voir un aperçu de l'URL complète sous ce champ.
   Le champ de données dynamique par défaut est ${Process_Name}, mais vous pouvez le personnaliser afin de vous assurer qu'il est unique au niveau du locataire.

   Veuillez noter que les barres obliques ne sont pas prises en charge.

10. Dans le menu déroulant Mode d'appel par défaut, sélectionnez le mode d'appel souhaité. Les options disponibles sont les suivantes :

    • Interrogation asynchrone (il s'agit de la valeur par défaut, mais celle-ci peut être modifiée)

    • Déclenchement et oubli asynchrones

    • Synchronisation (interrogation longue)

    Pour de plus amples informations sur ces options, consultez la section Démarrage d'une tâche via un déclencheur d'API.

11. Activez le bouton bascule Planifier la fin de l'exécution de la tâche pour sélectionner une stratégie de fin de tâche.
    Remarque :

    • Le délai spécifié ici expire en fonction des spécifications, même si la tâche est en file d'attente. Par exemple, si vous planifiez le lancement d'une tâche à 13 h et que vous la configurez pour qu'elle s'arrête après 20 minutes, la tâche s'arrête à 13 h 20, même si elle est restée dans une file d'attente jusqu'à 13 h 15, puis a démarré.
    • Les options Planifier la fin de l'exécution des tâches (Schedule ending of job execution) d'un déclencheur sont conservées pour les tâches démarrées manuellement.

    Supposons que vous ayez créé le déclencheur T1 et que vous ayez activé les planifications de fin de tâche suivants :

    • Planifier la fin de l'exécution de la tâche (Schedule ending of job execution) : Arrêter la tâche après 10 minutes (Stop a job after 10 mins)

    • Planifier l’arrêt forcé automatique si la tâche ne s’arrête pas (Schedule automatic "Kill", if the job does not stop) : Forcer l'arrêt de la tâche après 2 minutes (Kill job after 2 mins)

      Sur la page Automatisations (Automations) > Déclencheurs (Triggers), lorsque vous cliquez sur Démarrer une tâche maintenant (Start a Job Now) pour le déclencheur T1, la page Démarrer la tâche (Start Job) s'ouvre avec les planifications de fin de la tâche déjà appliqués, les mêmes que ceux que vous avez configurés lorsque vous avez créé le déclencheur.

    Par ailleurs, si vous planifiez d’arrêter une tâche toujours en attente ou en cours d’exécution après 2 heures, et que vous configurez également l’arrêt forcé de la même tâche après 3 heures, l’arrêt de la tâche sera forcé après 5 heures au total. Cela se produit parce que le signal est d’abord envoyé à Orchestrator pour indiquer que la tâche a bien été arrêtée après 2 heures. Une fois le signal reçu, l’action d’arrêt forcé de la tâche ne doit se déclencher que 3 heures plus tard, soit un total de 5 heures.

    • Sélectionnez Arrêter dans la liste déroulante afin d’essayer de mettre fin normalement à l’exécution une fois l’intervalle de temps défini écoulé depuis que la tâche est bloquée dans l’état En attente (Pending) ou En cours d’exécution (Running) (définissez l’heure sur un minimum de 1 minute, et un maximum de 10 jours, 23 heures et 59 minutes) ;
      Exemple : Orchestrator tentera d’arrêter les tâches bloquées en attente (Pending) ou en cours d’exécution (Running) depuis au moins 10 minutes.

      

    • Sélectionnez Forcer l’arrêt dans la liste déroulante afin d’essayer de forcer l’arrêt de l’exécution une fois l’intervalle de temps défini écoulé depuis que la tâche est bloquée dans l’état En attente (Pending) ou En cours d’exécution (Running) (définissez l’heure sur un minimum de 1 minute, et un maximum de 10 jours, 23 heures et 59 minutes) ;

      Exemple : Orchestrator tentera de forcer l’arrêt des tâches bloquées en attente (Pending) ou en cours d’exécution (Running) depuis au moins 10 minutes.

    • Sélectionnez Arrêter dans la liste déroulante et activez l’option Forcer l’arrêt de la tâche si elle ne s’arrête pas afin de mettre fin normalement à l’exécution une fois l’intervalle de temps défini écoulé depuis que le travail est bloqué dans un état En attente (Pending) ou En cours d’exécution (Running), puis tenter d’en forcer l’arrêt une fois que l’intervalle de temps défini s’est écoulé depuis que le travail est bloqué dans un état En cours d’arrêt (Stopping) (définissez le temps sur un minimum de 1 minute, un maximum de 10 jours, 23 heures et 59 minutes).

      Exemple : Orchestrator tentera d’arrêter les tâches bloquées sur le statut En attente (Pending) ou En cours d’exécution (Running) pendant au moins 10 minutes. Si l’arrêt ne se produit pas, Orchestrator tentera de forcer l’arrêt des tâches en tentative d’arrêt depuis au moins 20 minutes.

12. Activez la bascule Planifier la désactivation automatique du déclencheur (Schedule automatic trigger disabling) et saisissez la date et l'heure auxquelles le déclencheur doit être désactivé. Le fuseau horaire sélectionné lorsque le déclencheur de temps est désactivé.
13. Activez la bascule Générer une alerte si la tâche est bloquée (dans le statut En attente ou Reprise) (Generate an alert if the job is stuck (in pending or resumed status)) et définissez la durée acceptable pendant laquelle la tâche doit rester dans le statut En attente ou Reprise. La durée minimale configurable est d'une minute. La durée maximale configurable est de onze jours. Si la tâche dépasse la durée configurée, une fenêtre contextuelle d'alerte de gravité « Erreur » vous en informe avec le texte suivant : « La tâche pour #process {process_number} est en attente/en cours d'exécution depuis plus de X heures et Y minutes. », où :
    • N : correspond au nombre de tâches qui ont déclenché l'alerte ;
    • {process_number} : l'identifiant du processus ;
    • X : le nombre d'heures configuré que la tâche a dépassée tout en ayant le statut en attente ou repris ; Les jours sont convertis en heures.
    • Y : le nombre configuré de minutes que la tâche a dépassé tout en ayant le statut En attente ou Reprise.
14. Activez la bascule Générer une alerte si la tâche a démarré et ne s'est pas terminée (Generate an alert if the job started and has not completed), et définissez la durée acceptable pour la tâche. La durée configurable est d'une minute au minimum et de onze jours au maximum. Si la tâche dépasse la durée configurée, une fenêtre contextuelle d'alerte de gravité « Erreur » vous en informe avec le texte suivant : « La tâche pour #process {process_number} est en attente/en cours d'exécution depuis plus de X heures et Y minutes. », Où :
    • {process_number} : l'identifiant du processus ;
    • X - le nombre d'heures configuré que la tâche a dépassé lors de sa tentative d'achèvement ; Les jours sont convertis en heures.
    • Y : le nombre configuré de minutes que la tâche a dépassé lors de sa tentative d'achèvement.
15. Activez le bouton Définir une désactivation du déclencheur basée sur l'exécution (Set execution-based trigger disabling) si vous souhaitez contrôler le moment où le déclencheur est désactivé une fois qu'une tâche échoue. Ce bouton révèle deux options :

    Option	Description
    Désactiver en cas d'échec d'exécutions de tâches consécutifs	Le déclencheur est désactivé après le nombre d'exécutions échouées que vous choisissez pour ce paramètre. Vous pouvez choisir une valeur comprise entre 0 et 100. La valeur par défaut est 0, ce qui signifie que le déclencheur n'est jamais désactivé. Les tâches arrêtées ne sont pas prises en compte dans cette valeur.
    Délai de grâce lors de la désactivation du déclencheur (jours)	Nombre de jours à attendre avant la désactivation du déclencheur après le premier échec d'une tâche. Vous pouvez choisir une valeur comprise entre 0 et 30. La valeur par défaut est de 0, ce qui signifie que le déclencheur est désactivé dès que le nombre d’exécutions de tâches défini dans le champ ci-dessus est atteint pour la journée en cours.

    Remarque :

    Si vous choisissez un runtime Cloud - Serverless pour le processus sous-jacent, l’option Définir une désactivation du déclencheur basée sur l’exécution est automatiquement activée, avec les valeurs par défaut suivantes (les champs sont en lecture seule) :

    • Désactiver en cas d’échec d’exécutions de tâches consécutifs est défini sur 10.

    • Délai de grâce lors de la désactivation du déclencheur (jours) est défini sur 0.

    Cela ne s’applique à vous que si vous êtes sur le plan de licence Community.

16. Pour conserver le même contexte compte-machine configuré pour démarrer la tâche, cochez la case Conserver l'allocation de compte/machine à la reprise de la tâche . Cela optimise votre utilisation des licences et des ressources.

Important :

• Les paramètres d'exécution au niveau du locataire s'appliquent aux déclencheurs d'API.

• Vous pouvez créer jusqu'à 1000 déclencheurs d'API par locataire.

Actions sur les déclencheurs d'API

La page Déclencheurs d'API vous permet d'effectuer plusieurs actions à partir du menu contextuel de chaque déclencheur :

Copier l'URL complète du champ de données dynamique

Copiez l'URL à utiliser dans l'application tierce.

Pour un déclencheur d'API avec le champ de données dynamique hw-process, cela devrait ressembler à la ligne suivante : https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process

Modifier (Edit)

Modifiez les propriétés du déclencheur d'API sélectionné.

Copier le champ de données dynamique

Copiez le champ de données dynamique dans le format approprié pour l'utiliser dans la ligne de commande ou dans le code existant. Les options disponibles sont les suivantes :

Copier en tant que curl (bash) (Copy as curl (bash)) : pour un déclencheur d'API avec le champ de données dynamique hw-process, cela devrait ressembler à la ligne suivante :

curl '{baseURL_orchestrator}/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process'  -X 'POST'  -H 'Content-Type: application/json'  -H 'Authorization: Bearer ***INSERT_YOUR_TOKEN***'

Copier en tant que curl (cmd) (Copy as curl (cmd)) : pour un déclencheur d'API avec le champ de données dynamique hw-process, cela devrait ressembler à la ligne suivante :

curl "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ^ -X "POST" ^ -H "Content-Type: application/json" ^ -H "Authorization: Bearer ***INSERT_YOUR_TOKEN***"

Copier en tant qu'extraction (Copy as fetch) : pour un déclencheur d'API avec le champ de données dynamique hw-process, cela devrait ressembler à la ligne suivante :

fetch("https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process", { headers: { Authorization: "Bearer ***INSERT_YOUR_TOKEN***", "Content-Type": "application/json" }, "method": "POST" })

Copier en tant que PowerShell (Copy as PowerShell) : pour un déclencheur d'API avec le champ de données dynamique hw-process, cela devrait ressembler à la ligne suivante :

$headers = @{ "method"="POST" "Authorization" = "Bearer ***INSERT_YOUR_TOKEN***" } Invoke-WebRequest -UseBasicParsing -Uri "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/6ea73196-ca89-446c-81e1-5279bdd36dc2/hw-process" ` -Headers $headers ` -ContentType "application/json"

Activer (Enable)

Réactiver une activité qui a été désactivée.

Désactiver (Disable)

Désactiver un déclencheur d’API déjà activé.

Supprimer (Remove)

Supprimer le déclencheur d'API sélectionné. La suppression d'un déclencheur d'API équivaut à la suppression du point de terminaison obtenu. Voici les comportements auxquels vous pouvez vous attendre en fonction de votre scénario :

Tâches déjà démarrées

Si une tâche reposant sur un processus associé à un déclencheur d'API supprimé a déjà été démarrée au moment de la suppression du déclencheur, celle-ci s'exécutera jusqu'à son terme.

Démarrer de nouvelles tâches

Comme l'URL n'est plus disponible, une erreur 404 est générée lorsque l'on tente de démarrer une tâche basée sur un processus associé à un déclencheur d'API supprimé.

Modifier les processus

Si vous modifiez un processus utilisé par au moins un déclencheur d'API, le déclencheur sera actualisé et le nouvel ensemble de propriétés du processus sera appliqué.

Partage des ressources d’origines différentes

Vous pouvez ajouter des domaines à la liste d'autorisation pour le trafic entrant en utilisant l'option Liste d'autorisation CORS pour les déclencheurs d'API dans l'onglet Général de vos paramètres de locataire.

Cela est nécessaire pour les applications de navigateur qui enverront des requêtes HTTP à Orchestrator à partir de votre navigateur (et non à partir d'un serveur). Si vous n'ajoutez pas de domaine à la liste d'autorisation, cela peut entraîner une erreur de politique CORS, à laquelle vous pouvez accéder dans votre console de développeur.

Si vous souhaitez ajouter davantage de domaines à la liste d'autorisation, utilisez des virgules ou appuyez sur Entrée pour les séparer.

Définition de l'API

Cette page affiche une définition Swagger des déclencheurs d'API que vous avez créés, regroupés par dossier, ainsi que leur sortie. Par ailleurs, elle vous permet d’exécuter les tâches associées à ces déclencheurs.

Elle est accessible en cliquant sur le bouton Définition de l'API sur la page Déclencheurs d'API, ou bien via https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/t/swagger/index.html.

La définition de l'API pour un locataire disposant de déclencheurs d'API dans un espace de travail personnel et le dossier Partagé devrait ressembler à ceci :