TMFTopicEventAPIUtilOOB: Bereichsbezogen

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 18 Minuten Lesedauer

    • Die TMFTopicEventAPIUtilOOB-Skripteinbindung enthält Funktionen zum Verarbeiten von Anforderungen der Event Notification Management Open API, die durch externe Auslöserdefinitionen ausgelöst werden, um Ereignisse in der Tabelle „Ereignis“ [em_event] zu erstellen, zu aktualisieren und zu löschen.

    Diese Skripteinbindung enthält die Standardimplementierung für die offene API zum Management von Ereignisbenachrichtigungen. Wenn Sie die Standardfunktionalität dieser API ändern möchten, müssen Sie die in dieser Skripteinbindung enthaltenen Funktionen in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Diese Skripteinbindung wird im Namespace sn_ind_tmf642 ausgeführt und erfordert die Aktivierung des Plugins Telecommunications Alarm Management Open API (app-ind-tmfapi-alarm).

    Weitere Informationen zum Überschreiben dieser Funktionen finden Sie unter Entwicklerhandbuch für die Open API für Event Notification Management.

    Weitere Informationen zur Open API für Event Notification Management finden Sie unter Offene API zur Verwaltung von Ereignisbenachrichtigungen.

    TMFTopicEventAPIUtilOOB – getAlarmChangeEventSchema()

    Gibt das Nutzlastschema zurück, das bei der Verarbeitung eines Alarmänderungsereignisses (ALARM_CHANGE_EVENT_SCHEMA) verwendet wird.

    Diese Funktion wird als Teil des Flow-Aktionsaufrufprozesses AlarmChangeEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil und das Schema in der Skripteinbindung TMFAlarmAPIConstants überschreiben.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Zeichenfolge In TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefiniertes 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()

    Gibt das Nutzlastschema zurück, das bei der Verarbeitung eines Alarmerstellungsereignisses (ALARM_CREATE_EVENT_SCHEMA) verwendet wird.

    Diese Funktion wird als Teil des Flow-Aktionsaufrufprozesses AlarmCreateEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil und das Schema in der Skripteinbindung TMFAlarmAPIConstants überschreiben.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Zeichenfolge In TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefiniertes 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()

    Gibt das Nutzlastschema zurück, das bei der Verarbeitung eines Alarmlöschereignisses (ALARM_DELETE_EVENT_SCHEMA) verwendet wird.

    Diese Funktion wird als Teil des Aufrufprozesses der Flow-Aktion AlarmDeleteEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil und das Schema in der Skripteinbindung TMFAlarmAPIConstants überschreiben.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Zeichenfolge In TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefiniertes 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)

    Ordnet die Parameter in der übergebenen Nutzlast der Change-Anforderung Feldern im angegebenen Datensatz in der Ereignistabelle [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Ereignistabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Zum Ändern von Zuordnungen erstellen Sie Funktionen mit identischen Namen und Parametern in der Skripteinbindung TMFTopicEventAPIUtil, um die Zuordnungen in der Skripteinbindung TMFTopicEventAPIUtilOOB zu überschreiben. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA) hinzugefügt werden.

    Diese Funktion wird als Teil der Funktion transformAndPersistChangeEvent() aufgerufen.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Alarmobjekt Objekt Die Nutzlast muss dem entsprechen, was im in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema definiert ist.
    neuesEreignisGr GlideRecord GlideRecord des zu aktualisierenden Datensatzes in der Ereignistabelle [em_event].
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Keine 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - mapCreateAlarmObjectToEvent(Object AlarmObject, GlideRecord eventGr)

    Ordnet die Parameter in der übergebenen Nutzlast zum Erstellen der Anforderung Feldern im angegebenen Datensatz in der Ereignistabelle [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Ereignistabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Zum Ändern von Zuordnungen erstellen Sie Funktionen mit identischen Namen und Parametern in der Skripteinbindung TMFTopicEventAPIUtil, um die Zuordnungen in der Skripteinbindung TMFTopicEventAPIUtilOOB zu überschreiben. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA) hinzugefügt werden.

    Diese Funktion wird als Teil der Funktion transformAndPersistAlarmCreateEvent() aufgerufen.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Alarmobjekt Objekt Die Nutzlast muss mit dem übereinstimmen, was im in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema definiert ist.
    eventGr GlideRecord GlideRecord des Datensatzes in der Tabelle „Ereignis“ [em_event].
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Keine 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOOB - mapDeleteAlarmObjectToEvent(Object zusätzlicheInfoObj, GlideRecord newEventGr)

    Ordnet die Parameter in der übergebenen Nutzlast der Löschanforderung Feldern im angegebenen Datensatz in der Ereignistabelle [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Ereignistabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Zum Ändern von Zuordnungen erstellen Sie Funktionen mit identischen Namen und Parametern in der Skripteinbindung TMFTopicEventAPIUtil, um die Zuordnungen in der Skripteinbindung TMFTopicEventAPIUtilOOB zu überschreiben. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema (TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA) hinzugefügt werden.

    Diese Funktion wird als Teil der Funktion transformAndPersistDeleteEvent() aufgerufen.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Alarmobjekt Objekt Die Nutzlast muss mit dem übereinstimmen, was im in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema definiert ist.
    neuesEreignisGr GlideRecord GlideRecord des Datensatzes, der zum Zuordnen der Felder in der Nutzlast zu denen in der Tabelle „Ereignis“ [em_event] verwendet werden soll.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Keine 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB - vorbereitetEventAlarmRecordResponse(Zeichenfolge-msgKey-Objekt Alarmobjekt, Objekt Antwortobjekt)

    Generiert das Antwortobjekt nach der Ereigniserstellung oder -aktualisierung, einschließlich des Löschens eines Ereignisses.

    Diese Funktion wird von den Funktionen processAlarmCreateEvent(), processChangeAlarm( )und processDeleteAlarmEvent () aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    msgKey Zeichenfolge Nachrichtenschlüssel Dieser Schlüssel wird generiert, wenn ein Ereignis erstellt wird. Zu finden im Feld Nachrichtenschlüssel in der Tabelle „Ereignisse“ [em_event].
    Alarmobjekt Objekt Zu verarbeitende Ereignisnutzlast. Das Format dieser Nutzlast muss dem verarbeiteten Ereignistyp entsprechen. Die Schemas für diese Nutzlasten sind in der Skripteinbindung TMFAlarmAPIConstantsdefiniert.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Verifizierung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Objekt Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Array Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert. 
    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(Object changeAlarmPayload)

    Startet den Prozess der Aktualisierung eines Datensatzes in der Ereignistabelle [em_event], wenn eventType auf AlarmChangeNotification festgelegtist.

    Diese Funktion wird von der Flow-Aktion AlarmChangeEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    changeAlarm​-Payload Objekt Zu verarbeitende Ereignis-Payload ändern. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB - processAlarmCreateEvent(Object eventAlarmObject)

    Startet den Prozess zum Erstellen eines Datensatzes in der Ereignistabelle [em_event], wenn eventType auf AlarmCreateNotification festgelegtist.

    Diese Funktion wird von der Flow-Aktion AlarmCreateEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    eventAlarm​Objekt Objekt Zu verarbeitendes Ereignis erstellen Nutzlast. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB - processDeleteAlarmEvent(Object deleteAlarmPayload)

    Startet den Prozess zum Löschen des Alarmereignisses in der Ereignistabelle [em_event], wenn eventType auf AlarmDeleteNotification festgelegtist.

    Diese Funktion löscht das Statusfeld und schließt den Ereignisalarm. Außerdem werden alle Parameter in der übergebenen Nutzlast aktualisiert.

    Diese Funktion wird von der Flow-Aktion AlarmDeleteEvent aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    deleteAlarm​Payload Objekt Zu verarbeitende Ereignislöschungs-Nutzlast. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB - transformAndPersistAlarmCreateEvent(Object AlarmObject)

    Transformiert die in der Nutzlast der Ereigniserstellung übergebene mithilfe der zugehörigen Zuordnungswerte für die Ereigniserstellung und speichert die Informationen in der Ereignistabelle [em_event].

    Diese Funktion wird von der Funktion processAlarmCreateEvent() als Teil der Flow-Aktion aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Alarmobjekt Objekt Nutzlast, die zum Erstellen eines Datensatzes in der Ereignistabelle [em_event] verwendet wird. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von der Flow-Aktion „ AlarmCreateEvent “ aufgerufen, daher wird kein Codebeispiel bereitgestellt.

    TMFTopicEventAPIUtilOOB - transformAndPersistChangeEvent(Object ZusätzlicheInfoObj, GlideRecord bestehendeGr)

    Transformiert die im Change-Ereignis übergebene Nutzlast anhand der zugeordneten Zuordnungswerte für das Change-Ereignis und speichert die aktualisierten Informationen im übergebenen GlideRecord in der Tabelle „Ereignis“ [em_event].

    Diese Funktion wird von der Funktion processAlarmChangeEvent() als Teil der Flow-Aktion aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    zusätzliches InfoObj Objekt Nutzlast zum Aktualisieren der Felder in dem im Parameter existingGr angegebenen Datensatz. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    bestehendeGr GlideRecord GlideRecord des zu aktualisierenden Ereignisdatensatzes in der Ereignistabelle [em_event].
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von der Flow-Aktion „ AlarmChangeEvent “ aufgerufen, daher wird kein Codebeispiel bereitgestellt.

    TMFTopicEventAPIUtilOOB - transformAndPersistDeleteEvent(Object ZusätzlicheInfoObj GlideRecord bestehendeGr)

    Transformiert die in der Nutzlast des Löschereignisses (löschen) übergebene Ereignisnutzlast unter Verwendung der zugehörigen Zuordnungswerte für das Löschereignis und speichert die aktualisierten Informationen im übergebenen GlideRecord in der Ereignistabelle [em_event].

    Diese Funktion wird von der Funktion >processAlarmDeleteEvent() als Teil der Flow-Aktion aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    zusätzliches InfoObj Objekt Nutzlast zum Aktualisieren der Felder zum Löschen des Ereignisses in dem im Parameter existingGr angegebenen Datensatz. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    bestehendeGr GlideRecord GlideRecord des Ereignisdatensatzes in der Ereignistabelle [em_event], für den der Alarm gelöscht werden soll.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von der Flow-Aktion „ AlarmDeleteEvent “ aufgerufen, daher wird kein Codebeispiel bereitgestellt.

    TMFTopicEventAPIUtilOOB – validSubscription(Object eventAlarmObject, Object responseObject)

    Führt eine Validierung des Abonnements durch.

    Diese Validierung umfasst die Überprüfung, ob die Rückruf-URL, die zum Erstellen der Ereignisbenachrichtigung verwendet wird, und eventType in der Nutzlast registriert sind.

    Diese Funktion wird von den Funktionen processAlarmCreateEvent(), processChangeAlarm( )und processDeleteAlarmEvent () aufgerufen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    eventAlarm​Objekt Objekt Zu validierende Ereignisnutzlast. Das Format dieser Nutzlast muss dem verarbeiteten Ereignistyp entsprechen. Die Schemas für diese Nutzlasten sind in der Skripteinbindung TMFAlarmAPIConstantsdefiniert.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Verifizierung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    Antwortobjekt.​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    responseObject.​ResponseError Objekt Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Array Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.

    Diese Funktion wird nur von der Flow-Aktion AlarmCHANGEEvent aufgerufen, daher wird kein Codebeispiel bereitgestellt.

    TMFTopicEventAPIUtilOOB - verifyAlarmChangeEventPayload(Object changeAlarmPayload, Objekt responseObject )

    Bietet die Möglichkeit, eine zusätzliche Verifizierung der Nutzlast des übergebenen Change-Ereignisses zu definieren.

    Diese Funktion wird von der Funktion processAlarmChangeEvent() als Teil der Flow-Aktion aufgerufen. Derzeit wird keine zusätzliche Nutzlastverifizierung für die Change-Nutzlast bereitgestellt. Sie können Funktionalität für diese Funktion hinzufügen, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    changeAlarm​-Payload Objekt Zu verifizierende Nutzlast. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Verifizierung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Objekt Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Array Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
     // 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(Object AlarmObject, Object ResponseObject)

    Bietet die Möglichkeit, eine zusätzliche Verifizierung der im Ereignis-Erstellungs-Payload übergebenen Elemente zu definieren.

    Diese Funktion wird von der Funktion processAlarmCreateEvent() als Teil der Flow-Aktion aufgerufen. Derzeit wird keine zusätzliche Verifizierung der Nutzlast für die Erstellungsnutzlast bereitgestellt. Sie können Funktionalität für diese Funktion hinzufügen, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    AlarmPayload Objekt Zu verifizierende Nutzlast. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Verifizierung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    Antwortobjekt.​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    responseObject.​ResponseError Objekt Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Array Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Tabelle : 32. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
    // 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(Object deleteAlarmPayload, Objekt responseObject)

    Bietet die Möglichkeit, eine zusätzliche Verifizierung der Nutzlast des übergebenen Löschereignisses zu definieren.

    Diese Funktion wird von der Funktion processDeleteAlarmEvent() als Teil der Flow-Aktion aufgerufen. Derzeit wird keine zusätzliche Verifizierung der Nutzlast für die Lösch-Nutzlast bereitgestellt. Sie können Funktionalität für diese Funktion hinzufügen, indem Sie die Standardfunktionalität in der Skripteinbindung TMFTopicEventAPIUtil überschreiben.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    deleteAlarm​Payload Objekt Zu verifizierende Nutzlast. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Verifizierung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    Antwortobjekt.​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern.
    responseObject.​ResponseError Objekt Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Array Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Tabelle : 34. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​ResponseError Details zu Fehlern, die während der Validierung aufgetreten sind.
    "responseError": {
  "details": [Array],
  "errorMessage": "String",
  "errorReason": "String"
}
    responseObject.​responseError.​Details Zusätzliche Informationen, die an die aufrufende Routine zurückgegeben werden sollen.
    Beispiel:
    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
    responseObject.​responseError.​errorMessage Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​responseError.​errorReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlerursachen sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    Antwortobjekt.​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​uccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Beispielsweise können Sie das Nutzlastobjekt in diesem Wert speichern. 
    // Apply customized validations if applicable, defaults to no error
var deletePayloadResponse = this.verifyDeleteEventPayload(deleteAlarmPayload, this.responseObject);
if (!gs.nil(deletePayloadResponse.responseError.errorMessage))
  return deletePayloadResponse;