TMFTopicEventAPIUtilOOB : délimité
L’include de script TMFTopicEventAPIUtilOOB contient des fonctions permettant de gérer les demandes d’API ouvertes de gestion des notifications d’événements déclenchées par des définitions de déclencheurs externes pour créer, mettre à jour et supprimer des événements dans la table Événement [em_event].
Cet include de script contient l’implémentation par défaut de l’API Event Notification Management Open . Si vous souhaitez modifier la fonctionnalité par défaut de cette API, vous devez remplacer les fonctions contenues dans cet include de script dans l’include de script TMFTopicEventAPIUtil .
Cet include de script s’exécute dans l’espace de noms sn_ind_tmf642 et nécessite l’activation du module d’extension Telecommunications Alarm Management Open API (app-ind-tmfapi-alarm).
Pour plus d’informations sur le remplacement de ces fonctions, reportez-vous à la Gestion des notifications d’événements Guide du développeur d’API ouverte section .
Pour plus d’informations sur l’API Open Event Notification Management Open , reportez-vous à la section Gestion des notifications d’événements Ouvrir l’API.
TMFTopicEventAPIUtilOOB : getAlarmChangeEventSchema()
Retourne le schéma de charge utile utilisé lors du traitement d’un événement de changement d’alarme (ALARM_CHANGE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre du processus d’appel d’action de flux AlarmChangeEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil et le schéma dans l’include de script TMFAlarmAPIConstants .
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Chaîne | Schéma défini dans TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. |
// Schema validation
var schema = this.getAlarmChangeEventSchema();
var validationResults = this.schemaValidator.validateJSON(changeAlarmPayload, schema);
if (validationResults.length > 0) {
this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR;
this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CHANGE_ERROR_PAYLOAD;
var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject;TMFTopicEventAPIUtilOOB : getAlarmCreateEventSchema()
Retourne le schéma de charge utile utilisé lors du traitement d’un événement de création d’alarme (ALARM_CREATE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre du processus d’appel d’action de flux AlarmCreateEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil et le schéma dans l’include de script TMFAlarmAPIConstants .
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Chaîne | Schéma défini dans TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA |
// Schema validation
var schema = this.getAlarmCreateEventSchema();
var validationResults = this.schemaValidator.validateJSON(eventAlarmObject, schema);
if (validationResults.length > 0) {
this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR;
this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CREATE_ERROR_PAYLOAD;
var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject;
}TMFTopicEventAPIUtilOOB : getAlarmDeleteEventSchema()
Retourne le schéma de charge utile utilisé lors du traitement d’un événement de suppression d’alarme (ALARM_DELETE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre du processus d’appel d’action de flux AlarmDeleteEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil et le schéma dans l’include de script TMFAlarmAPIConstants .
| Nom | Type | Description |
|---|---|---|
| Néant |
| Type | Description |
|---|---|
| Chaîne | Schéma défini dans TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. |
// Schema validation
var schema = this.getAlarmDeleteEventSchema();
var validationResults = this.schemaValidator.validateJSON(deleteAlarmPayload, schema);
if (validationResults.length > 0) {
this.responseObject.status = TMFAlarmAPIConstants.EVENT_TRANSFORMATION_ERROR;
this.responseObject.responseError.errorMessage = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR;
this.responseObject.responseError.errorReason = TMFAlarmAPIConstants.MESSAGES.CLEAR_ERROR_PAYLOAD;
var messageDetails = [];
for (var i = 0; i < validationResults.length; i++)
messageDetails.push(this.createErrorObject(validationResults[i].message, validationResults[i].dataPath));
this.responseObject.responseError.details = messageDetails;
return this.responseObject;
}TMFTopicEventAPIUtilOOB : mapAlarmChangeObjectToEvent (alarmObject, GlideRecord newEventGr)
Mappe les paramètres de la charge utile de la demande de changement réussie aux champs de l’enregistrement spécifié dans la table Événement [em_event].
Vous pouvez personnaliser les mappages de champs pour ajouter des données à la table d’événements [em_event] ou modifier les mappages de champs par défaut. Pour modifier les mappages, créez des fonctions avec des noms et des paramètres identiques dans l’include de script TMFTopicEventAPIUtil pour remplacer les mappages dans l’include de script TMFTopicEventAPIUtilOOB . Si vous ajoutez des champs aux mappages, ces champs doivent également être ajoutés au schéma associé (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre de la fonction transformAndPersistChangeEvent().
| Nom | Type | Description |
|---|---|---|
| Objet d’alarme | Objet | La charge utile doit correspondre à ce qui est défini dans le schéma défini dans TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. |
| nouveauEventGr | GlideRecord | GlideRecord de l’enregistrement à mettre à jour dans la table Événement [em_event]. |
| Type | Description |
|---|---|
| Néant |
this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;TMFTopicEventAPIUtilOOB : mapCreateAlarmObjectToEvent(Objet, alarmObject, GlideRecord, eventGr)
Mappe les paramètres de la charge utile de demande de création réussie aux champs de l’enregistrement spécifié dans la table d’événements [em_event].
Vous pouvez personnaliser les mappages de champs pour ajouter des données à la table d’événements [em_event] ou modifier les mappages de champs par défaut. Pour modifier les mappages, créez des fonctions avec des noms et des paramètres identiques dans l’include de script TMFTopicEventAPIUtil pour remplacer les mappages dans l’include de script TMFTopicEventAPIUtilOOB . Si vous ajoutez des champs aux mappages, ces champs doivent également être ajoutés au schéma associé (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre de la fonction transformAndPersistAlarmCreateEvent().
| Nom | Type | Description |
|---|---|---|
| Objet d’alarme | Objet | La charge utile doit correspondre à ce qui est défini dans le schéma défini dans TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA. |
| eventGr | GlideRecord | GlideRecord de l’enregistrement dans la table Événement [em_event]. |
| Type | Description |
|---|---|
| Néant |
this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;TMFTopicEventAPIUtilOOB : mapDeleteAlarmObjectToEvent(Object additionalInfoObj, GlideRecord newEventGr)
Mappe les paramètres de la charge utile de la demande de suppression réussie aux champs de l’enregistrement spécifié dans la table Événement [em_event].
Vous pouvez personnaliser les mappages de champs pour ajouter des données à la table d’événements [em_event] ou modifier les mappages de champs par défaut. Pour modifier les mappages, créez des fonctions avec des noms et des paramètres identiques dans l’include de script TMFTopicEventAPIUtil pour remplacer les mappages dans l’include de script TMFTopicEventAPIUtilOOB . Si vous ajoutez des champs aux mappages, ces champs doivent également être ajoutés au schéma associé (TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA).
Cette fonction est appelée dans le cadre de la fonction transformAndPersistDeleteEvent().
| Nom | Type | Description |
|---|---|---|
| Objet d’alarme | Objet | La charge utile doit correspondre à ce qui est défini dans le schéma défini dans TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. |
| nouveauEventGr | GlideRecord | GlideRecord de l’enregistrement à utiliser pour mapper les champs de la charge utile à ceux de la table Événement [em_event]. |
| Type | Description |
|---|---|
| Néant |
this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;TMFTopicEventAPIUtilOOB : prepareEventAlarmRecordResponse(String msgKey Object alarmObject, Object responseObject)
Génère l’objet de réponse après la création ou la mise à jour d’un événement, y compris la suppression d’un événement.
Cette fonction est appelée par les fonctions processAlarmCreateEvent(),processChangeAlarm() et processDeleteAlarmEvent(). Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| msgKey | Chaîne | Clé du message. Cette clé est générée lorsqu’un événement est créé. Table : dans le champ Clé du message de la table Événements [em_event]. |
| Objet d’alarme | Objet | Charge utile de l’événement à traiter. Le format de cette charge utile doit être mis en corrélation avec le type d’événement en cours de traitement. Les schémas de ces charges utiles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject | Objet | Objet de réponse vide. Utilisez cet objet pour enregistrer tout problème lié à la vérification du schéma de charge utile. Type de données : objet |
| responseObject.responseError | Objet | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Tableau | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Chaîne | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Chaîne | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | Chaîne | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Objet | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
processDeleteAlarm: function(additionalInfoObj, gr, deleteAlarmPayload, responseObject) {
var msgKey = this.transformAndPersistDeleteEvent(additionalInfoObj, gr);
var responsePayload = this.prepareEventAlarmRecordResponse(msgKey, deleteAlarmPayload, responseObject);
this._logger.logDebug("processDeleteAlarmEvent");
return responsePayload;
},TMFTopicEventAPIUtilOOB : processAlarmChangeEvent (Objet changeAlarmPayload)
Démarre le processus de mise à jour d’un enregistrement dans la table d’événements [em_event] lorsque la eventType est définie sur AlarmChangeNotification.
Cette fonction est appelée par l’action de flux AlarmChangeEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| changeAlarmPayload | Objet | Charge utile du changement d’événement à traiter. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
Called by the AlarmChangeEvent flow actionTMFTopicEventAPIUtilOOB : processAlarmCreateEvent(Objet, eventAlarmObject)
Démarre le processus de création d’un enregistrement dans la table d’événements [em_event] lorsque la eventType est définie sur AlarmCreateNotification.
Cette fonction est appelée par l’action de flux AlarmCreateEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| eventAlarmObject | Objet | Charge utile de création d’événement à traiter. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA. |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
Called by AlarmCreateEvent flow action.TMFTopicEventAPIUtilOOB : processDeleteAlarmEvent (Objet deleteAlarmPayload)
Démarre le processus d’effacement de l’événement d’alarme dans la table Événement [em_event] lorsque la eventType est définie sur AlarmDeleteNotification.
Cette fonction efface le champ d’état et ferme l’alarme d’événement. Il met également à jour tous les paramètres de la charge utile transmise.
Cette fonction est appelée par l’action de flux AlarmDeleteEvent . Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| deleteAlarmPayload | Objet | Charge utile de suppression d’événement à traiter. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
Called by AlarmDeleteEvent flow action.TMFTopicEventAPIUtilOOB : transformAndPersistAlarmCreateEvent (Objet alarmObject)
Transforme la charge utile d’événement de création transmise à l’aide des valeurs de mappage d’événements de création associées et stocke les informations dans la table d’événements [em_event].
Cette fonction est appelée par la fonction processAlarmCreateEvent() dans le cadre de l’action de flux. Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| Objet d’alarme | Objet | Charge utile à utiliser pour créer un enregistrement dans la table d’événements [em_event]. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA. |
| Type | Description |
|---|---|
| Chaîne | ID unique (clé du message) de l’événement. |
Cette fonction est uniquement appelée par l’action de flux AlarmCreateEvent , donc aucun exemple de code n’est fourni.
TMFTopicEventAPIUtilOOB : transformAndPersistChangeEvent(Object additionalInfoObj, GlideRecord existingGr)
Transforme la charge utile de l’événement de changement transmis à l’aide des valeurs de mappage d’événements de changement associées et stocke les informations mises à jour dans le GlideRecord transmis dans la table d’événements [em_event].
Cette fonction est appelée par la fonction processAlarmChangeEvent() dans le cadre de l’action de flux. Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| additionalInfoObj | Objet | Charge utile à utiliser pour mettre à jour les champs de l’enregistrement spécifié dans le existingGr paramètre. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. |
| existantGr | GlideRecord | GlideRecord de l’enregistrement d’événement dans la table d’événements [em_event] à mettre à jour. |
| Type | Description |
|---|---|
| Chaîne | ID unique (clé du message) de l’événement. |
Cette fonction est uniquement appelée par l’action de flux AlarmChangeEvent , donc aucun exemple de code n’est fourni.
TMFTopicEventAPIUtilOOB : transformAndPersistDeleteEvent(Objet additionalInfoObj GlideRecord existingGr)
Transforme la charge utile de l’événement de suppression (effacement) transmise à l’aide des valeurs de mappage d’événements de suppression associées et stocke les informations mises à jour dans le GlideRecord transmis dans la table d’événements [em_event].
Cette fonction est appelée par la fonction >processAlarmDeleteEvent() dans le cadre de l’action de flux. Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| additionalInfoObj | Objet | Charge utile à utiliser pour mettre à jour les champs d’événement Effacer dans l’enregistrement spécifié dans le existingGr paramètre. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. |
| existantGr | GlideRecord | GlideRecord de l’enregistrement de l’événement dans la table Événement [em_event] pour lequel effacer l’alarme. |
| Type | Description |
|---|---|
| Chaîne | ID unique (clé du message) de l’événement. |
Cette fonction est uniquement appelée par l’action de flux AlarmDeleteEvent , donc aucun exemple de code n’est fourni.
TMFTopicEventAPIUtilOOB : validateSubscription(Objet, eventAlarmObject, Objet, responseObject)
Effectue la validation de l’abonnement.
Cette validation comprend la vérification de l’enregistrement de l’URL de rappel utilisée pour effectuer la notification d’événement et dans eventType la charge utile.
Cette fonction est appelée par les fonctions processAlarmCreateEvent(),processChangeAlarm() et processDeleteAlarmEvent(). Vous pouvez modifier la fonctionnalité de cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| eventAlarmObject | Objet | Charge utile de l’événement à valider. Le format de cette charge utile doit être mis en corrélation avec le type d’événement en cours de traitement. Les schémas de ces charges utiles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject | Objet | Objet de réponse vide. Utilisez cet objet pour enregistrer tout problème lié à la vérification du schéma de charge utile. Type de données : objet |
| responseObject.statut | Chaîne | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Objet | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| responseObject.responseError | Objet | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Tableau | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Chaîne | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Chaîne | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
Cette fonction n’est appelée que par l’action de flux AlarmCHANGEEvent , donc aucun exemple de code n’est fourni.
TMFTopicEventAPIUtilOOB : verifyAlarmChangeEventPayload(Objet changeAlarmPayload, Objet responseObject)
Permet de définir une vérification supplémentaire de la charge utile de l’événement de changement transmis.
Cette fonction est appelée par la fonction processAlarmChangeEvent() dans le cadre de l’action de flux. Aucune vérification supplémentaire de la charge utile n’est actuellement fournie pour la charge utile du changement. Vous pouvez ajouter une fonctionnalité pour cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| changeAlarmPayload | Objet | Charge utile à vérifier. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA. |
| responseObject | Objet | Objet de réponse vide. Utilisez cet objet pour enregistrer tout problème lié à la vérification du schéma de charge utile. Type de données : objet |
| responseObject.responseError | Objet | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Tableau | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Chaîne | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Chaîne | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | Chaîne | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Objet | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
// Apply customized validations if applicable, defaults to no error
var changePayloadResponse = this.verifyAlarmChangeEventPayload(changeAlarmPayload, this.responseObject);
if (!gs.nil(changePayloadResponse.responseError.errorMessage))
return changePayloadResponse;TMFTopicEventAPIUtilOOB : verifyAlarmCreateEventPayload(Objet alarmObject, objet responseObject)
Fournit la possibilité de définir une vérification supplémentaire de la charge utile de création d’événement transmise.
Cette fonction est appelée par la fonction processAlarmCreateEvent() dans le cadre de l’action de flux. Aucune vérification supplémentaire de la charge utile n’est actuellement fournie pour la charge utile de création. Vous pouvez ajouter une fonctionnalité pour cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| alarmPayload | Objet | Charge utile à vérifier. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA. |
| responseObject | Objet | Objet de réponse vide. Utilisez cet objet pour enregistrer tout problème lié à la vérification du schéma de charge utile. Type de données : objet |
| responseObject.statut | Chaîne | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Objet | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| responseObject.responseError | Objet | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Tableau | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Chaîne | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Chaîne | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
// Apply customized validations if applicable, defaults to no error
var creatPayloadResponse = this.verifyAlarmCreateEventPayload(eventAlarmObject, this.responseObject);
if (!gs.nil(creatPayloadResponse.responseError.errorMessage))
return creatPayloadResponse;TMFTopicEventAPIUtilOOB : verifyDeleteEventPayload(Objet, deleteAlarmPayload, Objet, responseObject)
Permet de définir une vérification supplémentaire de la charge utile de l’événement de suppression transmise.
Cette fonction est appelée par la fonction processDeleteAlarmEvent() dans le cadre de l’action de flux. Aucune vérification supplémentaire de la charge utile n’est actuellement fournie pour la charge utile supprimée. Vous pouvez ajouter une fonctionnalité pour cette fonction en remplaçant la fonctionnalité par défaut dans l’include de script TMFTopicEventAPIUtil .
| Nom | Type | Description |
|---|---|---|
| deleteAlarmPayload | Objet | Charge utile à vérifier. La charge utile doit correspondre au schéma défini dans TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA. |
| responseObject | Objet | Objet de réponse vide. Utilisez cet objet pour enregistrer tout problème lié à la vérification du schéma de charge utile. Type de données : objet |
| responseObject.statut | Chaîne | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Objet | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
| responseObject.responseError | Objet | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Tableau | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Chaîne | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Chaîne | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| Type | Description |
|---|---|
| responseObject | Détails sur l’état de l’appel de fonction. |
| responseObject.responseError | Détails sur toute erreur survenue pendant la validation. |
| responseObject.responseError.Détails | Toute information supplémentaire à renvoyer à la routine d’appel. Par exemple : |
| responseObject.responseError.Message d’erreur | Message d’erreur décrivant l’erreur qui s’est produite. Les messages d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.responseError.errorReason | Motif de l’échec du point de terminaison. Les motifs d’erreur disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.statut | État de l’appel de fonction. Les messages d’état disponibles sont définis dans l’include de script TMFAlarmAPIConstants . |
| responseObject.Réponse de réussite | Réponse réussie de l’appel de fonction. Par exemple, vous pouvez stocker l’objet de charge utile dans cette valeur. |
// Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
return deletePayloadResponse;