Création d'un déclencheur

Vous pouvez créer un déclencheur dans le cadre d'un connecteur personnalisé. Vous pouvez utiliser des déclencheurs de connecteur personnalisés pour démarrer automatiquement des automatisations ou des processus en fonction d'événements du fournisseur.

Mode de fonctionnement

Les déclencheurs du générateur de connecteurs utilisent l’interrogation de ressource pour détecter les modifications du fournisseur. L'interrogation de ressource consiste à appeler une ressource API sur un intervalle régulier pour détecter lorsque de nouveaux événements sont renvoyés.

Une fois qu'un connecteur personnalisé est publié et que le déclencheur est utilisé dans une automatisation publiée, l'URL définie est utilisée comme ressource d'interrogation pour récupérer les événements et démarrer un flux d'automatisation.

Détection de nouveaux événements

L'URL d'interrogation du déclencheur doit inclure des paramètres de requête pour filtrer les résultats du fournisseur.

L'interrogation se produit à un intervalle planifié (toutes les 5, 10, 15 minutes, etc.). Par conséquent, l'un des paramètres de requête du fournisseur doit être une date pour le filtrage des résultats. De cette façon, le moteur d'interrogation peut remplir la valeur du paramètre de requête pour inclure uniquement les événements qui se sont produits depuis la dernière interrogation.

Limitations

• Vous pouvez créer un déclencheur par ressource. Si plusieurs cas d'utilisation sont nécessaires, utilisez une URL d'interrogation plus générale et configurez des champs de filtre de réponse qui peuvent répondre à plusieurs cas d'utilisation.
• Les API du fournisseur doivent permettre le filtrage des paramètres de requête basé sur la date. Si aucun paramètre de requête basé sur la date n'est disponible auprès du fournisseur, il ne doit pas être utilisé comme déclencheur.

Prérequis

Exigences pour le fournisseur

L'API du fournisseur doit offrir une ressource avec un point de terminaison GET qui renvoie une liste d'objets. De plus, le point de terminaison doit vous permettre d'interroger la ressource en fonction d'un paramètre de date.

Exemple de ressource valide

Pipedrive propose un point de terminaison Obtenir toutes les activités , qui renvoie une collection d’activités. Ce point de terminaison comprend un paramètre de requête since qui filtre les résultats en fonction de toutes les activités avec une date update_time supérieure à la date since fournie comme valeur pour le paramètre de requête. Vous pouvez utiliser le paramètre since comme partie de l'URL d'interrogation pour détecter toute mise à jour des activités Pipedrive. Le moteur d'interrogation UiPath remplit automatiquement ce champ de date pour capturer les événements.

Exigences pour le connecteur

Les déclencheurs du générateur de connecteurs utilisent des ressources déjà disponibles sur le connecteur comme URL d’interrogation. Lors de la création d'un déclencheur, il doit y avoir une ressource existante côté connecteur à laquelle le déclencheur doit être associé.

Les déclencheurs utilisent la configuration de la ressource. Il est donc important que la ressource existante dispose déjà des éléments suivants :

• Paramètres de requête: les déclencheurs peuvent importer des paramètres de requête existants, de sorte que la ressource doit déjà avoir certains paramètres configurés avant de créer le déclencheur.
• Champs de réponse: les déclencheurs génèrent l'objet de réponse de la ressource associée, ainsi que permettent la configuration de l'activité en fonction de ces champs. Il est nécessaire de générer les champs de réponse pour la ressource en appelant avec succès le point de terminaison.

Création d'un déclencheur personnalisé

Pour créer un déclencheur dans le générateur de connecteurs, procédez comme suit :

Ajouter un déclencheur

1. Tout d’abord, assurez-vous de remplir les conditions préalables.
2. Dans Integration Service, ouvrez Générateur de connecteurs (Connector Builder), puis sélectionnez votre connecteur personnalisé.
3. Sélectionnez les options supplémentaires à côté de Déclencheurs.
4. Sélectionnez Ajouter un déclencheur.

Définir le nom et la ressource

La fenêtre contextuelle Créer un événement s'affiche. Ici, vous pouvez sélectionner le type d'événement à créer. Actuellement, Interrogation est la seule option disponible.

1. Sélectionnez le type d'événement.
2. Ajoutez un nom pour votre déclencheur.
3. Sélectionnez la ressource utilisée pour détecter ces événements.
4. Sélectionnez Créer pour démarrer le processus de configuration de votre déclencheur.

Configurer le déclencheur

Le processus de création d'un déclencheur comprend trois étapes :

1. Configurer la requête.
2. Configurer la réponse.
3. Configurez les filtres de déclencheur.

Ces étapes correspondent au processus d'interrogation d'une URL de ressource et d'utilisation de la réponse.

Astuce :

Utilisez la fonctionnalité Déclencheur de test tout au long du processus de configuration du déclencheur pour vous assurer qu'il fonctionne comme prévu.

Configurer la requête

Tout d'abord, vous configurez la configuration de l'URL d'interrogation et la façon dont le déclencheur s'affiche dans Studio lorsqu'il est utilisé dans une automatisation.

La mise en page d'aperçu représente la façon dont le déclencheur est affiché dans Studio. Vous pouvez configurer les paramètres et les champs de réponse pour modifier les champs affichés et utilisés dans Studio lors de la configuration du déclencheur d'une automatisation.

URL d'interrogation

L'URL d'interrogation s'affiche en haut de la page de configuration. Il s'agit de l'URL utilisée pour envoyer des demandes au fournisseur afin de détecter de nouveaux événements.

Cette URL doit être configurée de manière à filtrer les événements d'intérêt. L'URL d'interrogation utilise un paramètre de date pour filtrer les nouveaux événements depuis la dernière requête d'interrogation. Il est obligatoire d'inclure un paramètre de date que le moteur d'interrogation peut remplir.

Importer les paramètres

Les déclencheurs peuvent importer des paramètres de ressource à utiliser dans l'URL d'interrogation.

Si un paramètre n'est pas disponible dans la ressource, accédez à la ressource et ajoutez-la, puis revenez à la fenêtre de configuration du déclencheur pour l'importer.

1. Sélectionnez Importer les paramètres pour afficher la liste des paramètres disponibles pour une ressource spécifique.
2. Sélectionnez le paramètre à utiliser dans l'URL d'interrogation.
3. Une fois qu'un paramètre est ajouté, il est inclus dans l'aperçu de l'URL en haut de la page.

Vous pouvez marquer les paramètres importés comme Obligatoires, afin qu’ils s’affichent sur la zone de dessin du déclencheur. Cela signifie que vous devez saisir une valeur pour le paramètre de requête lorsque vous utilisez le déclencheur dans une automatisation.

Important :

Au moins un paramètre de requête basé sur la date est nécessaire pour l'URL d'interrogation. Un paramètre de requête basé sur une date est un paramètre possédant un format DateTime . Les formats DateTime peuvent être trouvés pour un paramètre avec un type de données fournisseur String ou Integer .

Sauf si une valeur de date spécifique est spécifiée, les paramètres de requête basés sur la date sont automatiquement renseignés avec une valeur égale à celle de la date et de l'heure de la précédente requête d'interrogation.

Déclencheur de test

Utilisez l’option Déclencheur de test pour vous assurer que les résultats attendus sont renvoyés.

Lorsque vous sélectionnez Déclencheur de test, la fenêtre Essayer la demande s'affiche et indique :

• Période de recherche: ce champ définit quelle date doit être insérée dans les paramètres de requête basés sur la date et réplique le comportement de notre moteur d'interrogation, qui remplit automatiquement cette valeur en fonction de la date de la dernière requête d'interrogation.
• Les paramètres de requête spécifiés comme requis.

Sélectionnez Essayer la demande pour ouvrir le panneau Débogage des événements et afficher le traçage de la demande avec une décomposition étape par étape du processus de la demande. Le nombre de résultats renvoyés est également indiqué.

Remarque :

Vérifiez que le nombre de résultats renvoyés est le nombre de résultats attendus. Une utilisation incorrecte des paramètres de requête peut entraîner un niveau élevé d’objets de sortie et une utilisation inutile du robot une fois le connecteur publié et le déclencheur utilisé dans un workflow.

Il est recommandé d'avoir des attentes de réponse (nombre d'événements, types d'événements, etc.) lors du test d'un déclencheur afin de vérifier que les filtres de paramètres de requête fonctionnent comme prévu.

Configurer la réponse

À cette étape, vous spécifiez quel champ de réponse correspond à la clé primaire ou à la sortie du déclencheur.

1. Utilisez la liste déroulante sous Clé primaire pour sélectionner un champ.
2. Le champ sélectionné est ajouté à l'aperçu du déclencheur, sous Sortie. Vous pouvez utiliser cette sortie dans des étapes ultérieures de votre workflow.

L'étape Configurer la réponse fournit également une vue de l'objet de réponse associé à la ressource d'interrogation à des fins de révision.

Configurer les filtres de déclencheur

Une fois que vous avez configuré la requête et la réponse, vous pouvez configurer davantage le déclencheur à l'aide de filtres.

Vous configurez le filtrage des événements en définissant des valeurs spécifiques pour les champs de réponse. Ces valeurs sont spécifiées lors de la configuration de l'automatisation (dans Studio), mais le concepteur de déclencheur vous permet également de configurer les champs affichés à des fins de filtrage.

Hydratation

Si la ressource utilisée comme URL d'interrogation ne renvoie pas l'objet entier nécessaire pour la sortie du déclencheur, il est possible d'hydrater la réponse à l'aide d'un point de terminaison GETBYID . Ce processus est appelé ingestion.

Sélectionnez l'onglet Hydratation , activez le bouton bascule Utiliser l'hydratation et spécifiez le point de terminaison à utiliser pour l'hydratation, ainsi que l'ID utilisé pour interroger l'objet.

Remarque :

La liste des ressources d’hydratation possibles est extraite de la liste Obtenir les enregistrements sur le panneau de navigation de gauche. Configurez la ressource GETBYID avant de l'utiliser comme ressource d'hydratation pour un déclencheur.

L'utilisation de l'option d'hydratée remplace les champs de réponse des champs de ressource de réponse d'interrogation par les champs de réponse de ressource hydratés. Ensuite, les champs de réponse d'ingestion deviennent les seuls champs disponibles pour les paramètres de déclencheur et la configuration des filtres.

Filtres

Le processus de configuration du déclencheur propose trois options pour afficher les champs utilisés à des fins de filtrage. Ces champs sont extraits des champs de réponse de ressource de la ressource d’interrogation ou de la ressource d’hydratation. Ces options sont disponibles dans la colonne Afficher en tant que du tableau Paramètres de filtre :

• Masqué: le champ est masqué dans la zone de dessin et n'est pas disponible dans le générateur de filtres. Si tous les champs sont marqués comme Masqués, le générateur de filtres est également masqué.
• Facultatif: au moment de la conception, le champ est affiché en tant qu'option dans le générateur de filtres.
• Obligatoire: au moment de la conception, le champ s'affiche directement sur le canevas du déclencheur et nécessite une saisie de l'utilisateur. Seuls les événements dont la valeur de champ de réponse correspond à la valeur fournie entraînent un événement d’automatisation.

Enregistrer le déclencheur

Une fois que vous avez terminé de configurer le filtre, sélectionnez le bouton Enregistrer . Une fois enregistré, le déclencheur sera inclus en tant qu’événement lorsque le connecteur sera publié.

Utilisation du déclencheur

Une fois qu'un déclencheur est enregistré et qu'il n'est plus en mode brouillon, le déclencheur peut être utilisé dès que vous avez publié votre connecteur personnalisé.