TroubleTicketNotificationUtilOOB : Bereichsbezogen

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

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

    Überschreiben Sie die Methoden in dieser Skripteinbindung, um:
    • Fügen Sie einem vorhandenen Problemticket-Ereignistyp Attribute hinzu, oder entfernen Sie Attribute.
    • Definieren Sie Attribute für einen neuen Problemticket-Ereignistyp.
    Weitere Informationen finden Sie unter Konfigurieren Sie Problemticketbenachrichtigungen mit dem Framework für Benachrichtigungen über Ersteller-Ereignisse.

    Diese Skripteinbindung wird im Namespace sn_ind_tsm_sdwan ausgeführt.

    Der anrufende Benutzer muss über die Rolle ticket_integrator verfügen.

    TroubleTicketNotificationUtilOOB – addAdditionalEventAttributes(Object tmfEventPayload)

    Fügt der übergebenen TMF-Problemticket-Ereignisnutzlast anwenderdefinierte Ereignisheaderattribute hinzu. Die mit 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. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie in der REST-Spezifikation TMF621 Trouble Ticket Management API v5.0.0 und im 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 – buildTMFEvent(String eventId)

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

    In der Standardimplementierung fügt diese Methode die Header-Attribute eventId und @type hinzu.

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

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    eventId Zeichenfolge Eindeutiger Bezeichner des zugeordneten 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 festgelegten Attributen auf Ereignisebene. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie imTMF688 Ereignismanagement-API-Benutzerhandbuch v4.0.0.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Ereignis-Header-Attribute zu erstellen, wenn eine Nutzlast für die Änderung des Problemticketattributs generiert wird.

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

  return tmfEventPayload;
},

    TroubleTicketNotificationUtilOOB -generateCreateTroubleTicketEventPaylaod(Object incidentGr, Zeichenfolge eventType, Zeichenfolge eventId)

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

    Diese Methode wird ausgeführt, wenn der zugeordnete Ereignistyp TROUBLE_TICKET_CREATE: "TroubleTicketCreateEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • buildTMFEvent(): Fügt der Nutzlast die Ereignis-Header-Attribute (TMF688) hinzu.
    • addCreateTroubleTicketAttributes(): Überschreiben Sie diese Methode, um der Nutzlast die obligatorischen und optionalen Trouble Ticket-Attribute (TMF621) hinzuzufügen. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in der Skripteinbindung TroubleTicketNotificationUtil überschreiben, um sowohl Ereignis-Header- als auch Problemticket-Attribute in der TMF-konformen Nutzlast zu konfigurieren.

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

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstanten.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugeordneten Ereignisses.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie in der REST-Spezifikation TMF621 Trouble Ticket Management API v5.0.0 und im 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, Zeichenfolgen-eventType, Zeichenfolgen-eventId)

    Erstellt die TMF-konforme Nutzlast für den zugehörigen Ereignistyp „Problemticket für Fall erstellen“.

    Diese Methode wird ausgeführt, wenn der zugeordnete Ereignistyp TROUBLE_TICKET_CREATE_FOR_CASE: "TroubleTicketCreateEventForCase"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • buildTMFEvent(): Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • addCreateTroubleTicketAttributesForCase(): Überschreiben Sie diese Methode, um der Nutzlast Problemticketattribute (TMF621) hinzuzufügen, die sowohl obligatorisch als auch optional sind. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in der Skripteinbindung TroubleTicketNotificationUtil überschreiben, um sowohl Ereignis-Header- als auch Problemticket-Attribute in der TMF-konformen Nutzlast zu konfigurieren.

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

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstanten.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugeordneten Ereignisses.
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie in der REST-Spezifikation TMF621 Trouble Ticket Management API v5.0.0 und im 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, Zeichenfolgen-eventType, Zeichenfolgen-eventId)

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

    Diese Methode wird ausgeführt, wenn der zugeordnete Ereignistyp TROUBLE_TICKET_ATTRIBUTE_CHANGE: "TroubleTicketAttributeChangeEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • buildTMFEvent(): Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • addAttributeChangeTroubleTicketAttributes(): Überschreiben Sie diese Methode, um der Nutzlast Problemticketattribute (TMF621) hinzuzufügen, die sowohl obligatorisch als auch optional sind. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in der Skripteinbindung TroubleTicketNotificationUtil überschreiben, um sowohl Ereignis-Header- als auch Problemticket-Attribute in der TMF-konformen Nutzlast zu konfigurieren.

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

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstanten.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugeordneten Ereignisses.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie in der REST-Spezifikation TMF621 Trouble Ticket Management API v5.0.0 und im 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, Zeichenfolge eventType, Zeichenfolge eventId)

    Erstellt die TMF-konforme Nutzlast für das zugehörige Change-Ereignis des Problemticketstatus für den Incident-Ereignistyp.

    Diese Methode wird ausgeführt, wenn der zugeordnete Ereignistyp TROUBLE_TICKET_STATUS_CHANGE: "TroubleTicketStatusChangeEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • buildTMFEvent(): Fügt der Nutzlast die Ereignisattribute (TMF688) hinzu.
    • addStatusChangeTroubleTicketAttributes(): Überschreiben Sie diese Methode, um der Nutzlast Problemticketattribute (TMF621) hinzuzufügen, die sowohl obligatorisch als auch optional sind. Diese Methode ist nur ein Stub in der Standardimplementierung.

    Sie können diese Hilfsmethoden in der Skripteinbindung TroubleTicketNotificationUtil überschreiben, um sowohl Ereignis-Header- als auch Problemticket-Attribute in der TMF-konformen Nutzlast zu konfigurieren.

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

    Eine Liste aller Basis-Problemticket-Ereignistypen finden Sie unter Konstanten.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Bezeichner des zugeordneten Ereignisses.
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Objekt TMF-konforme Problemticket-Ereignisnutzlast. Weitere Informationen zum Format dieser Ereignisnutzlast finden Sie in der REST-Spezifikation TMF621 Trouble Ticket Management API v5.0.0 und im 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;
},