Konfigurieren Sie ein Webhook-Event

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Konfigurieren Sie ein Webhook-API-Event in der Provider-Konfigurationstabelle, damit Abzeichenanbieter die Abzeichendaten, die aus Abzeichentabellen mit dem Webhook-Event erfasst wurden, freigeben können.

    Vorbereitungen

    Erforderliche Rolle: 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-Event für Abzeichendaten wird in die Tabelle „Connector-Events“ in einem oder mehreren JSON-Datensätzen geladen. Mehrere Datensätze werden als Array gesendet. Weitere Informationen finden Sie unter Anwesenheits-Analytics.

    Prozedur

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

      Füllen Sie die Felder des Formulars aus.

      Tabelle : 1. Formular „Providerkonfiguration“
      Feld Beschreibung
      Name Name für die Provider-Konfiguration.
      Quelltyp Quelle, aus der die Abzeichendaten erfasst und in die Zieltabelle „Mitarbeiteranwesenheit“ geladen werden.

      Wählen Sie Webhook aus, um das Webhook-Event 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 Lieferanten-Badging-System an die Arbeitsplatz-Connectoren -Anwendung verwendet wird. Beide Systeme haben den Wert token name. Mit dem Tokennamen authentifiziert die Anwendung die API-Anforderung.
      Tokenwert Der Tokenwert ist der geheime Schlüssel, der vom Abzeichenanbieter beim Aufrufen des API-Events verwendet wird, damit der Server die API-Anforderung authentifizieren kann.
      Aktiv Option, um anzugeben, dass die Provider-Konfiguration aktiv ist.
      Connector-Konfiguration Option zum Suchen nach und Auswählen des Nachschlagelistensymbols ( Nachschlagelistensymbol), um „Badging“auszuwählen.

      Weitere Informationen finden Sie unter Konfigurieren Sie einen Spoke-Connector.
      Callback URL Option zur Auswahl des Rückruf-URL-Symbols (Rückruf-URL -Symbol.), um die Rückruf-URL zu sperren oder zu bearbeiten.
    3. Wählen Sie Aktualisieren.
    4. Wählen Sie das neu erstellte Webhook-Event aus.

      Die Schaltfläche Rückruf-URL generieren ist verfügbar, um eine Rückruf-URL für die REST-API-Anforderung zu generieren.

      Anbieterkonfiguration, die das Webhook-Ereignis mit der Schaltfläche „Rückruf-URL generieren“ anzeigt.

    5. Als Abzeichenlieferant geben Sie 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_wc aus
      • API-Name: Workplace Connector Webhook
      • API-Version: v1
    7. Geben Sie auf der Event-Seite des Arbeitsplatz-Connector-Webhooks die folgenden Werte an:
      • token_name: Token-Parametername, der in Schritt 2 verwendet wird. Der Wert des Token-Namens wird von Abzeichenanbietern verwendet, um die Abzeichendaten (JSON) für Arbeitsplatz-Connectorenfreizugeben. Die Rohdaten (Nutzlast- oder Abzeichendaten) werden verarbeitet und in die Tabelle „Connector-Ereignisse“ 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 Symbol für das Menü „ Zusätzliche Aktionen“ (Symbol „Menü „Zusätzliche Aktionen“ ) aus.
      • token_value: In Schritt 2 angegebener Tokenwert. Der Tokenwert ist der geheime Schlüssel, der vom Abzeichenanbieter beim Aufrufen des API-Events verwendet wird, damit der Server die API-Anforderung authentifizieren kann.
      1. Wählen Sie im API-Anforderungstext die Option Roh aus, und kopieren Sie die Abzeichendaten (Nutzlast) im JSON-Format.
        Diese Abzeichendaten werden von Abzeichensensoren erfasst.
      2. Wählen Sie Senden aus.
        Wenn der Antwortcode 200 OK lautet und das Antwortergebnis Successlautet, werden die Abzeichendaten in die Tabelle „Connector-Ereignisse“ geladen.
        • Die Tabelle „Connector-Ereignisse“ (sn_wsd_wc_connector_events) lädt die Abzeichendaten, die von Abzeichenanbietern gemeinsam genutzt werden. Der Status der Abzeichendaten ist Neu, wenn sie vom REST-API-Explorer geladen werden.
        • Die Provider-Datensätze des Webhooks für den geplanten Aufgabenprozess werden jede Minute ausgeführt, um die Abzeichendaten aus der Tabelle „Connector-Ereignisse“ (Daten mit dem Status Neu) in die Tabelle „Mitarbeiteranwesenheitsdaten“ zu laden.
      Die regelmäßige Aufgabe übernimmt die Quelldaten aus dem Webhook- Event, um die Daten in das erforderliche Format umzuwandeln und sie dann in die Zieltabelle „Mitarbeiteranwesenheitsdaten“ einzufügen.
      Hinweis:
      Um auf die regelmäßigen Aufgaben von Arbeitsplatz-Connectoren zuzugreifen, navigieren Sie zu Alle > Systemdefinition > Geplante Aufgaben. Suchen Sie in der Spalte Anwendung nach Arbeitsplatz-Connectors. Für Arbeitsplatz-Connectorensind zwei geplante Aufgaben verfügbar.
      • Datensätze für Anbieterdaten verarbeiten: Liest Daten aus Lieferantenbadging-Daten (Quelltabelle). Nach der Verarbeitung der Abzeichendaten werden sie vom Datensatz in die Tabelle „Mitarbeiteranwesenheitsdaten“ (Zieltabelle) geladen. Weitere Informationen finden Sie unter Konfigurieren Sie die Daten der Abzeichentabelle.
      • Datensätze des Webhook-Providers verarbeiten: Liest Daten aus der Tabelle „Connector-Ereignisse“. Verarbeitet die Webhook-Ereignisdaten und lädt sie in die Tabelle „Mitarbeiteranwesenheitsdaten“ (Zieltabelle).
      • Die 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 „Anwesenheitsanalysen“ geladen.
        Hinweis:
        Datensätze mit Sicherheitsbadgings in der Tabelle „Connector-Ereignisse“ mit dem Status „Verarbeitet“ werden zwei Tage nach dem Erstellungsdatum oder dem aktuellen Datum durch die Tabelle „Connector-Ereignisse“ [sn_wsd_wc_connector_events] gelöscht. Daten im Fehlerstatus werden nach sieben Tagen ab dem Datum der Erstellung gelöscht. Daten im Status „Neu“ werden nicht gelöscht.