ProblemTicketNotificationUtilOOB – Umfang
Die ProblemTicketNotificationUtilOOB Die Skripteinbindung bietet Methoden zum Definieren und Generieren der TMF-konformen Nutzlasten für Problemticket-Benachrichtigungsereignisse.
- Fügen Sie einem vorhandenen Problemticket-Ereignistyp Attribute hinzu bzw. entfernen Sie sie.
- Definieren Sie Attribute für einen neuen Trouble-Ticket-Ereignistyp.
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 Nutzlast des TMF-Problemticket-Ereignisses anwenderdefinierte Ereignis-Header-Attribute hinzu. Die von dieser Methode hinzugefügten Attribute werden dem Header auf Ereignisebene für alle Trouble Ticket-Ereignisse hinzugefügt.
| Name | Typ | Beschreibung |
|---|---|---|
| TmfEventPayload | Objekt | TMF-konforme Ereignisnutzlast des Problemtickets. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 – API-REST-Spezifikation für Problemticketmanagement v5.0.0 Und TMF688 Ereignismanagement-API-Anwenderhandbuch v4.0.0 . |
| 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 eine Nutzlast eines Problemticket-Ereignisses.
| 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. |
| Typ | Beschreibung |
|---|---|
| Objekt | TMF-Nutzlast mit den Attributen auf Ereignisebene festgelegt. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF688 Ereignismanagement-API-Anwenderhandbuch v4.0.0 . |
Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die Ereignis-Header-Attribute beim Generieren einer Nutzlast einer Problemticket-Attributänderung 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“.
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 ProblemticketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.
| 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 Problemticket-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 Constants.EVENT_TYPES In sn_api_notif_mgmt.Constants Skripteinbindungsdatei. |
| eventId | Zeichenfolge | Eindeutiger Bezeichner des zugeordneten Ereignisses. |
| Typ | Beschreibung |
|---|---|
| Objekt | TMF-konforme Ereignisnutzlast des Problemtickets. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 – API-REST-Spezifikation für Problemticketmanagement v5.0.0 Und TMF688 Ereignismanagement-API-Anwenderhandbuch 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;
},
TroubleTicketNotificationUtilOB – generateCreateTroubleTicketEventPaylaodForCase(Object incidentGr, String eventType, String eventId)
Erstellt die TMF-konforme Nutzlast für das zugehörige „Problemticket erstellen“ für den Fallereignistyp.
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 ProblemticketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.
| 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 Problemticket-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 Constants.EVENT_TYPES In sn_api_notif_mgmt.Constants Skripteinbindungsdatei. |
| eventId | Zeichenfolge | Eindeutiger Bezeichner des zugeordneten Ereignisses. |
| Typ | Beschreibung |
|---|---|
| Objekt | TMF-konforme Ereignisnutzlast des Problemtickets. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 – API-REST-Spezifikation für Problemticketmanagement v5.0.0 Und TMF688 Ereignismanagement-API-Anwenderhandbuch 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.
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 ProblemticketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.
| 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 Problemticket-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 Constants.EVENT_TYPES In sn_api_notif_mgmt.Constants Skripteinbindungsdatei. |
| eventId | Zeichenfolge | Eindeutiger Bezeichner des zugeordneten Ereignisses. |
| Typ | Beschreibung |
|---|---|
| Objekt | TMF-konforme Ereignisnutzlast des Problemtickets. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 – API-REST-Spezifikation für Problemticketmanagement v5.0.0 Und TMF688 Ereignismanagement-API-Anwenderhandbuch 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“.
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 ProblemticketNotificationUtil Skripteinbindung zum Konfigurieren von Ereignis-Header- und Problemticket-Attributen in der TMF-konformen Nutzlast.
| 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 Problemticket-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 Constants.EVENT_TYPES In sn_api_notif_mgmt.Constants Skripteinbindungsdatei. |
| eventId | Zeichenfolge | Eindeutiger Bezeichner des zugeordneten Ereignisses. |
| Typ | Beschreibung |
|---|---|
| Objekt | TMF-konforme Ereignisnutzlast des Problemtickets. Details zum Format dieser Ereignisnutzlast finden Sie unter TMF621 – API-REST-Spezifikation für Problemticketmanagement v5.0.0 Und TMF688 Ereignismanagement-API-Anwenderhandbuch 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;
},