TroubleTicketNotificationUtilOOB – Scoped

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

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

    Ü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 Producer Event Notification Framework.

    Diese Skripteinbindung wird innerhalb des Namespace sn_ind_tsm_sdwan ausgeführt.

    Der aufrufende Benutzer muss die Rolle ticket_integrator haben.

    TroubleTicketNotificationUtilOOB – addAdditionalEventAttributes(Object tmfEventPayload)

    Fügt der übergebenen TMF-Problemticket-Event-Nutzlast benutzerdefinierte Event-Header-Attribute hinzu. Die von dieser Methode hinzugefügten Attribute werden dem Header auf Event-Ebene für alle Problemticket-Events hinzugefügt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    tmfEventPayload Objekt TMF-konforme Nutzlast des Problemticketereignisses. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie in der TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 und im TMF688 Event Management API-Benutzerhandbuch v4.0.0.
    Tabelle : 2. Ergebnisse
    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 Event-Abschnitt der Nutzlast. Diese Attribute sind für alle Event-Nutzlasten konsistent.

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

    Diese Methode ruft die Hilfsmethode addAdditionalEventAttributes() auf. Bei dieser Methode können Sie der Event-Nutzlast weitere Header-Attribute hinzufügen. Details finden Sie unter Ändern Sie die Nutzlast des Problemticketereignisses.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    eventId Zeichenfolge Eindeutiger Identifier des zugeordneten Events. Dies kann ein beliebiger eindeutiger Wert sein. Wenn Sie in der Standardimplementierung die Event-ID nicht übergeben, wird der Wert auf eine vom System generierte GUID festgelegt.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Objekt TMF-Nutzlast mit festgelegten Attributen auf Event-Ebene. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie imTMF688 Event Management API-Benutzerhandbuch v4.0.0.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Event-Header-Attribute beim Generieren einer Nutzlast für die Änderung eines Problemticketattributs 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 den zugeordneten Ereignistyp „Problemticket erstellen für Incident“.

    Diese Methode wird ausgeführt, wenn der zugeordnete Event-Typ TROUBLE_TICKET_CREATE: "TroubleTicketCreateEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • konstruierenTMFEvent(): Fügt der Nutzlast die Event-Header-Attribute (TMF688) hinzu.
    • addCreateTroubleTicketAttributes(): Überschreiben Sie diese Methode, um der Nutzlast Problemticketattribute (TMF621) hinzuzufügen, die sowohl obligatorisch als auch optional sind. Diese Methode ist nur ein Stumpf in der Standardimplementierung.

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

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticketereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Nutzlast des Problemticketereignisses 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 Constants.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Identifier des zugeordneten Events.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    Objekt TMF-konforme Nutzlast des Problemticketereignisses. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie in der TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 und im TMF688 Event Management 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 den zugeordneten Ereignistyp „Problemticket erstellen für Fall“.

    Diese Methode wird ausgeführt, wenn der zugeordnete Event-Typ TROUBLE_TICKET_CREATE_FOR_CASE: "TroubleTicketCreateEventForCase"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • konstruierenTMFEvent(): Fügt der Nutzlast die Event-Attribute (TMF688) hinzu.
    • addCreateTroubleTicketAttributesForCase(): Überschreiben Sie diese Methode, um der Nutzlast sowohl obligatorische als auch optionale Problemticketattribute (TMF621) hinzuzufügen. Diese Methode ist nur ein Stumpf in der Standardimplementierung.

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

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticketereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Nutzlast des Problemticketereignisses 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 Constants.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Identifier des zugeordneten Events.
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Objekt TMF-konforme Nutzlast des Problemticketereignisses. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie in der TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 und im TMF688 Event Management 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-Event des Problemticketattributs für den Incident-Event-Typ.

    Diese Methode wird ausgeführt, wenn der zugeordnete Event-Typ TROUBLE_TICKET_ATTRIBUTE_CHANGE: "TroubleTicketAttributeChangeEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • konstruierenTMFEvent(): Fügt der Nutzlast die Event-Attribute (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 Stumpf in der Standardimplementierung.

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

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticketereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Nutzlast des Problemticketereignisses 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 Constants.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Identifier des zugeordneten Events.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Objekt TMF-konforme Nutzlast des Problemticketereignisses. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie in der TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 und im TMF688 Event Management 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 zugeordnete Change-Event des Problemticketstatus für den Incident-Event-Typ.

    Diese Methode wird ausgeführt, wenn der zugeordnete Event-Typ TROUBLE_TICKET_STATUS_CHANGE: "TroubleTicketStatusChangeEvent"ist. Diese Methode ruft zwei Hilfsmethoden auf:
    • konstruierenTMFEvent(): Fügt der Nutzlast die Event-Attribute (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 Stumpf in der Standardimplementierung.

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

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    incidentGr Objekt JSON-formatierter Glide-Datensatz, der die Generierung des Problemticketereignisses verursacht hat. Verwenden Sie die Informationen in diesem Glide-Datensatz, um die TMF621-konforme Nutzlast des Problemticketereignisses 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 Constants.EVENT_TYPES in der Skripteinbindungsdatei sn_api_notif_mgmt.Constants.
    eventId Zeichenfolge Eindeutiger Identifier des zugeordneten Events.
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Objekt TMF-konforme Nutzlast des Problemticketereignisses. Weitere Informationen zum Format dieser Event-Nutzlast finden Sie in der TMF621 Trouble Ticket Management API REST-Spezifikation v5.0.0 und im TMF688 Event Management 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;
},