TroubleTicketNotificationUtilOOB – Umfang

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 6 Minuten Lesedauer

    • Die TroubleTicketNotificationUtilOOB Die Skripteinbindung stellt Methoden bereit, die zum Definieren und Generieren der TMF-konformen Nutzlasten für Problemticket-Benachrichtigungsereignisse verwendet werden.

    Überschreiben Sie die Methoden in dieser Skripteinbindung auf:
    • Fügen Sie einem vorhandenen Problemticket-Ereignistyp Attribute hinzu bzw. entfernen Sie sie.
    • Definieren Sie Attribute für einen neuen Problemticket-Ereignistyp.
    Weitere Informationen finden Sie unter Konfigurieren Sie Problemticketbenachrichtigungen mit dem Framework für Ereignisbenachrichtigungen des Erstellers.

    Diese Skripteinbindung wird innerhalb von ausgeführt sn_ind_tsm_sdwan Namespace.

    Der aufrufende Anwender muss über die Rolle Ticket_Integrator verfügen.

    TroubleTicketNotificationUtilOOB – addAdditionalEventAttributes(Object tmfEventPayload)

    Fügt der übergebenen TMF-Problemticket-Ereignisnutzlast anwenderdefinierte Ereignis-Header-Attribute hinzu. Die von dieser Methode hinzugefügten Attribute werden dem Header auf Ereignisebene für alle Problemticket-Ereignisse hinzugefügt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    TmfEventPayload Objekt TMF-konforme Problemticket-Ereignisnutzlast. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 Und TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    constructTMFEvent: function(eventId) {
  var troubleTicketEvent = {};
  if (gs.nil(eventId)) {
    troubleTicketEvent.eventId = gs.generateGUID();
  } else {
    troubleTicketEvent.eventId = eventId;
  }
  troubleTicketEvent['@type'] = Constants.EVENT_TYPE_TROUBLE_TICKET;
  this.addAdditionalEventAttributes(troubleTicketEvent);
  return troubleTicketEvent;
},

    TroubleTicketNotificationUtilOOB – constructTMFEvent(Zeichenfolge eventId)

    Generiert die TMF688-konformen Headerattribute im Ereignisabschnitt der Nutzlast. Diese Attribute sind für alle Ereignisnutzlasten konsistent.

    In der Standardimplementierung fügt diese Methode hinzu eventIdUnd @typeHeader-Attribute.

    Diese Methode ruft die Hilfsmethode auf AddAdditionalEventAttributes() . Mit dieser Methode können Sie der Ereignisnutzlast weitere Headerattribute hinzufügen. Details finden Sie unter Ändern Sie die Nutzlast eines Trouble Ticket-Ereignisses.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    eventId Zeichenfolge Eindeutiger Bezeichner des zugehörigen Ereignisses. Dies kann ein beliebiger eindeutiger Wert sein. Wenn Sie in der Standardimplementierung die Ereignis-ID nicht übergeben, wird der Wert auf eine vom System generierte GUID festgelegt.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Objekt TMF-Nutzlast mit den Attributen auf Ereignisebene festgelegt. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Ereignis-Header-Attribute beim Generieren einer Change-Nutzlast eines Problemticket-Attributs zu erstellen.

    generateTroubleTicketAttributeChangePayload: function(incidentGr, eventType, eventId) {
  var tmfEventPayload = this.constructTMFEvent(eventId);
  tmfEventPayload.eventType = eventType;
  tmfEventPayload.event = this.addAttributeChangeTroubleTicketAttributes(incidentGr);

  return tmfEventPayload;
},

    TroubleTicketNotificationUtilOOB – generateCreateTroubleTicketEventPaylaod(Object incidentGr, String eventType, String eventId)

    Erstellt die TMF-konforme Nutzlast für das zugehörige „Problemticket erstellen“ für den Ereignistyp „Incident“.

    Diese Methode wird ausgeführt, wenn der zugehörige Ereignistyp lautet TROUBLE_TICKET_CREATE: „TROUBLETICKETCREATEEVENT“ . Diese Methode ruft zwei Hilfsmethoden auf:
    • ConstructTMFEvent() : Fügt der Nutzlast die Ereignis-Header-Attribute (TMF688) hinzu.
    • AddCreateTroubleTicketAttributes() : Überschreiben Sie diese Methode, um der Nutzlast Trouble Ticket-Attribute (TMF621) hinzuzufügen, sowohl obligatorisch als auch optional. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in überschreiben TroubleTicketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticket-Ereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Trouble Ticket-Ereignisnutzlast zu erstellen.
    eventType Zeichenfolge
    Eindeutiger Bezeichner des zugehörigen Problemticket-Ereignistyps. Für die Standardimplementierung dieser Methode sollte dies immer sein
    „TroubleTicketCreateEvent“ .

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstants.EVENT_TYPES In sn_api_notif_mgmt.Konstanten Skripteinbindungsdatei.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugehörigen Ereignisses.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 Und TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

    TroubleTicketNotificationUtilOOB – generateCreateTroubleTicketEventPaylaodForCase(Object incidentGr, String eventType, String eventId)

    Erstellt die TMF-konforme Nutzlast für das zugehörige „Problemticket erstellen“ für den Fallereignistyp.

    Diese Methode wird ausgeführt, wenn der zugehörige Ereignistyp lautet TROUBLE_TICKET_CREATE_FOR_CASE: „TROUBLETICKETCREATEEVENTFORCASE“ . Diese Methode ruft zwei Hilfsmethoden auf:
    • ConstructTMFEvent() : Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • AddCreateTroubleTicketAttributesForCase() : Überschreiben Sie diese Methode, um der Nutzlast Trouble Ticket-Attribute (TMF621) hinzuzufügen, sowohl obligatorisch als auch optional. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in überschreiben TroubleTicketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticket-Ereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Trouble Ticket-Ereignisnutzlast zu erstellen.
    eventType Zeichenfolge
    Eindeutiger Bezeichner des zugehörigen Problemticket-Ereignistyps. Für die Standardimplementierung dieser Methode sollte dies immer sein
    „TroubleTicketCreateEvent“ .

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstants.EVENT_TYPES In sn_api_notif_mgmt.Konstanten Skripteinbindungsdatei.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugehörigen Ereignisses.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 Und TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

    TroubleTicketNotificationUtilOOB – generateTroubleTicketAttributeChangePayload(Object incidentGr, String eventType, String eventId)

    Erstellt die TMF-konforme Nutzlast für das Change-Ereignis des Problemticket-Attributs für den Incident-Ereignistyp.

    Diese Methode wird ausgeführt, wenn der zugehörige Ereignistyp lautet TROUBLE_TICKET_ATTRIBUTE_CHANGE: „TROUBLETICKETATTRIBUTECHANGEEVENT“ . Diese Methode ruft zwei Hilfsmethoden auf:
    • ConstructTMFEvent() : Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • AddAttributeChangeTroubleTicketAttributes() : Überschreiben Sie diese Methode, um der Nutzlast Trouble Ticket-Attribute (TMF621) hinzuzufügen, sowohl obligatorisch als auch optional. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in überschreiben TroubleTicketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticket-Ereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Trouble Ticket-Ereignisnutzlast zu erstellen.
    eventType Zeichenfolge
    Eindeutiger Bezeichner des zugehörigen Problemticket-Ereignistyps. Für die Standardimplementierung dieser Methode sollte dies immer sein
    „TroubleTicketCreateEvent“ .

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstants.EVENT_TYPES In sn_api_notif_mgmt.Konstanten Skripteinbindungsdatei.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugehörigen Ereignisses.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 Und TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},

    TroubleTicketNotificationUtilOOB – generateTroubleTicketStatusChangePayload(Object incidentGr, String eventType, String eventId)

    Erstellt die TMF-konforme Nutzlast für das zugehörige Statusänderungsereignis des Problemtickets für den Ereignistyp „Incident“.

    Diese Methode wird ausgeführt, wenn der zugehörige Ereignistyp lautet TROUBLE_TICKET_STATUS_CHANGE: „TROUBLETICKETSTATUSCHANGEEVENT“ . Diese Methode ruft zwei Hilfsmethoden auf:
    • ConstructTMFEvent() : Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • AddStatusChangeTroubleTicketAttributes() : Überschreiben Sie diese Methode, um der Nutzlast Trouble Ticket-Attribute (TMF621) hinzuzufügen, sowohl obligatorisch als auch optional. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in überschreiben TroubleTicketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticket-Ereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Trouble Ticket-Ereignisnutzlast zu erstellen.
    eventType Zeichenfolge
    Eindeutiger Bezeichner des zugehörigen Problemticket-Ereignistyps. Für die Standardimplementierung dieser Methode sollte dies immer sein
    „TroubleTicketCreateEvent“ .

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstants.EVENT_TYPES In sn_api_notif_mgmt.Konstanten Skripteinbindungsdatei.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugehörigen Ereignisses.
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 Und TMF688 Ereignismanagement-API – Benutzerhandbuch v4.0.0 .

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    fetchEventHandlerAndCreateTMFEvent: function(eventSnapshot, eventType, eventId) {
  var eventPayload;
  switch (eventType) {
    case Constants.EVENT_TYPES.TROUBLE_TICKET_STATUS_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketStatusChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaod(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_ATTRIBUTE_CHANGE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateTroubleTicketAttributeChangePayload(eventSnapshot, eventType, eventId);
      break;

    case Constants.EVENT_TYPES.TROUBLE_TICKET_CREATE_FOR_CASE:
      eventPayload = new sn_ind_tsm_sdwan.TroubleTicketNotificationUtil().generateCreateTroubleTicketEventPaylaodForCase(eventSnapshot, eventType, eventId);
      break;

    default:
      this._logger.debug("Event with id " + eventId + " could not find the matching payload generator");
      eventPayload = null;
  }
return eventPayload;
},