Event : Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 4 Minuten Lesedauer
  • Die Event -API stellt Methoden bereit, die das Festlegen/Abrufen von Werten innerhalb eines Events ermöglichen.

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

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

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

    Weitere Informationen zu Event Management finden Sie unter Event Management.

    Event – Event()

    Instantiiert einen Event-Konstruktor.

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

    Event – getField(String field)

    Gibt den aktuellen Wert des übergebenen Event Management-Felds zurück.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    field Zeichenfolge Name des Event Management-Feldwerts, der zurückgegeben werden soll.
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Wert des angeforderten Event Management-Felds.
    var event = new Event();
    var eventSource = event.getField("source");
    var eventSeverity = event.getField("severity");       
    

    Event – setAdditionalInfo(String additionalInfo)

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

    Hinweis:
    Sie können die setField()- Methode 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. Ergebnisse
    Typ Beschreibung
    void
    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

    Event – setField(String key, String value)

    Legt das angegebene Feld im zugeordneten Event fest.

    Wenn der in key übergebene mit einem vordefinierten Event-Feld übereinstimmt, aktualisiert die Methode das entsprechende Event-Feld. Andernfalls fügt die Methode den Parameter keyadditional_info dem Abschnitt [] des Events hinzu, bevor der übergebene Parameter [ value] angewendet wird.

    Im Folgenden sind die vordefinierten Event-Felder aufgeführt, die Sie mit dieser Methode ändern können:

    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 Konfigurationselement eindeutig identifiziert. Beispiel: {"name":"SAP ORA01","type":"Oracle"} ({"Name": "SAP ORA01", "Typ": "Oracle"}).

    Maximale Länge: 1.000 Zeichen

    cmdb_ci Sys_id des Configuration Item-Datensatzes [cmdb_ci], an den das Event gebunden werden soll.

    Standard: Null

    Beschreibung Freiformbeschreibung des Ereignisse.

    Maximale Länge: 4.000 Zeichen

    Zugeordnetes UI-Feld: Beschreibung

    Standard: Null

    event_class Enterprise Message Service (EMS), der das Event generiert hat. Zum Beispiel „Solarwinds“ oder „SCOM“.

    Maximale Länge: 100

    Zugeordnetes UI-Feld: Quellinstanz

    Standard: Null

    message_key Eindeutiger Event-Bezeichner. Um einen vorhandenen Event-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 Event-Auflösungsstatus.
    Gültige Werte:
    • Neu: Lösungsstatus für das entsprechende Event ist offen.
    • Wird geschlossen: Der Lösungsstatus für das entsprechende Event ist „Wird geschlossen“.

    Zugeordnetes UI-Feld: Lösungsstatus

    Standard: Neu

    Ressource Knotenressource, die dem Event zugeordnet werden soll. Zum Beispiel „Datenträger C:“, „CPI-1“ oder der Name eines Prozesses oder Services.

    Maximale Länge: 100 Zeichen

    Zugeordnetes UI-Feld: Ressource

    Schweregrad Event-Schweregrad.
    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 – Die Ressource funktioniert zwar noch, bedarf aber der Aufmerksamkeit.
    • 3: Gering – Teilweiser, nicht kritischer Verlust der Funktionalität oder Leistungsverschlechterung.
    • 4: Schwerwiegend – Wichtige Funktionalität ist schwer beeinträchtigt, oder die Leistung hat sich verschlechtert.
    • 5: Kritisch – Sofortige Aktion ist erforderlich. Die Ressource funktioniert entweder nicht, oder kritische Probleme stehen unmittelbar bevor.

    Zugeordnetes UI-Feld: Schweregrad

    Standard: Null

    Quelle Instanz des EMS, der das Event ausgelöst hat. In der Regel der Connector-Instanzname.

    Maximale Länge: 200 Zeichen

    Zugeordnetes UI-Feld: Quelle

    Standard: Null

    time_of_event UTC-Zeit, zu der das Event im Quellsystem aufgetreten ist.

    Format: „jjjj-MM-tt HH:mm:ss“

    Maximale Länge: 40 Zeichen

    Zugeordnetes UI-Feld: Zeit des Ereignisse

    Standard: Aktuelles Datum/aktuelle Uhrzeit

    type Metriktyp, zu dem das Event gehört, z. B. Datenträger oder CPU. Dieser Wert wird verwendet, um einen Event-Datensatz 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 Event-Zeit zu aktualisieren.

    Weitere Informationen zu Events finden Sie unter Event Management.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    key Zeichenfolge Name des Schlüssels, der im Event hinzugefügt oder aktualisiert werden soll. Weitere Informationen zu den vordefinierten Event-Feldern finden Sie unter Event-Feldformat für Event-Erfassung.
    Wert Zeichenfolge Informationen, die im zugeordneten Event-Feld gespeichert werden sollen.
    Hinweis:
    Die Zeichenfolge value wird vor dem Speichern gekürzt, wobei mehrere Leerzeichen durch ein einzelnes Leerzeichen ersetzt werden.
    Tabelle : 7. Ergebnisse
    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       
    

    Event – setText(String text)

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

    Hinweis:
    Sie können auch die Methode Event – setField(String key, String value) verwenden, um das Feld text im aktuellen Event festzulegen. Im Gegensatz zur setField() -Methode schneidet diese Methode den übergebenen Text nicht ab.
    Tabelle : 8. Parameter
    Name Typ Beschreibung
    text Zeichenfolge Text, der im Feld description des zugeordneten Events gespeichert werden soll.

    Maximale Länge: 4.000 Zeichen

    Tabelle : 9. Ergebnisse
    Typ Beschreibung
    void
    var event = new Event();
    event.setText("SAP Solman");       
    

    Event – setTimeOfEvent(String timeOfEvent)

    Legt das Feld time_of_event im zugeordneten Event auf den übergebenen UTC-Zeitwert fest.

    Hinweis:
    Sie können auch die Methode Event – setField(String key, String value) verwenden, um das Feld time_of_event festzulegen.
    Tabelle : 10. Parameter
    Name Typ Beschreibung
    timeOfEvent Zeichenfolge UTC-Zeitwert, der im Feld time_of_event festgelegt werden soll.

    Format: „jjjj-MM-tt HH:mm:ss“

    Maximale Länge: 40 Zeichen

    Tabelle : 11. Ergebnisse
    Typ Beschreibung
    void
    var event = new Event();
    event.setTimeOfEvent("2019-18-05 13:12:05");