Ereignis : Global

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

    • Die Ereignis- API stellt Methoden bereit, mit denen Werte in einem Ereignis festgelegt und abgerufen werden können.

    Diese Ereignisse werden von einer MID-Server - an eine ServiceNow -Instanz gesendet. Bevor Sie erfolgreich Ereignisse senden können, muss die Verbindung zwischen den Instanzen MID-Server und ServiceNow definiert werden.

    Verwenden Sie die Ereignis -API, um Felder in einem Ereignis hinzuzufügen/zu aktualisieren. Verwenden Sie die SNEventSenderProvider -API, um ein Ereignis-Absenderobjekt zu instanziieren. Verwenden Sie dann die IEventSender -API, um das Ereignis an eine Instanz ServiceNow zu senden.

    Sie müssen das Plugin „Ereignismanagement“ (com.glideapp.itom.snac) aktivieren, bevor Sie versuchen, auf diese API zuzugreifen. Das Plugin „Ereignismanagement“ erfordert ein separates Abonnement und muss aktiviert werden. Dieses Plugin enthält Demodaten und aktiviert zugehörige Plugins, wenn sie nicht bereits aktiv sind.

    Weitere Informationen zum Ereignismanagement finden Sie unter Ereignismanagement.

    Ereignis: Ereignis ()

    Instanziiert einen Ereigniskonstruktor.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine 
    var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");

    Ereignis – getField(Zeichenfolgenfeld)

    Gibt den aktuellen Wert des Felds „Ereignismanagement“ zurück, das übergeben wurde.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Name des zurückzugebenden Ereignismanagement-Feldwerts.
    Tabelle : 3. Rückgaben
    Typ Beschreibung
    Zeichenfolge Wert des angeforderten Ereignismanagement-Felds. 
    var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");

    Ereignis – setAdditionalInfo(String zusätzlicheInfo)

    Ersetzt das vorhandene Feld additional_info im zugeordneten Ereignis durch die übergebene JSON-Zeichenfolge.

    Hinweis:
    Sie können die Methode setField() verwenden, um ein bestimmtes Feld im Feld additional_info zu aktualisieren.
    Tabelle : 4. Parameter
    Name Typ Beschreibung
    additionalInfo Zeichenfolge JSON-Zeichenfolge (Schlüssel-Wert-Paare), die im Feld additional_info gespeichert werden sollen.
    Hinweis:
    Dieser Parameter ersetzt die vorhandenen Informationen. Die vorhandenen Felder werden nicht aktualisiert.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    void 
    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

    Ereignis – setField(Zeichenfolgenschlüssel, Zeichenfolgenwert)

    Legt das angegebene Feld im zugeordneten Ereignis fest.

    Wenn der in key übergebene mit einem vordefinierten Ereignisfeld übereinstimmt, aktualisiert die Methode das entsprechende Ereignisfeld. Andernfalls fügt die Methode den Parameter key dem Abschnitt additional_info des Ereignisse hinzu, bevor der übergebene Parameter in valueangewendet wird.

    Die folgenden vordefinierten Ereignisfelder können Sie mit dieser Methode ändern:

    Feld Beschreibung
    additional_info Schlüssel-Wert-Paar, das dem Feld additional_info des zugeordneten Ereignisses hinzugefügt werden soll. Wenn der übergebene Schlüssel bereits vorhanden ist, wird sein Wert überschrieben.

    Maximale Länge: 4.000 Zeichen

    Zugeordnetes UI-Feld: Zusätzliche Informationen
    ci_identifier JSON-Zeichenfolge, die ein Configuration Item eindeutig identifiziert. Beispiel: {"name":"SAP ORA01","type":"Oracle"} ({"Name": "SAP ORA01", "Typ": "Oracle"}).

    Maximale Länge: 1.000 Zeichen
    cmdb_ci Sys_id des Konfigurationselement-Datensatzes [cmdb_ci], an den das Ereignis gebunden werden soll.

    Standard: Null
    description Freiform-Beschreibung des Ereignisses.

    Maximale Länge: 4.000 Zeichen

    Zugeordnetes UI-Feld: Beschreibung

    Standard: Null
    event_class Enterprise Message Service (EMS), von dem das Ereignis generiert wurde. Beispiel: „SolarWinds“ oder „SCOM“.

    Maximale Länge: 100

    Zugeordnetes UI-Feld: Quellinstanz

    Standard: Null
    message_key Eindeutiger Ereignis-Bezeichner. Um einen vorhandenen Ereignis-Schweregrad zu überschreiben, verwenden Sie denselben message_key -Wert.

    Maximale Länge: 1024 Zeichen

    Zugeordnetes UI-Feld: Nachrichtenschlüssel

    Standard: Kombination aus source, node, type, resourceund metric name.
    resolution_state Ereignislösungsstatus.
    Gültige Werte:
    • Neu: Der Lösungsstatus für das entsprechende Ereignis ist „Offen“.
    • Wird geschlossen: Der Lösungsstatus für das entsprechende Ereignis ist „Geschlossen“/„Geschlossen“.

    Zugeordnetes UI-Feld: Lösungsstatus

    Standard: Neu
    Ressource Knotenressource, die dem Ereignis zugeordnet werden soll. Beispiele: „Datenträger C:“, „CPI-1“ oder der Name eines Prozesses oder Services.

    Maximale Länge: 100 Zeichen

    Zugeordnetes UI-Feld: Ressource
    Schweregrad Ereignisschweregrad.
    Gültige Werte:
    • 0: Löschen – Es ist keine Aktion erforderlich. Aus diesem Event wird keine Warnung erstellt. Vorhandene Warnungen werden geschlossen.
    • 1: OK – Eine Warnung wird erstellt. Die Ressource ist weiterhin funktionsfähig.
    • 2: Warnung – Aufmerksamkeit ist erforderlich, obwohl die Ressource noch funktionsfähig ist.
    • 3: Gering – Ein teilweiser, nicht kritischer Verlust der Funktionalität oder eine Leistungsverschlechterung ist aufgetreten.
    • 4: Schwerwiegend: Wichtige Funktionalität ist schwer beeinträchtigt, oder die Leistung wurde beeinträchtigt.
    • 5: Kritisch: Es ist eine sofortige Aktion erforderlich. Die Ressource funktioniert entweder nicht, oder kritische Probleme stehen unmittelbar bevor.

    Zugeordnetes UI-Feld: Schweregrad

    Standard: Null
    Quelle EMS-Instanz, die das Ereignis ausgelöst hat. Normalerweise der Name der Connector-Instanz.

    Maximale Länge: 200 Zeichen

    Zugeordnetes UI-Feld: Quelle

    Standard: Null
    time_of_event UTC-Zeit, zu der das Ereignis im Quellsystem aufgetreten ist.

    Format: "JJJJ-MM-TT HH:mm:ss"

    Maximale Länge: 40 Zeichen

    Zugeordnetes UI-Feld: Zeit des Ereignisses

    Standard: Aktuelle(s) Datum/Uhrzeit
    Typ Metriktyp, auf den sich das Ereignis bezieht, z. B. Datenträger oder CPU. Dieser Wert wird verwendet, um einen Ereignisdatensatz zu identifizieren, aus dem Warnungen erstellt werden.

    Maximale Länge: 100 Zeichen

    Zugeordnetes UI-Feld: Typ

    Standard: Null
    Hinweis:
    Sie können auch die Methode setText() verwenden, um das Feld description zu aktualisieren, und die Methode setTimeOfEvent(), um die Ereigniszeit zu aktualisieren.

    Weitere Informationen zu Ereignissen finden Sie unter Ereignismanagement.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    key Zeichenfolge Name des Schlüssels, der im Ereignis hinzugefügt oder aktualisiert werden soll. Weitere Informationen zu den vordefinierten Ereignisfeldern finden Sie unter Ereignisfeldformat für Ereigniserfassung.
    Wert Zeichenfolge Informationen, die im zugehörigen Ereignisfeld gespeichert werden sollen.
    Hinweis:
    Die Zeichenfolge value wird vor dem Speichern gekürzt, wodurch mehrere Leerzeichen durch ein einziges Leerzeichen ersetzt werden.
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    void 
    var event = new Event();
event.setField("source","SAP Solman");
event.setField("severity","3");
event.setField("time_of_event", "2019-18-05 13:12:05");
event.setField("type", "SAP object");
event.setField("user", "admin"); // parameter will be added to additional_info section

    Ereignis – setText(String text)

    Legt das Feld description des zugeordneten Ereignisses auf den übergebenen Wert fest.

    Hinweis:
    Sie können auch die Methode Ereignis – setField(Zeichenfolgenschlüssel, Zeichenfolgenwert) verwenden, um das Feld text im aktuellen Ereignis festzulegen. Im Gegensatz zur Methode setField() kürzt diese Methode den übergebenen Text nicht.
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    text Zeichenfolge Text, der im Feld description des zugeordneten Ereignisses gespeichert werden soll.

    Maximale Länge: 4000 Zeichen
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    void 
    var event = new Event();
event.setText("SAP Solman");

    Ereignis – setTimeOfEvent(String timeOfEvent)

    Legt das Feld time_of_event im zugeordneten Ereignis auf den in UTC-Zeit übergebenen Wert fest.

    Hinweis:
    Sie können auch die Methode Ereignis – setField(Zeichenfolgenschlüssel, Zeichenfolgenwert) verwenden, um das Feld time_of_event festzulegen.
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Ereigniszeit Zeichenfolge UTC-Zeitwert, der im Feld time_of_event festgelegt werden soll.

    Format: "JJJJ-MM-TT HH:mm:ss"

    Max. Länge: 40 Zeichen
    Tabelle : 11. Rückgaben
    Typ Beschreibung
    void 
    var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");