TroubleTicketNotificationUtilOOB : dans le champ d’application

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 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 compatibles TMF pour les événements de notification de ticket d’incident.

    Remplacez les méthodes de cet include de script par :
    • Ajouter/supprimer des attributs à un type d’événement de ticket de problème existant.
    • Définissez les attributs d’un nouveau type d’événement de ticket de problème.
    Pour en savoir plus, consultez Configurer les notifications de ticket d’incident à l’aide du Cadre de travail 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 d’événement de ticket de problème TMF transmise. 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 d’événement de ticket de problème conforme à TMF. Pour plus de détails sur le format de cette charge utile d’événement, consultez la spécification REST de l’API Gestion des tickets d’incident TMF621 v5.0.0 et le Guide de l’utilisateur de l’API TMF688 Event Management v4.0.0.
    Tableau 2. Renvoie
    Type Description
    Néant

    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 d’événements.

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

    Cette méthode appelle la méthode d’assistance addAdditionalEventAttributes(). Cette méthode vous permet d’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 d’incident.

    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 de l’événement, la valeur est définie sur un GUID généré par le système.
    Tableau 4. Renvoie
    Type Description
    Objet Charge utile TMF avec les attributs au niveau de l’événement définis. Pour plus de détails sur le format de cette charge utile d’événement, consultez leGuide de l’utilisateur de l’API TMF688 Event Management 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 la création d’un ticket de problème 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_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() : remplacer cette méthode pour ajouter des attributs de ticket d’incident (TMF621), obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un talon 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 d’incident dans la charge utile conforme à TMF.

    Tableau 5. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON ayant provoqué la génération de l’événement de ticket d’incident. Utilisez les informations contenues dans cet enregistrement Glide pour construire la charge utile d’événement de ticket d’incident compatible 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 d’incident de base, consultez Constants.EVENT_TYPES dans la sn_api_notif_mgmt. Fichier d’include de script des constantes .
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 6. Renvoie
    Type Description
    Objet Charge utile d’événement de ticket de problème conforme à TMF. Pour plus de détails sur le format de cette charge utile d’événement, consultez la spécification REST de l’API Gestion des tickets d’incident TMF621 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 la création d’un ticket de problème associé pour le type d’événement de ticket.

    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() : remplacer cette méthode pour ajouter des attributs de ticket d’incident (TMF621), obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un talon 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 d’incident dans la charge utile conforme à TMF.

    Tableau 7. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON ayant provoqué la génération de l’événement de ticket d’incident. Utilisez les informations contenues dans cet enregistrement Glide pour construire la charge utile d’événement de ticket d’incident compatible 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 d’incident de base, consultez Constants.EVENT_TYPES dans la sn_api_notif_mgmt. Fichier d’include de script des constantes .
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 8. Renvoie
    Type Description
    Objet Charge utile d’événement de ticket de problème conforme à TMF. Pour plus de détails sur le format de cette charge utile d’événement, consultez la spécification REST de l’API Gestion des tickets d’incident TMF621 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 de problème 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() : remplacer cette méthode pour ajouter des attributs de ticket d’incident (TMF621), obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un talon 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 d’incident dans la charge utile conforme à TMF.

    Tableau 9. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON ayant provoqué la génération de l’événement de ticket d’incident. Utilisez les informations contenues dans cet enregistrement Glide pour construire la charge utile d’événement de ticket d’incident compatible 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 d’incident de base, consultez Constants.EVENT_TYPES dans la sn_api_notif_mgmt. Fichier d’include de script des constantes .
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 10. Renvoie
    Type Description
    Objet Charge utile d’événement de ticket de problème conforme à TMF. Pour plus de détails sur le format de cette charge utile d’événement, consultez la spécification REST de l’API Gestion des tickets d’incident TMF621 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 à TMF pour l’événement de changement d’état du ticket de problème 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() : remplacer cette méthode pour ajouter des attributs de ticket d’incident (TMF621), obligatoires et facultatifs, à la charge utile. Cette méthode n’est qu’un talon 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 d’incident dans la charge utile conforme à TMF.

    Tableau 11. Paramètres
    Nom Type Description
    incidentGr Objet Enregistrement Glide au format JSON ayant provoqué la génération de l’événement de ticket d’incident. Utilisez les informations contenues dans cet enregistrement Glide pour construire la charge utile d’événement de ticket d’incident compatible 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 d’incident de base, consultez Constants.EVENT_TYPES dans la sn_api_notif_mgmt. Fichier d’include de script des constantes .
    eventId Chaîne Identificateur unique de l’événement associé.
    Tableau 12. Renvoie
    Type Description
    Objet Charge utile d’événement de ticket de problème conforme à TMF. Pour plus de détails sur le format de cette charge utile d’événement, consultez la spécification REST de l’API Gestion des tickets d’incident TMF621 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;
},