Événement : global
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 d’une Serveur MID instance à une ServiceNow autre. Avant de pouvoir envoyer des événements, la connexion entre le Serveur MID et l’instance ServiceNow doit être définie.
Utilisez l’API d’événement pour ajouter/mettre à jour des champs dans 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.
| Nom | Type | Description |
|---|---|---|
| Néant |
var event = new Event();
var esource = event.getField("source");
var eseverity = event.getField("severity");
Événement : getField(champ de chaîne)
Renvoie la valeur actuelle du champ de gestion des événements transmis.
| Nom | Type | Description |
|---|---|---|
| Champ | Chaîne | Nom de la valeur du champ Gestion des événements à renvoyer. |
| Type | Description |
|---|---|
| Chaîne | Valeur du champ Gestion des événements demandé. |
var event = new Event();
var eventSource = event.getField("source");
var eventSeverity = event.getField("severity");
Événement : setAdditionalInfo(Chaîne additionalInfo)
Remplace le champ existant additional_info dans l’événement associé par la chaîne JSON transmise.
| 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. |
| 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 l’élément key transmis correspond à un champ d’événement prédéfini, la méthode met à jour le champ d’événement correspondant. Sinon, 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 de l’élément de configuration [cmdb_ci] auquel lier l’événement. Valeur par défaut : nul |
| description | Description de forme libre de l’événement. Longueur maximale : 4 000 caractères Champ d’interface utilisateur associé : Description Valeur par défaut : nul |
| event_class | Enterprise Message Service (EMS) qui a généré l’événement. Par exemple, « Solarwinds » ou « SCOM ». Longueur maximale : 100 Champ d’interface utilisateur associé : Instance source Valeur par défaut : nul |
| message_key | Identificateur unique d’événement. Pour remplacer une gravité d’événement existante, utilisez la même message_key valeur. Longueur maximale : 1024 caractères Champ d’interface utilisateur associé : Clé du message Par défaut : combinaison de source, node, typeresource, , et metric name. |
| resolution_state | État de résolution de l’événement. Valeurs valides :
Champ d’interface utilisateur associé : État de résolution Par défaut : nouveau |
| Ressource | 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 :
Champ d’interface utilisateur associé : gravité Valeur par défaut : nul |
| source | Instance de l’EMS ayant déclenché l’événement. En règle générale, le nom de l’instance du connecteur. Longueur maximale : 200 caractères Champ d’interface utilisateur associé : source Valeur par défaut : nul |
| 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 Valeur 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 Valeur par défaut : nul |
Pour plus d’informations sur les événements, consultez Gestion des événements.
| 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énement prédéfinis, consultez Format du 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 rognée avant d’être stockée, les espaces multiples étant remplacés par un seul espace. |
| 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.
| Nom | Type | Description |
|---|---|---|
| Texte | Chaîne | Texte à stocker dans le champ de l’événement description associé. Longueur maximale : 4000 caractères |
| Type | Description |
|---|---|
| nul |
var event = new Event();
event.setText("SAP Solman");
Événement : setTimeOfEvent(Chaîne timeOfEvent)
Définit le time_of_event champ de l’événement associé sur la valeur d’heure UTC transmise.
| 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 |
| Type | Description |
|---|---|
| nul |
var event = new Event();
event.setTimeOfEvent("2019-18-05 13:12:05");