Webhook-Peripheriegerät verbinden

Aktualisiert

Hinweis: Dieser Artikel ist technisch; wir empfehlen, eine fachkundige Person hinzuzuziehen. Bei Fragen kontaktieren Sie uns unter support@azumuta.com.

Ein Webhook-Peripheriegerät erlaubt einem externen System, die Antwort einer Produktprüfung auszufüllen. Wenn der Bediener den Schritt erreicht, ruft Azumuta Ihren Webhook auf, liest den Wert aus der Antwort und verwendet ihn als Antwort. Beispielsweise kann ein Messdienst den gemessenen Wert eines Teils zurückgeben, sodass der Bediener ihn nicht eingeben muss.

Die Server von Azumuta rufen den Webhook auf, sodass Sie keinen Hub oder zusätzliche Software am Arbeitsplatz benötigen.

Was Sie benötigen

  • Eine Webhook-Endpoint-URL, die von den Servern von Azumuta erreichbar ist. Sie muss aus dem Internet erreichbar sein, nicht nur vom Computer des Bedieners. Um eine Antwort zu liefern, muss sie JSON zurückgeben.
  • Die Berechtigungen, Peripheriegeräte und Geräte unter Management zu verwalten und Arbeitsanweisungen zu bearbeiten.
  • Eine unterstützte Prüfung. Ein Webhook-Peripheriegerät funktioniert mit den Prüfungen OK/NOK, Zahl, Einzeilig und Mehrzeilig. Der Procedure-Check kann ebenfalls einen Webhook verwenden oder seine eigene Webhook-Aktion. Siehe Procedure check.

Peripheriegerät erstellen

  1. Klicken Sie unter Management auf Peripherals.
  2. Klicken Sie auf die gelbe Plus-Schaltfläche.
  3. Geben Sie einen Namen ein und wählen oder erstellen Sie die Peripheriegruppe.
  4. Unter How to connect? wählen Sie Webhook.
  5. Füllen Sie die Webhook-Felder aus.
  6. Klicken Sie auf Add, wenn Sie fertig sind.

Webhook-Felder

  • Webhook URL: die vollständige http- oder https-Adresse Ihres Endpunkts.
  • Method: POST, GET, PUT oder PATCH.
  • Authentication: wie sich Azumuta gegenüber Ihrem Endpunkt identifiziert: None, Header, Basic oder OAuth client credentials. Diese Optionen funktionieren auf die gleiche Weise für Webhook-Trigger. Siehe Authentication.
  • Payload format** und Webhook payload: Bei Azumuta-Format wird Ihre Nutzlast innerhalb von Azumutas JSON-Body neben den Ereignisfeldern gesendet. Bei JSON, XML, CSV oder Text wird nur Ihre Nutzlast mit dem entsprechenden Content-Type gesendet. Sie können Parameter in der Nutzlast verwenden.
  • When to run the webhook:
    • Automatic on first visit: beim ersten Öffnen des Schritts durch den Bediener.
    • Automatic on every visit: bei jedem Öffnen des Schritts.
    • Manual: der Bediener drückt eine Schaltfläche.
  • Response format: JSON.
  • Webhook result parameter: wo Azumuta die Antwort im JSON findet, z. B. data.result.value für eine Antwort wie { "data": { "result": { "value": 17.3 } } }. Lassen Sie das Feld leer, um die gesamte Antwort zu verwenden.
  • Webhook remark parameter: wo Azumuta eine Bemerkungsnachricht im JSON findet.

Azumuta fügt die Produktauftragsnummer sowie die IDs der Arbeitsanweisung und der Aufzeichnung (falls zutreffend) zum Aufruf hinzu: als URL-Parameter bei GET und im JSON-Body beim Azumuta-Format.

Peripheriegerät einem Gerät hinzufügen

Eine Prüfung findet ihr Peripheriegerät über das Gerät und die Peripheriegruppe. Fügen Sie das Peripheriegerät zu jedem Gerät hinzu, auf dem Bediener die Arbeitsanweisung ausführen:

  1. Klicken Sie unter Management auf Devices.
  2. Klicken Sie neben dem Gerät auf das ⋮-Symbol (drei Punkte) und dann auf Edit device.
  3. Klicken Sie auf den Tab Peripherals.
  4. Wählen Sie unter Peripherals for instruction checks das Webhook-Peripheriegerät aus.
  5. Klicken Sie auf Save.

Das Peripheriegerät in einer Prüfung verwenden

  1. Öffnen Sie den Instruktionsschritt und klicken Sie auf den Tab Check.
  2. Wählen Sie eine unterstützte Prüfung aus.
  3. Wählen Sie unter Peripheral options die Peripheriegruppe Ihres Webhook-Peripheriegeräts. Sie können außerdem eine Peripherie-Voreinstellung anwenden.
  4. Passen Sie bei Bedarf die Optionen an:
    • Payload: ersetzt die auf dem Peripheriegerät für diese Prüfung eingestellte Nutzlast. Lassen Sie das Feld leer, um die Nutzlast des Peripheriegeräts zu verwenden. Schreiben Sie sie im Payload-Format des Peripheriegeräts.
    • Automatically submit answer after: sendet die Antwort 0 bis 10 Sekunden nachdem sie ausgefüllt wurde. Nicht verfügbar für die OK/NOK-Prüfung.
    • Allow manually entering answer: erlaubt dem Bediener, die Antwort einzugeben oder zu ändern. Diese Option ist standardmäßig aktiviert.

Beispiel

Ein Qualitätsdienst gibt den gemessenen Wert eines Teils zurück. Ihr Endpunkt ist https://qc.example.com/api/measurement und antwortet mit:

{
  "data": {
    "value": 17.3,
    "remark": "Within tolerance"
  }
}

Um ihn in einer Zahl-Prüfung zu verwenden:

  1. Erstellen Sie eine Peripheriegruppe für die Zahl-Prüfung, z. B. "External measurement".
  2. Erstellen Sie in dieser Gruppe ein Webhook-Peripheriegerät mit Method POST, Webhook result parameter data.value, Webhook remark parameter data.remark und When to run the webhook auf Automatic on first visit gesetzt.
  3. Fügen Sie das Peripheriegerät dem Gerät hinzu, das die Bediener verwenden.
  4. Fügen Sie dem Instruktionsschritt eine Zahl-Prüfung hinzu und wählen Sie die Gruppe unter Peripheral options aus.

Wenn der Bediener den Schritt öffnet, ruft Azumuta den Endpunkt auf und trägt 17.3 als Antwort ein.

Falls Ihr Endpunkt nicht erreichbar ist

Damit Bediener weiterarbeiten können, falls Ihr Endpunkt ausfällt, aktivieren Sie auf dem Peripheriegerät Disable peripheral temporarily. Die Bediener können dann die Antworten manuell eingeben. Siehe Use a peripheral device.

Wählen Sie den richtigen Webhook

  • Um die Antwort einer Prüfung aus einem externen System auszufüllen, verwenden Sie ein Webhook-Peripheriegerät, wie hier beschrieben.
  • Um einen Schritt zu validieren, verwenden Sie die Webhook-Aktion eines Procedure check.
  • Um ein anderes System zu benachrichtigen, wenn etwas passiert, verwenden Sie einen Webhook-Trigger.
Auf dieser Seite