Événement – Global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture

    • L’API d’événement fournit des méthodes qui permettent de définir et d’obtenir des valeurs dans un événement.

    Ces événements sont envoyés de A Serveur MID à une ServiceNow instance. Avant de pouvoir envoyer des événements, la connexion entre l’instance Serveur MID doit ServiceNow être définie.

    Utilisez l’API d’événement pour ajouter/mettre à jour des champs au sein d’un événement. Utilisez l’API SNEventSenderProvider pour instancier un objet d’expéditeur d’événement. Utilisez ensuite l’API IEventSender pour envoyer l’événement à une ServiceNow instance.

    Vous devez activer le module d’extension Gestion des événements (com.glideapp.itom.snac) avant de tenter d’accéder à cette API. Le module d’extension Gestion des événements nécessite un abonnement séparé et doit être activé. Ce module d’extension inclut des données de démonstration et active les modules d’extension connexes s’ils ne sont pas déjà activés.

    Pour plus d’informations sur la gestion des événements, consultez Gestion des événements.

    Événement : Event()

    Instancie un constructeur d’événement.

    Tableau 1. Paramètres
    Nom Type Description
    Aucun 
    var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");

    Événement : getField(champ String)

    Renvoie la valeur actuelle du champ de gestion des événements transmis.

    Tableau 2. Paramètres
    Nom Type Description
    champ Chaîne Nom de la valeur de champ de gestion des événements à renvoyer.
    Tableau 3. Renvoie
    Type Description
    Chaîne Valeur du champ de gestion des événements demandé. 
    var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");

    Événement : setAdditionalInfo(String additionalInfo)

    Remplace le champ existant additional_info dans l’événement associé par la chaîne JSON transmise.

    Remarque :
    Vous pouvez utiliser la méthode setField() pour mettre à jour un champ spécifique dans le additional_info champ.
    Tableau 4. Paramètres
    Nom Type Description
    additionalInfo Chaîne Chaîne JSON (paires clé/valeur) à enregistrer dans le additional_info champ.
    Remarque :
    Ce paramètre remplace les informations existantes. Elle ne met pas à jour les champs existants.
    Tableau 5. Renvoie
    Type Description
    nul 
    event.setAdditionalInfo("{\"evtComponent\":\"Microsoft-Windows- WindowsUpdateClient\",\"evtMessage\":\"Installation Failure: Windows failed. Error 0x80070490\"}");

    Événement : setField(clé de chaîne, valeur de chaîne)

    Définit le champ spécifié dans l’événement associé.

    Si le transmis key correspond à un champ d’événement prédéfini, la méthode met à jour le champ d’événement correspondant. Dans le cas contraire, la méthode ajoute le key paramètre à la additional_info section de l’événement avant d’appliquer le fichier .value

    Voici les champs d’événement prédéfinis que vous pouvez modifier à l’aide de cette méthode :

    Champ Description
    additional_info Paire clé-valeur à ajouter au additional_info champ de l’événement associé. Si la clé transmise existe déjà, sa valeur est remplacée.

    Longueur maximale : 4 000 caractères

    Champ d’interface utilisateur associé : Informations supplémentaires
    ci_identifier Chaîne JSON qui identifie de manière unique un élément de configuration. Par exemple, {"name":"SAP ORA01","type":"Oracle"}.

    Longueur maximale : 1 000 caractères
    cmdb_ci Sys_id de l’enregistrement d’élément de configuration [cmdb_ci] auquel lier l’événement.

    Par défaut : null
    description Description de forme libre de l’événement.

    Longueur maximale : 4 000 caractères

    Champ d’interface utilisateur associé : description

    Par défaut : null
    event_class Service de messagerie d’entreprise (EMS) qui a généré l’événement. Par exemple, « Solarwinds » ou « SCOM ».

    Longueur maximale : 100

    Champ d’interface utilisateur associé : Instance source

    Par défaut : null
    message_key Identificateur unique d’événement. Pour remplacer la gravité d’un événement existant, utilisez la même message_key valeur.

    Longueur maximale : 1 024 caractères

    Champ d’interface utilisateur associé : Clé du message

    Par défaut : combinaison de source, node, type, resource, et metric name.
    resolution_state État de résolution de l’événement.
    Valeurs valides :
    • Nouveau : l’état de résolution de l’événement correspondant est ouvert.
    • Fermeture : l’état de résolution de l’événement correspondant est fermeture/fermée.

    Champ d’interface utilisateur associé : état de résolution

    Par défaut : Nouveau
    resource Ressource de nœud à associer à l’événement. Par exemple, « Disque C : », « CPI-1 » ou le nom d’un processus ou d’un service.

    Longueur maximale : 100 caractères

    Champ d’interface utilisateur associé : Ressource
    severity Gravité de l’événement.
    Valeurs valides :
    • 0 : effacer : aucune action n’est requise. Aucune alerte n'est créée à partir de cet événement. Les alertes existantes sont arrêtées.
    • 1 : OK : une alerte est créée. La ressource est toujours fonctionnelle.
    • 2 : Avertissement : attention requise, même si la ressource est toujours fonctionnelle.
    • 3 : Mineur : une perte partielle et non critique de fonctionnalité ou une dégradation des performances s’est produite.
    • 4 : majeur : la fonctionnalité majeure est gravement altérée ou les performances se sont dégradées.
    • 5 : Critique : une action immédiate est requise. La ressource n'est pas fonctionnelle ou des problèmes critiques sont imminents.

    Champ d’interface utilisateur associé : Gravité

    Par défaut : null
    source Instance de l’EMS qui a déclenché l’événement. En général, le nom de l’instance de connecteur.

    Longueur maximale : 200 caractères

    Champ d’interface utilisateur associé : source

    Par défaut : null
    time_of_event Heure UTC à laquelle l’événement s’est produit dans le système source.

    Format : « aaaa-MM-jj HH :mm :ss »

    Longueur maximale : 40 caractères

    Champ d’interface utilisateur associé : Heure de l’événement

    Par défaut : Date/heure actuelle
    type Type de mesure auquel l’événement est lié, tel que Disque ou Processeur. Cette valeur est utilisée pour identifier un enregistrement d’événement à partir duquel les alertes sont créées.

    Longueur maximale : 100 caractères

    Champ d’interface utilisateur associé : type

    Par défaut : null
    Remarque :
    Vous pouvez également utiliser la méthode setText() pour mettre à jour le description champ et la méthode setTimeOfEvent() pour mettre à jour l’heure de l’événement.

    Pour plus d’informations sur les événements, consultez Gestion des événements.

    Tableau 6. Paramètres
    Nom Type Description
    key Chaîne Nom de la clé à ajouter ou mettre à jour dans l’événement. Pour plus d’informations sur les champs d’événements prédéfinis, consultez Format de champ d’événement pour la collecte d’événements.
    valide Chaîne Informations à stocker dans le champ d’événement associé.
    Remarque :
    La value chaîne est tronquée avant d’être stockée, ce qui signifie que plusieurs espaces sont remplacés par un seul espace.
    Tableau 7. Renvoie
    Type Description
    nul 
    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

    Événement : setText(Texte de chaîne)

    Définit le description champ de l’événement associé sur la valeur transmise.

    Remarque :
    Vous pouvez également utiliser la méthode pour définir le Événement : setField(clé de chaîne, valeur de chaîne)text champ dans l’événement actuel. Contrairement à la méthode setField(), cette méthode ne rogne pas le texte transmis.
    Tableau 8. Paramètres
    Nom Type Description
    Texte Chaîne Texte à stocker dans le description champ de l’événement associé.

    Longueur maximale : 4 000 caractères
    Tableau 9. Renvoie
    Type Description
    nul 
    var event = new Event();
event.setText("SAP Solman");

    Événement : setTimeOfEvent(String timeOfEvent)

    Définit le time_of_event champ de l’événement associé sur la valeur de temps UTC transmise.

    Remarque :
    Vous pouvez également utiliser la méthode pour définir le Événement : setField(clé de chaîne, valeur de chaîne)time_of_event champ.
    Tableau 10. Paramètres
    Nom Type Description
    timeOfEvent Chaîne Valeur d’heure UTC à définir dans le time_of_event champ.

    Format : « aaaa-MM-jj HH :mm :ss »

    Longueur maximale : 40 caractères
    Tableau 11. Renvoie
    Type Description
    nul 
    var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");