Konfigurieren Sie ein Webhook-Ereignis

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 3 Minuten Lesedauer

    • Konfigurieren Sie ein Webhook-API-Ereignis in der Konfigurationstabelle des Anbieters, damit Abzeichenlieferanten die Abzeichendaten teilen können, die mit dem Webhook-Ereignis aus Abzeichentabellen gesammelt wurden.

    Vorbereitungen

    Erforderliche Rolle: sn_wsd_wc.admin

    Warum und wann dieser Vorgang ausgeführt wird

    Die Abzeichendaten (JSON) werden mit dem REST-API-Explorer ServiceNow verarbeitet. Einzelne oder mehrere Rohdatensätze für Abzeichen (Nutzlast) können mit dem REST-API-Explorer gemeinsam genutzt und verarbeitet werden. Das Webhook-Ereignis für Badge-Daten wird in einzelnen oder mehreren JSON-Datensätzen in die Tabelle „Connector-Ereignisse“ geladen. Mehrere Datensätze werden als Array gesendet. Weitere Informationen finden Sie unter Anwesenheits-Analytics.

    Prozedur

    1. Navigieren zu Alle > Arbeitsplatz-Connectors > Provider-Connector-Konfigurationen.
    2. Wählen Sie Neu erstellen.

      Füllen Sie die Felder des Formulars aus.

      Tabelle : 1. Formular „Konfigurationen des Anbieter-Connectors“.
      Feld Beschreibung
      Name Name für die Anbieterkonfiguration.
      Connector-Konfiguration Option zum Suchen und Auswählen des Symbols für die Nachschlageliste ( Symbol für Nachschlageliste.), um Abzeichenauszuwählen.

      Weitere Informationen finden Sie unter Konfigurieren Sie die Connector-Konfiguration für Abzeichendaten.
      Quelltyp Quelle, aus der die Abzeichendaten gesammelt und in die Abzeichendaten-Zieltabelle geladen werden.

      Wählen Sie Webhook aus, um das Webhook-Ereignis zu konfigurieren.
      Token-Parametername

      Der Token-Parametername und der Token-Wert sind ein geheimes Schlüssel-Wert-Paar, das zur Authentifizierung des API-Aufrufs vom Lieferantenabzeichensystem an die Anwendung Arbeitsplatz-Connectoren verwendet wird. Beide Systeme haben den Tokennamenswert. Anhand des Tokennamens authentifiziert die Anwendung die API-Anforderung.
      Tokenwert Der Tokenwert ist der geheime Schlüssel, der vom Abzeichenlieferanten beim Aufrufen des API-Ereignisses verwendet wird, damit der Server die API-Anforderung authentifizieren kann.
      Aktiv Option, um anzugeben, dass die Anbieterkonfiguration aktiv ist.
      Callback URL Option zum Auswählen des Rückruf-URL-Symbols ( Rückruf-URL-Symbol.), um die Rückruf-URL zu sperren oder zu bearbeiten.
      Standort automatisch aktualisieren Option zum automatischen Aktualisieren von Standorten, wenn Bereiche hinzugefügt oder wenn Bereiche von einem ausgewählten Standort entfernt werden.

      Die Datensätze der geplanten Bereichszuordnung für die Anbieteraktualisierung werden täglich ausgeführt, und lesen das Feld „Standort automatisch neu laden“ in der Konfigurationstabelle des Anbieter-Connectors. Er liest alle Datensätze in den Konfigurationsdatensätzen des Anbieter-Connectors und aktualisiert die Tabelle „Bereichszuordnung des Anbieters“ mit den neuesten Daten. Wenn beispielsweise einem Standort ein neues Stockwerk oder eine neue Fläche hinzugefügt wird, werden sie automatisch einem ausgewählten Standort hinzugefügt.
      Metriken Option zum Auswählen des Zieldatensatzes für unterstützte Metriken. Wählen Sie Ereignisdaten aus.
    3. Wählen Sie Aktualisieren.
    4. Wählen Sie das neu erstellte Webhook-Ereignis aus.

      Über die Schaltfläche „Rückruf-URL generieren“ können Sie eine Rückruf-URL für die REST-API-Anforderung generieren.

    5. Geben Sie als Abzeichenlieferant die Abzeichendaten im JSON-Format frei, indem Sie zu navigieren Alle > System-Webservices > REST > REST-API-Explorer.
    6. Wählen Sie auf der Seite „REST-API-Explorer“ Folgendes aus:
      • Namespace: Wählen Sie in der Dropdown-Liste sn_wsd_wcaus
      • API-Name: Workplace Connector-Webhook
      • API-Version: v1
    7. Geben Sie auf der Ereignisseite „Workplace Connector – Webhook“ die folgenden Werte an:
      • token_name: In Schritt 2 verwendeter Token-Parametername. Der Tokennamenswert wird von Abzeichenlieferanten verwendet, um die Abzeichendaten (JSON) für Arbeitsplatz-Connectorenfreizugeben. Die Rohdaten (Nutzlast oder Abzeichendaten) werden verarbeitet und in die Tabelle „Connector Events“ geladen.
      • ni.nolog.id: Kopieren Sie die System-ID des in Schritt 2 erstellten Webhooks, und fügen Sie sie ein. Wählen Sie im Bereich das Menüsymbol für zusätzliche Aktionen ( Menüsymbol für zusätzliche Aktionen.).
      • token_value: Tokenwert, der in Schritt 2 bereitgestellt wird. Der Tokenwert ist der geheime Schlüssel, der vom Abzeichenlieferanten beim Aufrufen des API-Ereignisses verwendet wird, damit der Server die API-Anforderung authentifizieren kann.
      1. Wählen Sie im API-Anforderungstext Rohdaten aus, und kopieren Sie die Abzeichendaten (Nutzlast) im JSON-Format.
        Diese Abzeichendaten werden von Abzeichensensoren erfasst.
      2. Wählen Sie Senden.
        Wenn der Antwortcode 200 OK und das Antwortergebnis Successlautet, werden die Badgedaten in die Tabelle Connector Events geladen.
        • In die Tabelle „Connector Events“ (sn_wsd_wc_connector_events) werden die Badgedaten geladen, die von Abzeichenlieferanten gemeinsam genutzt werden. Der Status der Abzeichendaten lautet Neu, wenn sie vom REST-API-Explorer geladen werden.
        • Die Webhook-Provider-Datensätze des geplanten Aufgabenprozesses werden jede Minute ausgeführt, um die Abzeichendaten aus der Tabelle Connector-Ereignisse (Daten mit dem Status Neu) in die Tabelle mit Anwesenheitsdaten zu laden.
      Die geplante Aufgabe übernimmt die Quelldaten aus dem Webhook -Ereignis, wandelt die Daten im erforderlichen Format um und platziert sie dann in der Zieltabelle für Mitarbeiteranwesenheitsdaten.
      Hinweis:
      Um auf die geplanten Aufgaben Arbeitsplatz-Connectoren zuzugreifen, navigieren Sie zu Alle > Systemdefinition > Geplante Aufgaben. Suchen Sie in der Spalte Anwendung nach Workplace Connectors. Für Arbeitsplatz-Connectorensind zwei geplante Aufgaben verfügbar.
      • Datensätze für Anbieterdaten verarbeiten: Liest Daten aus Abzeichendaten des Lieferanten (Quelltabelle). Nach der Verarbeitung der Abzeichendaten werden sie vom Datensatz in die Tabelle mit Anwesenheitsdaten für Mitarbeiter (Zieltabelle) geladen. Weitere Informationen finden Sie unter Konfigurieren Sie Abzeichentabellendaten.
      • Webhook-Provider-Datensätze verarbeiten: Liest Daten aus der Tabelle „Connector Events“. Verarbeitet die Webhook-Ereignisdaten und lädt sie in die Tabelle mit Anwesenheitsdaten für Mitarbeiter (Zieltabelle).
      • Daten werden in die Tabelle „Anwesenheitsdaten für Mitarbeiter“ geladen. Der Status der Abzeichendaten in der Tabelle Connector-Ereignisse ändert sich in Verarbeitet.
      • Aus der Tabelle „Anwesenheitsdaten für Mitarbeiter“ werden die Daten in die Tabelle „Anwesenheits-Analytics“ geladen.
        Hinweis:
        Abzeichendatensätze in der Tabelle „Connector-Ereignisse“ mit dem Status „Verarbeitet“ werden nach zwei Tagen ab dem Datum der Erstellung oder dem aktuellen Datum durch die Tabelle „Connector-Ereignisse“ [sn_wsd_wc_connector_events] gelöscht. Daten im Status „Fehler“ werden nach sieben Tagen ab dem Datum der Erstellung gelöscht. Daten im Status „Neu“ werden nicht gelöscht.