TMFThemenEventAPIUtilOB – Umfang

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 18 Minuten Lesedauer

    • Die TMFThemenEventAPIUtilOB Skripteinbindung enthält zu behandelnde Funktionen Ereignisbenachrichtigungsmanagement Offen API-Anforderungen, die durch externe Auslöserdefinitionen zum Erstellen, Aktualisieren und Löschen von Ereignissen in der Ereignistabelle [em_event] ausgelöst werden.

    Diese Skripteinbindung enthält die Standardimplementierung für Ereignisbenachrichtigungsmanagement Offen API. Wenn Sie die Standardfunktionalität dieser API ändern möchten, müssen Sie die Funktionen in dieser Skripteinbindung in überschreiben TMFThemenEventAPIUtil Skripteinbindung.

    Diese Skripteinbindung wird in ausgeführt sn_ind_tmf642 Namespace und erfordert die Aktivierung des Plugins „Offen API für Telekommunikationsalarmmanagement“ (App-ind-tmfapi-Alarm).

    Weitere Informationen zum Überschreiben dieser Funktionen finden Sie unter Ereignisbenachrichtigungsmanagement – API-Entwicklerleitfaden öffnen.

    Für zusätzliche Informationen zu Ereignisbenachrichtigungsmanagement Offen API, siehe Ereignisbenachrichtigungsmanagement – offene API.

    TMFTopicEventAPIUtilOOB – getAlarmChangeEventSchema()

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

    Diese Funktion wird als Teil von aufgerufen AlarmChangeEvent Flow-Aktion – Aufrufprozess. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung und das Schema in TMFAlarmAPIKonstanten Skripteinbindung.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Zeichenfolge Schema definiert in 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()

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

    Diese Funktion wird als Teil von aufgerufen AlarmCreateEvent Flow-Aktion – Aufrufprozess. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung und das Schema in TMFAlarmAPIKonstanten Skripteinbindung.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Zeichenfolge Schema definiert in 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()

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

    Diese Funktion wird als Teil von aufgerufen Alarmlöschereignis Flow-Aktion – Aufrufprozess. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung und das Schema in TMFAlarmAPIKonstanten Skripteinbindung.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Zeichenfolge Schema definiert in 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;
}

    TMFTopicEventAPIUtilOB – mapAlarmChangeObjectToEvent(alarmObject, GlideRecord newEventGr)

    Ordnet die Parameter in der übergebenen Change-Anforderungsnutzlast Feldern im angegebenen Datensatz in der Tabelle „Ereignis“ [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Tabelle „Ereignis“ [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Um Zuordnungen zu ändern, erstellen Sie Funktionen mit identischen Namen und Parametern in TMFThemenEventAPIUtil Skripteinbindung zum Überschreiben der Zuordnungen in TMFThemenEventAPIUtilOB Skripteinbindung. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema ( TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA ).

    Diese Funktion wird als Teil von aufgerufen TransformAndPersistChangeEvent() Funktion.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    AlarmObject Objekt Nutzlast muss mit dem übereinstimmen, was im in definierten Schema definiert ist TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA .
    NewEventGr GlideRecord GlideRecord des Datensatzes, der in der Ereignistabelle [em_event] aktualisiert werden soll.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Keine 
    this.mapAlarmChangeObjectToEvent(additionalInfoObj, newEventGr);

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

    TMFTopicEventAPIUtilOB – mapCreateAlarmObjectToEvent(Object alarmObject, GlideRecord eventGr)

    Ordnet die Parameter in der übergebenen Nutzlast der Erstellungsanforderung Feldern im angegebenen Datensatz in der Tabelle „Ereignis“ [em_event] zu.

    Sie können Feldzuordnungen anpassen, um der Tabelle „Ereignis“ [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Um Zuordnungen zu ändern, erstellen Sie Funktionen mit identischen Namen und Parametern in TMFThemenEventAPIUtil Skripteinbindung zum Überschreiben der Zuordnungen in TMFThemenEventAPIUtilOB Skripteinbindung. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema ( TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA ).

    Diese Funktion wird als Teil von aufgerufen TransformAndPersistAlarmCreateEvent() Funktion.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    AlarmObject Objekt Nutzlast muss mit dem übereinstimmen, was im in definierten Schema definiert ist TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA .
    eventGr GlideRecord GlideRecord des Datensatzes in der Ereignistabelle [em_event].
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Keine 
    this.mapCreateAlarmObjectToEvent(eventAlarmObject, eventGr);
var id = eventGr.insert();
return gs.nil(id) ? id : msgKey;

    TMFTopicEventAPIUtilOB – mapDeleteAlarmObjectToEvent(Object additionalInfoObj, GlideRecord newEventGr)

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

    Sie können Feldzuordnungen anpassen, um der Tabelle „Ereignis“ [em_event] Daten hinzuzufügen, oder die Standardfeldzuordnungen ändern. Um Zuordnungen zu ändern, erstellen Sie Funktionen mit identischen Namen und Parametern in TMFThemenEventAPIUtil Skripteinbindung zum Überschreiben der Zuordnungen in TMFThemenEventAPIUtilOB Skripteinbindung. Wenn Sie den Zuordnungen Felder hinzufügen, müssen diese Felder auch dem zugeordneten Schema ( TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA ).

    Diese Funktion wird als Teil von aufgerufen TransformAndPersistDeleteEvent() Funktion.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    AlarmObject Objekt Nutzlast muss mit dem übereinstimmen, was im in definierten Schema definiert ist TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA .
    NewEventGr GlideRecord GlideRecord des Datensatzes, der zum Zuordnen der Felder in der Nutzlast zu denen in der Ereignistabelle [em_event] verwendet werden soll.
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Keine 
    this.mapDeleteAlarmObjectToEvent(additionalInfoObj, newEventGr);
var id = newEventGr.insert();
return gs.nil(id) ? id : newEventGr.message_key;

    TMFTopicEventAPIUtilOB – prepareEventAlarmRecordResponse(Zeichenfolge msgKey Object alarmObject, Object responseObject)

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

    Diese Funktion wird von aufgerufen ProcessAlarmCreateEvent() , ProcessChangeAlarm() , Und ProcessDeleteAlarmEvent() Funktionen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    MsgKey Zeichenfolge Nachrichtenschlüssel. Dieser Schlüssel wird generiert, wenn ein Ereignis erstellt wird.

    Tabelle: Im Feld Nachrichtenschlüssel in der Tabelle Ereignisse [em_event].
    AlarmObject Objekt Zu verarbeitende Ereignisnutzlast. Das Format dieser Nutzlast muss dem Ereignistyp entsprechen, der verarbeitet wird. Die Schemas für diese Nutzlasten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    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 Alle zusätzlichen Informationen, die an die Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Objekt Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern.
    Tabelle : 14. Rückgaben
    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 definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. 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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung. 
    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 eventTypeIst auf festgelegt AlarmChangeNotification .

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

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    ChangeAlarm-​Nutzlast Objekt Ereignis-Change-Nutzlast zu verarbeiten. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA .
    Tabelle : 16. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by the AlarmChangeEvent flow action

    TMFTopicEventAPIUtilOB – processAlarmCreateEvent(Object eventAlarmObject)

    Startet den Prozess der Erstellung eines Datensatzes in der Tabelle „Ereignis“ [em_event], wenn eventTypeIst auf festgelegt Alarmerstellungsbenachrichtigung .

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

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    EventAlarm-​Objekt Objekt Zu verarbeitende Nutzlast für Ereignis erstellen. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA .
    Tabelle : 18. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmCreateEvent flow action.

    TMFTopicEventAPIUtilOB – processDeleteAlarmEvent(Object deleteAlarmPayload)

    Startet den Prozess zum Löschen des Alarmereignisses in der Ereignistabelle [em_event], wenn eventTypeIst auf festgelegt Alarmlöschbenachrichtigung .

    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 aufgerufen Alarmlöschereignis Flow-Aktion. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    DeleteAlarm-​Nutzlast Objekt Zu verarbeitende Nutzlast des Ereignisses löschen. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA .
    Tabelle : 20. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern. 
    Called by AlarmDeleteEvent flow action.

    TMFTopicEventAPIUtilOOB – transformAndPersistAlarmCreateEvent(Object alarmObject)

    Transformiert die in der Ereigniserstellungsnutzlast übergebene Ereigniszuordnungswerte mithilfe der zugehörigen Erstellungsereignis-Zuordnungswerte und speichert die Informationen in der Ereignistabelle [em_event].

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

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    AlarmObject Objekt Nutzlast, die zum Erstellen eines Datensatzes in der Ereignistabelle [em_event] verwendet werden soll. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA .
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von aufgerufen AlarmCreateEvent Flow-Aktion, daher wird kein Codebeispiel angegeben.

    TMFTopicEventAPIUtilOOB – transformAndPersistChangeEvent(Object additionalInfoObj, GlideRecord existingGr)

    Transformiert die übergebene Change-Ereignis-Nutzlast mithilfe der zugehörigen Change-Ereignis-Zuordnungswerte und speichert die aktualisierten Informationen im übergebenen GlideRecord innerhalb der Ereignistabelle [em_event].

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

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    Zusätzliches​InfoObj Objekt Nutzlast, die zum Aktualisieren der Felder im Datensatz verwendet werden soll, der in angegeben ist existingGrParameter. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA .
    VorhandenGr GlideRecord GlideRecord des Ereignisdatensatzes in der zu aktualisierenden Ereignistabelle [em_event].
    Tabelle : 24. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von aufgerufen AlarmChangeEvent Flow-Aktion, daher wird kein Codebeispiel angegeben.

    TMFTopicEventAPIUtilOB – transformAndPersistDeleteEvent(Object additionalInfoObj GlideRecord existingGr)

    Transformiert die übergebene Ereignisnutzlast zum Löschen (Löschen) mithilfe der zugehörigen Zuordnungswerte für Löschereignis und speichert die aktualisierten Informationen im übergebenen GlideRecord innerhalb der Tabelle „Ereignis“ [em_event].

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

    Tabelle : 25. Parameter
    Name Typ Beschreibung
    Zusätzliches​InfoObj Objekt Nutzlast, die zum Aktualisieren der leeren Ereignisfelder im Datensatz verwendet werden soll, der in angegeben ist existingGrParameter. Die Nutzlast muss dem in definierten Schema entsprechen TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA .
    VorhandenGr GlideRecord GlideRecord des Ereignisdatensatzes in der Ereignistabelle [em_event], für den der Alarm gelöscht werden soll.
    Tabelle : 26. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eindeutige ID (Nachrichtenschlüssel) des Ereignisses.

    Diese Funktion wird nur von aufgerufen Alarmlöschereignis Flow-Aktion, daher wird kein Codebeispiel angegeben.

    TMFTopicEventAPIUtilOB – validateSubscription(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 Ereignisbenachrichtigung verwendet wurde, und die eventTypeIn der Nutzlast sind registriert.

    Diese Funktion wird von aufgerufen ProcessAlarmCreateEvent() , ProcessChangeAlarm() , Und ProcessDeleteAlarmEvent() Funktionen. Sie können die Funktionalität dieser Funktion ändern, indem Sie die Standardfunktionalität in überschreiben TMFThemenEventAPIUtil Skripteinbindung.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    EventAlarm-​Objekt Objekt Zu validierende Ereignisnutzlast. Das Format dieser Nutzlast muss dem Ereignistyp entsprechen, der verarbeitet wird. Die Schemas für diese Nutzlasten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    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. ​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Objekt Erfolgreiche Antwort des Funktionsaufrufs. 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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    Tabelle : 28. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern.

    Diese Funktion wird nur von aufgerufen AlarmCHANGEEreignis Flow-Aktion, daher wird kein Codebeispiel angegeben.

    TMFTopicEventAPIUtilOB – verifyAlarmChangeEventPayload(Object changeAlarmPayload, Object responseObject)

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

    Diese Funktion wird von aufgerufen ProcessAlarmChangeEvent() Funktion als Teil der Flow-Aktion. Derzeit ist 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 überschreiben TMFThemenEventAPIUtil Skripteinbindung.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    ChangeAlarm-​Nutzlast Objekt Zu verifizierende Nutzlast. Nutzlast muss mit dem in definierten Schema übereinstimmen TMFAlarmAPIConstants.ALARM_CHANGE_EVENT_SCHEMA .
    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 Alle zusätzlichen Informationen, die an die Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Objekt Erfolgreiche Antwort des Funktionsaufrufs. Sie können beispielsweise das Nutzlastobjekt in diesem Wert speichern.
    Tabelle : 30. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. 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;

    TMFTopicEventAPIUtilOB – verifyAlarmCreateEventPayload(Object alarmObject, Object responseObject)

    Bietet die Möglichkeit, eine zusätzliche Verifizierung der bei der Ereigniserstellung übergebenen Nutzlast zu definieren.

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

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    AlarmNutzlast Objekt Zu verifizierende Nutzlast. Nutzlast muss mit dem in definierten Schema übereinstimmen TMFAlarmAPIConstants.ALARM_CREATE_EVENT_SCHEMA .
    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. ​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Objekt Erfolgreiche Antwort des Funktionsaufrufs. 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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    Tabelle : 32. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. 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;

    TMFTopicEventAPIUtilOB – verifyDeleteEventPayload(Object deleteAlarmPayload, Object responseObject)

    Bietet die Möglichkeit, eine zusätzliche Verifizierung der in „Löschen“ übergebenen Ereignisnutzlast zu definieren.

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

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    DeleteAlarm-​Nutzlast Objekt Zu verifizierende Nutzlast. Nutzlast muss mit dem in definierten Schema übereinstimmen TMFAlarmAPIConstants.ALARM_DELETE_EVENT_SCHEMA .
    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. ​Status Zeichenfolge Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Objekt Erfolgreiche Antwort des Funktionsaufrufs. 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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Zeichenfolge Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Zeichenfolge Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    Tabelle : 34. Rückgaben
    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 Aufrufroutine zurückgegeben werden sollen.
    Zum 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. ​Fehlermeldung Fehlermeldung, die den aufgetretenen Fehler beschreibt. Die verfügbaren Fehlermeldungen sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​ResponseError. ​FehlerReason Grund, warum der Endpunkt fehlgeschlagen ist. Die verfügbaren Fehlergründe sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Status Status des Funktionsaufrufs. Die verfügbaren Statusnachrichten sind in definiert TMFAlarmAPIKonstanten Skripteinbindung.
    ResponseObject. ​Nachfolgeantwort Erfolgreiche Antwort des Funktionsaufrufs. 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;