Konfigurieren Sie einen anwenderdefinierten Connector

Freigeben Version: Xanadu

Aktualisiert 1. August 2024

6 Minuten Lesedauer

Authentifizieren Sie Ihren anwenderdefinierten Connector als Datenquelle, um die Übertragung von Ereignisinformationen an die Instanz ServiceNow zu ermöglichen. Definieren Sie den anwenderdefinierten Connector, indem Sie die zugehörigen Details und Zuordnungsfelder angeben. Dadurch können die extrahierten Informationen aus den Ereignisnachrichten Ihres anwenderdefinierten Connectors die erforderlichen Ereignisfelder ausfüllen. Erstellen Sie abschließend eine URL für den anwenderdefinierten Connector-Webhook, und stellen Sie sie bereit.

Vorbereitungen

Stellen Sie sicher, dass das Plugin Ereignismanagement „ Connectors (sn_em_connector) in der Instanz Now Platform installiert ist. Weitere Informationen finden Sie unter Konfigurieren Sie die Ereignismanagement -Connectors.
Stellen Sie sicher, dass die Konfigurationselemente für die von Ihrem anwenderdefinierten Connector verwalteten Hosts in der Instanz Now Platform vorhanden sind. Diese CIs können physisch oder virtuell sein und entweder manuell erstellt oder mittels IP-Erkennung oder Cloud-Discovery erkannt werden. Weitere Informationen finden Sie unter Auf Cloud-Umgebungen für ITOM-Produkte zugreifen.

Erforderliche Rolle: evt_mgmt_admin

Warum und wann dieser Vorgang ausgeführt wird

Um mit der Übertragung von Ereignisinformationen an Ihre Instanz ServiceNow zu beginnen, müssen Sie Ihre Instanz Now Platform als REST-Endpunkt mit einem Standard-Webhook in Ihrem anwenderdefinierten Connector festlegen.

Durch die Bereitstellung von Connector-Details und Zuordnungsfeldern definieren Sie den anwenderdefinierten Connector. Die extrahierten Informationen aus den Ereignisnachrichten des anwenderdefinierten Connectors füllen dann die erforderlichen Ereignisfelder aus und fügen das Ereignis in die Datenbank ein.

Die URL wird vom Code basierend auf der Instanz ServiceNow und dem anwenderdefinierten Connector generiert. Verwenden Sie diese URL, um einen Webhook zu erstellen, mit dem Ihr anwenderdefinierter Connector Ereignisse an die Instanz ServiceNow senden kann.

Prozedur

Navigieren zu Arbeitsbereiche > Service Operations-Arbeitsbereich.
Wählen Sie im linken Bereich das Integrations-Launchpad-Symbol ( )
Wählen Sie auf der Registerkarte Integrationen durchsuchen die Dropdown-Liste Alle Integrationen und dann Anwenderdefiniertaus.
Es werden nur anwenderdefinierte Connector-Kacheln angezeigt.

Abbildung : 1. Push-Connectors
Wählen Sie eine Kachel des anwenderdefinierten Connector-Typs aus.
Geben Sie auf der Seite „Details bereitstellen“ die Details für den Connector an.

Abbildung : 2. Detailseite für anwenderdefinierte Connectors
1. Geben Sie im Feld Connector-Name einen eindeutigen Integrationsnamen für den Connector ein.
2. Wahlweise: Geben Sie im Feld Tags Tags ein, um Connectors dieses Typs auf Express-Listezu finden und zu identifizieren.
  Um zusätzliche Tags hinzuzufügen, wählen Sie das Pluszeichen ( ) neben dem Feld Tags. Das Fenster „Tags hinzufügen“ wird geöffnet.
  1. Geben Sie im Feld Schlüssel einen Tag-Schlüssel ein.
  2. Geben Sie im Feld Wert einen Tag-Wert ein.
  3. Wählen Sie Hinzufügen.
3. Wahlweise: Geben Sie im Feld Beschreibung kurze Informationen zu diesem Connector ein.
4. Geben Sie im Feld Quelle den Lieferanten ein, der zum Sammeln von Ereignissen aus der externen Quelle verwendet wird.
  
  Das Feld Quelle identifiziert den Connector und dient als Bezeichner, um die Quelle von Ereignissen und Warnungen zu erkennen, sobald der Connector aktiv ist.
5. Wahlweise: Wählen Sie in der Dropdown-Liste Zuweisungsgruppe die Gruppe oder das Team aus, die bzw. das für die Verwaltung und Wartung des Connectors verantwortlich ist.
Wahlweise: Ziehen Sie ein Bild, oder laden Sie es hoch, um es in Ihrer Connector-Kachel anzuzeigen.
- Ziehen Sie ein Bild in das Feld.
- Navigieren Sie zur Bilddatei, indem Sie Bild hochladen auswählen, und wählen Sie dann die Datei aus.
Die maximale Uploadgröße beträgt 1 MB.
Legen Sie fest, ob Sie Ereignisse direkt mit der Instanz ITOM oder über eine Instanz MID-Server] verbinden möchten.
- Um Ereignisse direkt an die Instanz ITOM zu senden, wählen Sie Direkt zur ITOM-Instanz aus.
- Um Ereignisse über einen MID-Serverzu senden, der das Ereignis verarbeitet und dann an die Instanz übergibt, wählen Sie Über den MID-Serveraus.
  
  Wenn ein MID-Server vorhanden ist, wählen Sie im Feld MID-Server auswählen einen verfügbaren MID-Server aus, der mit einem Ereignis-Listener verbunden ist.
  Wenn Sie ein MID-Servererstellen müssen, wählen Sie eine der folgenden Optionen aus.
  - MID-Webservererweiterung konfigurieren
  - MID-Webservice-Ereignis konfigurieren – Collector-Kontext
  Weitere Informationen finden Sie unter MID-Webservererweiterung konfigurieren und MID-WebService-Event-Sammlerkontext konfigurieren.
Wählen Sie Weiter.

Wählen Sie auf der Seite „Eingabemethode einrichten“ eine Methode zum Sammeln von Ereignisdaten aus.

Methode	Beschreibung
Sammeln Sie echte Quellereignisse, um Felder zu definieren	Wählen Sie Echte Quellereignisse sammeln, um Felder zu definieren. Hinweis: Durch das Sammeln von Ereignissen aus echten Quellen von Ihrem anwenderdefinierten Connector erhöhen Sie die Genauigkeit von Ereignissen und Warnungen, indem Sie mehrere Ereignisse als Referenz zum Definieren der Felder verwenden. Wählen Sie In Zwischenablage kopieren und kopieren Sie die URL. Fügen Sie die URL in das Webhook-Setup Ihres anwenderdefinierten Connectors ein, um einen Webhook zu erstellen, mit dem Ihr anwenderdefinierter Connector Ereignisse an die Instanz ServiceNow senden kann. Geben Sie Ihre Anmeldeinformationen für die Standardauthentifizierung in die Webhook-Konfiguration des Überwachungssystems ein (z. B. Anwendername und Passwort). Mit dem -Webhook kann Ihr anwenderdefinierter Connector Ereignisse an die -Instanz senden. Wählen Sie Auf Ereignisse prüfen aus. Die Anzahl der Ereignisse wird angezeigt. Das Ereignis erstellt JSON-Dateien, die Sie durchsuchen können, nachdem Sie Weitergewählt haben.
JSON-Beispiel für die Zuordnung von Feldern verwenden	Wählen Sie JSON-Beispiel zum Zuordnen von Feldern verwenden aus. Hinweis: Wählen Sie diese Option nur aus, wenn Sie über ein JSON-Beispiel verfügen. Kopieren Sie im Dialogfeld „ Payload eingeben“ Ihre JSON-Beispiel-Payload, und fügen Sie sie ein, um die Zuordnung zum Zuordnen der Felder zu erstellen und anzuzeigen. Wählen Sie JSON hochladen aus. Wählen Sie Bearbeiten oder neue JSON einfügen aus, um die hochgeladene JSON zu bearbeiten oder eine neue einzufügen. Wählen Sie In Zwischenablage kopieren und kopieren Sie die URL. Fügen Sie die URL in das Webhook-Setup Ihres anwenderdefinierten Connectors ein, um einen Webhook zu erstellen, mit dem Ihr anwenderdefinierter Connector Ereignisse an die Instanz ServiceNow senden kann. Geben Sie Ihre Anmeldeinformationen für die Standardauthentifizierung in die Webhook-Konfiguration des Überwachungssystems ein (z. B. Anwendername und Passwort). Mit dem -Webhook kann Ihr anwenderdefinierter Connector Ereignisse an die -Instanz senden.

Methode

Beschreibung

Sammeln Sie echte Quellereignisse, um Felder zu definieren

Wählen Sie Echte Quellereignisse sammeln, um Felder zu definieren.
Hinweis:
Durch das Sammeln von Ereignissen aus echten Quellen von Ihrem anwenderdefinierten Connector erhöhen Sie die Genauigkeit von Ereignissen und Warnungen, indem Sie mehrere Ereignisse als Referenz zum Definieren der Felder verwenden.
Wählen Sie In Zwischenablage kopieren und kopieren Sie die URL.
Fügen Sie die URL in das Webhook-Setup Ihres anwenderdefinierten Connectors ein, um einen Webhook zu erstellen, mit dem Ihr anwenderdefinierter Connector Ereignisse an die Instanz ServiceNow senden kann. Geben Sie Ihre Anmeldeinformationen für die Standardauthentifizierung in die Webhook-Konfiguration des Überwachungssystems ein (z. B. Anwendername und Passwort). Mit dem -Webhook kann Ihr anwenderdefinierter Connector Ereignisse an die -Instanz senden.
Wählen Sie Auf Ereignisse prüfen aus. Die Anzahl der Ereignisse wird angezeigt. Das Ereignis erstellt JSON-Dateien, die Sie durchsuchen können, nachdem Sie Weitergewählt haben.

JSON-Beispiel für die Zuordnung von Feldern verwenden

Wählen Sie JSON-Beispiel zum Zuordnen von Feldern verwenden aus.
Hinweis:
Wählen Sie diese Option nur aus, wenn Sie über ein JSON-Beispiel verfügen.
Kopieren Sie im Dialogfeld „ Payload eingeben“ Ihre JSON-Beispiel-Payload, und fügen Sie sie ein, um die Zuordnung zum Zuordnen der Felder zu erstellen und anzuzeigen.
Wählen Sie JSON hochladen aus.
Wählen Sie Bearbeiten oder neue JSON einfügen aus, um die hochgeladene JSON zu bearbeiten oder eine neue einzufügen.
Wählen Sie In Zwischenablage kopieren und kopieren Sie die URL.
Fügen Sie die URL in das Webhook-Setup Ihres anwenderdefinierten Connectors ein, um einen Webhook zu erstellen, mit dem Ihr anwenderdefinierter Connector Ereignisse an die Instanz ServiceNow senden kann. Geben Sie Ihre Anmeldeinformationen für die Standardauthentifizierung in die Webhook-Konfiguration des Überwachungssystems ein (z. B. Anwendername und Passwort). Mit dem -Webhook kann Ihr anwenderdefinierter Connector Ereignisse an die -Instanz senden.

Wählen Sie Weiter.
Die Seite wird geöffnet, auf der Sie Felder zuordnen können.
Geben Sie auf der Seite „Felder zuordnen“ in der Spalte mit den Connector-Feldnamen mindestens einen Wert ein, der den ServiceNow Schweregradwerten entspricht, die in der Spalte „Schweregradfeld“ aufgeführt sind.
Geben Sie auf der Seite „Felder zuordnen“ in der Spalte mit den Connector-Feldnamen mindestens einen Wert ein, der den ServiceNow Schweregradwerten entspricht, die in der Spalte „Schweregradfeld“ aufgeführt sind.

Sie können den Schweregradwert aus dem JSON-Codebeispiel eingeben. Um einen Schweregradwert festzulegen, müssen Sie mit der Nutzlast Ihres anwenderdefinierten Connectors und den von ihm unterstützten Schweregradtypen vertraut sein. Die Schweregradwerte der empfangenen Ereignisse müssen mit den generierten Ereignissen in Ihrem System übereinstimmen.

Aktivieren Sie das System, um Ereignisse aus eingehenden Daten korrekt zu erstellen, indem Sie die Felder in Ihrem JSON-Codebeispiel den Feldern ServiceNow zuordnen. Die Informationen zum Schweregrad und zum Nachrichtenschlüssel werden automatisch ausgefüllt, um Ihnen Zeit und Aufwand zu sparen. Der Nachrichtenschlüssel stellt den richtigen Bezeichner für die Ereignisse bereit, um sicherzustellen, dass die Deduplizierung ordnungsgemäß funktioniert und keine redundanten Warnungen generiert werden.
Wahlweise: Um mehrere JSON-Dateien anzuzeigen, wählen Sie den Pfeil über dem JSON-Beispiel.
Wahlweise: Geben Sie im Abschnitt Andere Felder in der Spalte Ihr Connector anwenderdefinierte Ereignisparameter an, die optional sind, aber zusätzliche Informationen zum Ereignis liefern.
Wenn Sie die optionalen Informationen nicht angeben, lassen Sie das Feld leer.
1. Geben Sie im Feld Beschreibung eine aussagekräftige Warnungsbeschreibung ein.
2. Geben Sie im Feld Metrikname einen Metriknamen ein, mit dem Sie Ereignisse den Leistungsmetriken oder KPIs zuordnen können, die die Warnung ausgelöst haben.
3. Geben Sie im Feld Knoten einen Knotenwert ein, der für die CI-Bindung verwendet werden soll.
4. Geben Sie im Feld Ereigniszeit die Erstellungszeit des Ereignisses des anwenderdefinierten Connectors ein.
  Wenn die Ereigniszeit nicht zugeordnet ist, verwendet das System die Standardereigniszeit.
5. Wählen Sie im Feld Einstellungen für Ereigniszeit das Zeitformat und die Zeitzone des Ereignisse aus.
  - Zeitformat: Ein GlideDateTime-Feld im UTC- oder GMT-Format mit einer maximalen Länge von 40 Zeichen.
  - Zeitzone: Zeiten werden in Coordinated Universal Time (UTC) gespeichert und basierend auf der Systemzeitzone global angezeigt.
Aktivieren und speichern Sie den Connector, indem Sie Aktivieren und dann im Bestätigungs-Popup-Fenster OK auswählen.
Sie können die Connector-Details auf der Registerkarte Details und Ihre Feldzuordnungen auf der Registerkarte Feldzuordnung anzeigen.

Ergebnisse

Nachdem der -Connector aktiviert wurde, beginnen Ereignisse von Ihrer anwenderdefinierten Connector-Konsole in die Instanz ServiceNow zu fließen. Das Plugin extrahiert Informationen aus der ursprünglichen Ereignisnachricht des anwenderdefinierten Connectors, um die erforderlichen Ereignisfelder auszufüllen, und fügt das Ereignis in die Datenbank ein. Um die Ereignisse in Ihrer Instanz Now Platform anzuzeigen, navigieren Sie zu Alle Ereignisse. Weitere Informationen finden Sie unter Events anzeigen.

Nächste Maßnahme

Um zu überprüfen, ob der Prozess erfolgreich abgeschlossen wurde und Ereignisse in das System fließen, zeigen Sie die zugehörigen Ereignisse auf der Registerkarte Zugehörige Ereignisse an. Wenn das Setup erfolgreich ist, fahren Sie mit Automatisierung hinzufügen, um eine Warnungsautomatisierung einzurichten. Informationen zur Warnungsautomatisierung finden Sie unter Warnungsautomatisierung in Service Operations-Arbeitsbereich für ITOM.