Webhooks werden verwendet, um externe Anwendungen in TrendMiner zu integrieren und Aktionen auszulösen, die normalerweise nicht in TrendMiner durchgeführt werden. Diese Funktion ist eine Option, die Sie bei der Einrichtung eines Monitors unter der Monitor-Konfiguration finden.
Das Webhook Monitoring verwendet Trigger-basierte URLs (Webhooks), die aus Anwendungen von Drittanbietern wie built.io und webmethods stammen. Durch die Bereitstellung eines Webhooks kann TrendMiner HTTP-Aufrufe zu Ihrer spezifischen URL durchführen, sobald ein Monitor ausgelöst wird. Diese Aufrufe können z.B. in den automatisierten Workflows verwendet werden, die in den von Ihnen ausgewählten Anwendungen von Drittanbietern laufen. Für jedes Monitor-Ergebnis sendet TrendMiner 2 Aufrufe an den Webhook: einen, wenn die Suchkriterien erfüllt sind, und einen, wenn das Suchergebnis endet.
Warum Webhooks in Monitoren verwenden?
Stärkere Automatisierung von Arbeitsabläufen
Unter normalen Umständen kommuniziert Ihr Historian mit TrendMiner, aber TrendMiner kommuniziert nicht zurück. Dank des Webhook Monitorings kann TrendMiner mit allen Anwendungen von Drittanbietern kommunizieren, die Sie in Ihrem Tagesgeschäft verwenden.
Wenn TrendMiner beispielsweise feststellt, dass der Füllstand eines überwachten Tanks zu niedrig ist, kann die Monitoring-Funktion von TrendMiner, wenn sie mit einem Webhook ausgestattet ist, dies einer weiteren Anwendung mitteilen, die automatisch ein Produktbestellung anordnet, das direkt an die Beschaffung gesendet wird.
Ohne einen Webhook würde die Einrichtung dieses Prozesses mehrere manuelle Schritte umfassen.
Wie Sie Webhooks verwenden
- Stellen Sie sicher, dass Sie über ein Drittanbieter-Tool verfügen, das einen Webhook bereitstellen kann.
- Richten Sie einen Such- oder Fingerprint-Monitor ein (siehe Einrichten eines Monitors).
- Wählen Sie in der Konfiguration des Monitors die Option Webhook aufrufen und geben Sie Ihre Webhook-URL ein. Sie können sie testen, indem Sie auf die Schaltfläche "URL testen" klicken. Dadurch wird eine Standard- und Beispielantwort an die angegebene URL gesendet.
- Aktivieren Sie den Monitor.
Technische Informationen
Die Antwort des Webhook ist ein JSON-Objekt, das wie folgt aussieht:
{
"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"
}
Der Schlüssel resultScore ist nur bei Monitoren, die auf einer Ähnlichkeits-Suche basieren, vorhanden. Für jeden Monitor werden zwei Webhook-Aufrufe durchgeführt, einer für den ersten Auslöser des Monitors und einer für das Ende des Suchergebnisses. Der Schlüssel webhookCallEvent ist gleich start bzw. end.
Die Schlüssel resultStart und resultEnd geben die Start- und Endzeit des erkannten Monitor-Ergebnisses an, während webhookCallTime die Zeit angibt, zu der der Webhook-Aufruf gesendet wurde. Alle Zeitstempel sind als UTC-Zeit formatiert.