TMFTopicEventAPIUtilOOB – Scoped

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 18 Minuten Lesedauer

    • Die Skripteinbindung TMFTopicEventAPIUtilOOB enthält Funktionen zur Verarbeitung von offenen API-Anforderungen für Event Notification Management, die durch externe Auslöserdefinitionen ausgelöst werden, um Events in der Event-Tabelle [em_event] zu erstellen, zu aktualisieren und zu löschen.

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

    Diese Skripteinbindung wird im Namespace sn_ind_tmf642 ausgeführt.

    Weitere Informationen zum Überschreiben dieser Funktionen finden Sie unter Event Notification Management Open API-Entwicklerleitfaden.

    Weitere Informationen zur offenen Event Notification Management- API finden Sie unter Event Notification Management Open API.

    TMFTopicEventAPIUtilOOB – getAlarmChangeEventSchema()

    Gibt das Nutzlastschema zurück, das bei der Verarbeitung eines Alarm-Change-Ereignisses verwendet wird (ALARM_CHANGE_EVENT_SCHEMA).

    Diese Funktion wird als Teil des Aufrufprozesses der Flow-Aktion „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 verwendet wird (ALARM_CREATE_EVENT_SCHEMA).

    Diese Funktion wird als Teil des Aufrufprozesses der Flow-Aktion „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 verwendet wird (ALARM_DELETE_EVENT_SCHEMA).

    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 Change Request-Nutzlast Feldern im angegebenen Datensatz in der Event-Tabelle [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Event-Tabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Erstellen Sie zum Ändern von Zuordnungen 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 zugehörigen Schema (TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA) hinzugefügt werden.

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

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    alarmObject Objekt Die Nutzlast muss mit der Definition im in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    newEventGr GlideRecord GlideRecord des zu aktualisierenden Datensatzes in der Event-Tabelle [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 Payload „Anforderung erstellen“ Feldern im angegebenen Datensatz in der Event-Tabelle [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Event-Tabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Erstellen Sie zum Ändern von Zuordnungen 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 zugehörigen Schema (TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA) hinzugefügt werden.

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

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    alarmObject Objekt Die Nutzlast muss mit der Definition im in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    eventGr GlideRecord GlideRecord des Datensatzes in der Event-Tabelle [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 additionalInfoObj, GlideRecord newEventGr)

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

    Sie können Feldzuordnungen anpassen, um der Event-Tabelle [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Erstellen Sie zum Ändern von Zuordnungen 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
    alarmObject Objekt Die Nutzlast muss mit der Definition im in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    newEventGr GlideRecord GlideRecord des Datensatzes, der verwendet werden soll, um die Felder in der Nutzlast denen in der Event-Tabelle [em_event] zuzuordnen.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Keine 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOOB – vorbereitetEventAlarmRecordResponse(String msgKey Object alarmObject, Object responseObject)

    Generiert das Antwortobjekt nach der Event-Erstellung oder -Aktualisierung, einschließlich des Löschens eines Events.

    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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    msgKey Zeichenfolge Nachrichtenschlüssel Dieser Schlüssel wird generiert, wenn ein Event erstellt wird. Befindet sich im Feld Nachrichtenschlüssel in der Tabelle „Events“ [em_event].
    alarmObject Objekt Zu verarbeitende Event-Nutzlast. Das Format dieser Nutzlast sollte mit dem Event-Typ korrelieren, der verarbeitet wird. Die Schemata für diese Nutzlasten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Überprüfung 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 Alle zusätzlichen 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.
    responseObject.​status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern.
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    responseObject Details zum Status des Funktionsaufrufs.
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Alle zusätzlichen 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 Event-Tabelle [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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    changeAlarm​Nutzlast Objekt Event-Nutzlast in Prozess ä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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOOB – processAlarmCreateEvent(Object eventAlarmObject)

    Startet den Prozess der Erstellung eines Datensatzes in der Event-Tabelle [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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    eventAlarm​Objekt Objekt Zu verarbeitendes Ereignis erstellt 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOOB – processDeleteAlarmEvent(Object deleteAlarmPayload)

    Startet den Prozess zum Löschen des Alarm-Events in der Event-Tabelle [em_event], wenn eventType auf AlarmDeleteNotification festgelegtist.

    Diese Funktion löscht das Statusfeld und schließt den Event-Alarm. 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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    deleteAlarm​Nutzlast Objekt Zu verarbeitende Ereignislöschnutzlast. 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB – transformAndPersistChangeEvent(Object additionalInfoObj, GlideRecord bestehendeGr)

    Transformiert die übergebene Change-Event-Nutzlast mit den zugeordneten Change-Event-Zuordnungswerten und speichert die aktualisierten Informationen im übergebenen GlideRecord in der Event-Tabelle [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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    zusätzliche InfoObj Objekt Nutzlast, die zum Aktualisieren der Felder in dem im Parameter existingGr angegebenen Datensatz verwendet werden soll. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    vorhandeneGr GlideRecord GlideRecord des zu aktualisierenden Event-Datensatzes in der Event-Tabelle [em_event].
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisse.

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

    TMFTopicEventAPIUtilOOB – transformAndPersistAlarmCreateEvent(Object alarmObject)

    Transformiert die übergebene Nutzlast „Ereignis erstellen“ mit den zugehörigen Zuordnungswerten für „Ereignis erstellen“ 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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    alarmObject Objekt Nutzlast, die zum Erstellen eines Datensatzes in der Event-Tabelle [em_event] verwendet werden soll. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisse.

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

    TMFTopicEventAPIUtilOOB – transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord bestehendenGr)

    Transformiert die übergebene Nutzlast des Löschereignisses (clear) mithilfe der zugeordneten Löschereigniszuordnungswerte und speichert die aktualisierten Informationen im übergebenen GlideRecord in der Event-Tabelle [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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    zusätzliche InfoObj Objekt Nutzlast, die zum Aktualisieren der leeren Event-Felder in dem im Parameter existingGr angegebenen Datensatz verwendet werden soll. Die Nutzlast muss mit dem in TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMAdefinierten Schema übereinstimmen.
    vorhandeneGr GlideRecord GlideRecord des Event-Datensatzes in der Event-Tabelle [em_event], für den der Alarm gelöscht werden soll.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisse.

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

    TMFTopicEventAPIUtilOOB – valideSubscription(Object eventAlarmObject, Object responseObject)

    Führt eine Validierung des Abonnements durch.

    Diese Validierung umfasst die Überprüfung, ob die Rückruf-URL, die für die Event-Benachrichtigung 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 TMFTopicEventAPIUtil-Skripteinbindung überschreiben.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    eventAlarm​Objekt Objekt Zu validierende Event-Nutzlast. Das Format dieser Nutzlast sollte mit dem Event-Typ korrelieren, der verarbeitet wird. Die Schemata für diese Nutzlasten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject Objekt Leeres Antwortobjekt. Verwenden Sie dieses Objekt, um Probleme bei der Überprüfung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Alle zusätzlichen 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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, Object responseObject )

    Bietet die Möglichkeit, eine zusätzliche Überprüfung der übergebenen Change-Event-Nutzlast zu definieren.

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

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    changeAlarm​Nutzlast Objekt Zu überprüfende 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 Überprüfung 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 Alle zusätzlichen 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.
    responseObject.​status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Überprüfung der übergebenen Nutzlast des Erstellungsereignisses zu definieren.

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

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    alarmPayload Objekt Zu überprüfende 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 Überprüfung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Alle zusätzlichen 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 – identifyDeleteEventPayload(Object deleteAlarmPayload, Object responseObject)

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

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

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    deleteAlarm​Nutzlast Objekt Zu überprüfende 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 Überprüfung des Nutzlastschemas aufzuzeichnen.
    Datentyp: Objekt
    "responseObject": {
  "responseError": {Object},
  "status": "String",
  "successResponse": {Object}
}
    responseObject.​status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Objekt Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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 Alle zusätzlichen 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 Alle zusätzlichen 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.
    responseObject.​status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in der Skripteinbindung TMFAlarmAPIConstants definiert.
    responseObject.​SuccessResponse Erfolgreiche Antwort vom Funktionsaufruf. Sie können beispielsweise 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;