Webhooks

Les Webhooks sont utilisés pour intégrer des applications externes à TrendMiner afin d'initier des actions qui ne sont pas normalement menées dans TrendMiner. Cette fonction est une option qui se trouve sous l'option Moniteur dans le menu TrendHub Web_hook_1.png.

La surveillance Webhook utilise des urls basées sur des déclencheurs (webhooks) provenant d'applications tierces telles que build.io et webmethods. En fournissant un Webhook, TrendMiner peut exécuter des appels HTTP vers votre url spécifique chaque fois qu'un moniteur se déclenche. Ces appels peuvent, par exemple, être utilisés dans les workflows automatisés exécutés dans les applications tierces sélectionnées. Pour chaque résultat de surveillance, TrendMiner envoie 2 appels au Webhook : un lorsque les critères de recherche sont remplis et un lorsque le résultat de recherche est terminé. 

Pourquoi utiliser la surveillance des Webhook?

Automatisation accrue des flux de travail.

Dans des circonstances normales, vos historiens de données communiquent avec TrendMiner, mais TrendMiner ne communique pas en retour. La surveillance Webhook permet à TrendMiner de répondre et d'intégrer TrendMiner à toutes les applications tierces que vous utilisez dans vos activités quotidiennes. 

Par exemple, si TrendMiner détecte que les niveaux de stockage sont bas dans un réservoir surveillé, l'installation de surveillance de TrendMiner, lorsqu'elle est équipée d'un Webhook, peut le communiquer à une autre application qui génère automatiquement un document de commande de produits qui est envoyé directement aux achats. 

Sans la surveillance des Webhooks, ce processus serait beaucoup plus manuel.

Comment utiliser les Webhooks

En tant qu'administrateur

  1. Aller au menu de l'outil TrendHub.
  2. Cliquez sur l'icône des paramètres (pignon).
  3. Cliquez sur Gestion des fonctionnalités.
  4. Cliquez sur l'option "Monitoring webhook notification" pour qu'elle soit sur fond vert.

En tant qu'utilisateur final

  1. Assurez-vous d'avoir une url tierce partie à utiliser comme Webhook.
  2. Préparer une recherche ou une prise d'empreintes digitales pour les besoins d'un moniteur.
  3. Accédez au menu de l'outil TrendHub et cliquez sur l'icône de surveillance (Bell).
  4. Identifiez le moniteur que vous avez choisi en cliquant sur le bouton associé pour qu'il soit sur fond vert.
  5. Faites défiler vers le bas de la page des paramètres du moniteur et des alertes.
  6. Cochez la case et entrez l'url de votre Webhook.
  7. Cliquez sur le bouton Enregistrer.

Informations techniques

La réponse du Webhook sera un objet JSON qui se présente comme suit :

{

"monitorId":1,

"resultEnd":"2019-02-02T02:02:02.000Z",

"resultId":2,

"resultScore":100,

"resultStart":"2019-01-01T01:01:01.000Z",

"resultUrl":"http://10.230.254.120/#/chart/monitoring/match/2",

"searchCreator":"UserX",

"searchDescription":"Description of my value based search" ,

"searchId":3,

"searchName": "My value based search",

"searchType":"valuebased"

,"webhookCallEvent":"start"

,"webhookCallTime":"2019-07-05T14:32:51.382Z"

La clé resultScore ne sera présente que pour les moniteurs basés sur la recherche de similarité. Pour chaque moniteur, deux appels Webhook seront effectués, un pour le déclenchement initial du moniteur et un pour la fin du résultat de la recherche. La touche webhookCallEvent sera égale au début ou à la fin, respectivement. 

Les touches resultStart et resultEnd indiquent l'heure de début et de fin du résultat du contrôle détecté, tandis que la touche webhookCallTime indique l'heure à laquelle l'appel a été envoyé. Tous les horodatages sont formatés en heure UTC.