TroubleTicketNotificationUtilOOB : inclus dans le champ d’application

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 9 minutes de lecture

    • L’include de script TroubleTicketNotificationUtilOOB fournit des méthodes utilisées pour définir et générer les charges utiles conformes à TMF pour les événements de notification de ticket d’incident.

    Remplacez les méthodes de ce include de script par :
    • Ajouter/supprimer des attributs à un type d’événement de ticket existant.
    • Définissez les attributs d’un nouveau type d’événement de ticket d’incident.
    Pour en savoir plus, consultez Configurer les notifications de ticket d’incident à l’aide de l’infrastructure de notification d’événement du créateur.

    Cet include de script s’exécute dans l’espace de noms sn_ind_tsm_sdwan .

    L’utilisateur appelant doit avoir le rôle ticket_integrator.

    TroubleTicketNotificationUtilOOB : addAdditionalEventAttributes(Object tmfEventPayload)

    Ajoute des attributs d’en-tête d’événement personnalisés à la charge utile de l’événement de ticket de problème TMF transmis. Les attributs ajoutés par cette méthode sont ajoutés à l’en-tête au niveau de l’événement pour tous les événements de ticket d’incident.

    Tableau 1. Paramètres
    Nom Type Description
    tmfEventPayload Objet Charge utile de l’événement de ticket d’incident conforme à la TMF. Pour plus d’informations sur le format de cette charge utile d’événement, consultez la spécification REST de l’API TMF621 Trouble Ticket Management v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.
    Tableau 2. Renvoie
    Type Description
    Aucun

    L’exemple de code suivant montre comment appeler cette méthode.

    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(String eventId)

    Génère les attributs d’en-tête conformes à TMF688 dans la section événement de la charge utile. Ces attributs sont cohérents dans toutes les charges utiles de l’événement.

    Dans l’implémentation par défaut, cette méthode ajoute les attributs d’en-tête eventId et .@type

    Cette méthode appelle la méthode d’aide addAdditionalEventAttributes(). Dans cette méthode, vous pouvez ajouter d’autres attributs d’en-tête à la charge utile de l’événement. Pour plus de détails, voir Modifier la charge utile d’un événement de ticket de dépannage.

    Tableau 3. Paramètres
    Nom Type Description
    eventId Chaîne Identificateur unique de l’événement associé. Il peut s’agir de n’importe quelle valeur unique. Dans l’implémentation par défaut, si vous ne transmettez pas l’ID d’événement, la valeur est définie sur un GUID généré par le système.
    Tableau 4. Renvoie
    Type Description
    Objet Charge TMF avec les attributs au niveau de l’événement définis. Pour en savoir plus sur le format de cette charge utile d’événement, consultez leGuide de l’utilisateur de l’API Gestion des événements TMF688 v4.0.0.

    L’exemple de code suivant montre comment appeler cette méthode pour construire les attributs d’en-tête d’événement lors de la génération d’une charge utile de changement d’attribut de ticket d’incident.

    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)

    Construit la charge utile conforme à TMF pour le type d’événement Créer un ticket d’incident associé.

    Cette méthode est exécutée lorsque le type d’événement associé est TROUBLE_TICKET_CREATE : « TroubleTicketCreateEvent ». Cette méthode appelle deux méthodes d’assistance :
    • constructTMFEvent() : ajoute les attributs d’en-tête d’événement (TMF688) à la charge utile.
    • addCreateTroubleTicketAttributes() : remplacez cette méthode pour ajouter des attributs de ticket d’incident (TMF621), à la fois obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un stub dans l’implémentation par défaut.

    Vous pouvez remplacer ces méthodes d’assistance dans l’include de script TroubleTicketNotificationUtil pour configurer à la fois l’en-tête d’événement et les attributs de ticket de problème dans la charge utile conforme à TMF.

    Tableau 5. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON qui a provoqué la génération de l’événement de ticket d’incident. Utilisez les informations de cet enregistrement Glide pour construire la charge utile de l’événement de ticket d’incident conforme à la norme TMF621.
    eventType Chaîne
    Identificateur unique du type d’événement de ticket de problème associé. Pour l’implémentation par défaut de cette méthode, cela doit toujours être
    « TroubleTicketCreateEvent ».

    Pour obtenir la liste de tous les types d’événements de ticket de défaillance de base, consultez Constants.EVENT_TYPES dans le sn_api_notif_mgmt. Les constantes du fichier include de script.
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 6. Renvoie
    Type Description
    Objet Charge utile de l’événement de ticket d’incident conforme à la TMF. Pour plus d’informations sur le format de cette charge utile d’événement, consultez la spécification REST de l’API TMF621 Trouble Ticket Management v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.

    L’exemple de code suivant montre comment appeler cette méthode.

    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)

    Construit la charge utile conforme à TMF pour le type d’événement Créer un ticket d’incident pour le ticket associé.

    Cette méthode est exécutée lorsque le type d’événement associé est TROUBLE_TICKET_CREATE_FOR_CASE : « TroubleTicketCreateEventForCase ». Cette méthode appelle deux méthodes d’assistance :
    • constructTMFEvent() : ajoute les attributs d’événement (TMF688) à la charge utile.
    • addCreateTroubleTicketAttributesForCase() : remplacez cette méthode pour ajouter des attributs de ticket d’incident (TMF621), à la fois obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un stub dans l’implémentation par défaut.

    Vous pouvez remplacer ces méthodes d’assistance dans l’include de script TroubleTicketNotificationUtil pour configurer à la fois l’en-tête d’événement et les attributs de ticket de problème dans la charge utile conforme à TMF.

    Tableau 7. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON qui a provoqué la génération de l’événement de ticket d’incident. Utilisez les informations de cet enregistrement Glide pour construire la charge utile de l’événement de ticket d’incident conforme à la norme TMF621.
    eventType Chaîne
    Identificateur unique du type d’événement de ticket de problème associé. Pour l’implémentation par défaut de cette méthode, cela doit toujours être
    « TroubleTicketCreateEvent ».

    Pour obtenir la liste de tous les types d’événements de ticket de défaillance de base, consultez Constants.EVENT_TYPES dans le sn_api_notif_mgmt. Les constantes du fichier include de script.
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 8. Renvoie
    Type Description
    Objet Charge utile de l’événement de ticket d’incident conforme à la TMF. Pour plus d’informations sur le format de cette charge utile d’événement, consultez la spécification REST de l’API TMF621 Trouble Ticket Management v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.

    L’exemple de code suivant montre comment appeler cette méthode.

    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)

    Construit la charge utile conforme à TMF pour l’événement de changement d’attribut de ticket d’incident pour le type d’événement d’incident.

    Cette méthode est exécutée lorsque le type d’événement associé est TROUBLE_TICKET_ATTRIBUTE_CHANGE : « TroubleTicketAttributeChangeEvent ». Cette méthode appelle deux méthodes d’assistance :
    • constructTMFEvent() : ajoute les attributs d’événement (TMF688) à la charge utile.
    • addAttributeChangeTroubleTicketAttributes() : remplacez cette méthode pour ajouter des attributs de ticket d’incident (TMF621), à la fois obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un stub dans l’implémentation par défaut.

    Vous pouvez remplacer ces méthodes d’assistance dans l’include de script TroubleTicketNotificationUtil pour configurer à la fois l’en-tête d’événement et les attributs de ticket de problème dans la charge utile conforme à TMF.

    Tableau 9. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON qui a provoqué la génération de l’événement de ticket d’incident. Utilisez les informations de cet enregistrement Glide pour construire la charge utile de l’événement de ticket d’incident conforme à la norme TMF621.
    eventType Chaîne
    Identificateur unique du type d’événement de ticket de problème associé. Pour l’implémentation par défaut de cette méthode, cela doit toujours être
    « TroubleTicketCreateEvent ».

    Pour obtenir la liste de tous les types d’événements de ticket de défaillance de base, consultez Constants.EVENT_TYPES dans le sn_api_notif_mgmt. Les constantes du fichier include de script.
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 10. Renvoie
    Type Description
    Objet Charge utile de l’événement de ticket d’incident conforme à la TMF. Pour plus d’informations sur le format de cette charge utile d’événement, consultez la spécification REST de l’API TMF621 Trouble Ticket Management v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.

    L’exemple de code suivant montre comment appeler cette méthode.

    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)

    Construit la charge utile conforme à la TMF pour l’événement de changement d’état du ticket d’incident associé pour le type d’événement d’incident.

    Cette méthode est exécutée lorsque le type d’événement associé est TROUBLE_TICKET_STATUS_CHANGE : « TroubleTicketStatusChangeEvent ». Cette méthode appelle deux méthodes d’assistance :
    • constructTMFEvent() : ajoute les attributs d’événement (TMF688) à la charge utile.
    • addStatusChangeTroubleTicketAttributes() : remplacez cette méthode pour ajouter des attributs de ticket d’incident (TMF621), à la fois obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un stub dans l’implémentation par défaut.

    Vous pouvez remplacer ces méthodes d’assistance dans l’include de script TroubleTicketNotificationUtil pour configurer à la fois l’en-tête d’événement et les attributs de ticket de problème dans la charge utile conforme à TMF.

    Tableau 11. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON qui a provoqué la génération de l’événement de ticket d’incident. Utilisez les informations de cet enregistrement Glide pour construire la charge utile de l’événement de ticket d’incident conforme à la norme TMF621.
    eventType Chaîne
    Identificateur unique du type d’événement de ticket de problème associé. Pour l’implémentation par défaut de cette méthode, cela doit toujours être
    « TroubleTicketCreateEvent ».

    Pour obtenir la liste de tous les types d’événements de ticket de défaillance de base, consultez Constants.EVENT_TYPES dans le sn_api_notif_mgmt. Les constantes du fichier include de script.
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 12. Renvoie
    Type Description
    Objet Charge utile de l’événement de ticket d’incident conforme à la TMF. Pour plus d’informations sur le format de cette charge utile d’événement, consultez la spécification REST de l’API TMF621 Trouble Ticket Management v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.

    L’exemple de code suivant montre comment appeler cette méthode.

    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;
},