TroubleTicketNotificationUtilOOB - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 9 min. de leitura

    • A inclusão de script TroubleTicketNotificationUtilOOB fornece métodos usados para definir e gerar as cargas compatíveis com TMF para eventos de notificação de tíquete de problema.

    Substitua os métodos neste script include para:
    • Adicionar/remover atributos de um tipo de evento de tíquete de problema existente.
    • Defina atributos para um novo tipo de evento de tíquete de problema.
    Para obter informações adicionais, confira Configurar notificações de tíquete de problema usando a Estrutura de notificação de eventos do produtor.

    Esta inclusão de script é executada no namespace sn_ind_tsm_sdwan.

    O usuário de chamada deve ter a função ticket_integrator.

    TroubleTicketNotificationUtilOOB - addAdditionalEventAttributes(Object tmfEventPayload)

    Adiciona atributos de cabeçalho de evento personalizado à carga de evento de tíquete de problema do TMF aprovada. Os atributos adicionados por este método são adicionados ao cabeçalho no nível do evento para todos os eventos de tíquete de problema.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    tmfEventPayload Objeto Carga de evento de tíquete de problema compatível com TMF. Para obter detalhes sobre o formato desta carga de evento, consulte a Especificação REST da API de gestão de tíquetes de problemas TMF621 v5.0.0 e o Guia do usuário da API de gestão de eventos TMF688 v4.0.0.
    Tabela 2. Retornos
    Tipo Descrição
    Nenhum(a)

    O exemplo de código a seguir mostra como chamar este método.

    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(cadeia de caracteres eventId)

    Gera os atributos de cabeçalho compatíveis com TMF688 na seção de evento da carga útil. Esses atributos são consistentes em todas as cargas de evento.

    Na implementação padrão, este método adiciona os atributos de cabeçalho eventId e @type.

    Este método chama o método auxiliar addAdditionalEventAttributes(). Neste método, você pode adicionar outros atributos de cabeçalho à carga do evento. Para obter detalhes, consulte Modificar uma carga de evento de tíquete de problema.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    eventId Cadeia de caracteres Identificador exclusivo do evento associado. Pode ser qualquer valor exclusivo. Na implementação padrão, se você não aprovar o ID do evento, o valor será definido como um GUID gerado pelo sistema.
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Carga do TMF com o conjunto de atributos no nível do evento. Para obter detalhes sobre o formato desta carga de evento, consulte oGuia do usuário da API de gestão de eventos TMF688 v4.0.0.

    O exemplo de código a seguir mostra como chamar este método para construir os atributos de cabeçalho do evento ao gerar uma carga de mudança de atributo de tíquete de problema.

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

  return tmfEventPayload;
},

    TroubleTicketNotificationUtilOOB - generateCreateTroubleTicketEventPaylaod (objeto incidentGr, cadeia de caracteres eventType, cadeia de caracteres eventId)

    Constrói a carga compatível com TMF para o tipo de evento de criação de tíquete de problema associado.

    Este método é executado quando o tipo de evento associado é TROUBLE_TICKET_CREATE: "TroubleTicketCreateEvent". Este método chama dois métodos auxiliares:
    • constructTMFEvent(): adiciona os atributos do cabeçalho do evento (TMF688) à carga.
    • addCreateTroubleTicketAttributes(): substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga útil. Este método é apenas um esboço na implementação padrão.

    Você pode substituir esses métodos auxiliares na inclusão de script TroubleTicketNotificationUtil para configurar o cabeçalho do evento e os atributos do tíquete de problema na carga compatível com TMF.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro de glide no formato JSON que causou a geração do evento de tíquete de problema. Use as informações neste registro de glide para criar a carga de evento de tíquete de problema compatível com TMF621.
    eventType Cadeia de caracteres
    Identificador exclusivo do tipo de evento de tíquete de problema associado. Para a implementação padrão deste método, isso deve ser sempre
    "TroubleTicketCreateEvent".

    Para obter uma lista de todos os tipos de evento de tíquete de problema base, consulte Constants.EVENT_TYPES no arquivo de inclusão de script sn_api_notif_mgmt.Constants.
    eventId Cadeia de caracteres Identificador exclusivo do evento associado.
    Tabela 6. Retornos
    Tipo Descrição
    Objeto Carga de evento de tíquete de problema compatível com TMF. Para obter detalhes sobre o formato desta carga de evento, consulte a Especificação REST da API de gestão de tíquetes de problemas TMF621 v5.0.0 e o Guia do usuário da API de gestão de eventos TMF688 v4.0.0.

    O exemplo de código a seguir mostra como chamar este método.

    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(objeto incidentGr, cadeia de caracteres eventType, cadeia de caracteres eventId)

    Constrói a carga compatível com TMF para a criação de tíquete de problema associado para o tipo de evento de caso.

    Este método é executado quando o tipo de evento associado é TROUBLE_TICKET_CREATE_FOR_CASE: "TroubleTicketCreateEventForCase". Este método chama dois métodos auxiliares:
    • constructTMFEvent(): adiciona os atributos de evento (TMF688) à carga útil.
    • addCreateTroubleTicketAttributesForCase(): substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga útil. Este método é apenas um esboço na implementação padrão.

    Você pode substituir esses métodos auxiliares na inclusão de script TroubleTicketNotificationUtil para configurar o cabeçalho do evento e os atributos do tíquete de problema na carga compatível com TMF.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro de glide no formato JSON que causou a geração do evento de tíquete de problema. Use as informações neste registro de glide para criar a carga de evento de tíquete de problema compatível com TMF621.
    eventType Cadeia de caracteres
    Identificador exclusivo do tipo de evento de tíquete de problema associado. Para a implementação padrão deste método, isso deve ser sempre
    "TroubleTicketCreateEvent".

    Para obter uma lista de todos os tipos de evento de tíquete de problema base, consulte Constants.EVENT_TYPES no arquivo de inclusão de script sn_api_notif_mgmt.Constants.
    eventId Cadeia de caracteres Identificador exclusivo do evento associado.
    Tabela 8. Retornos
    Tipo Descrição
    Objeto Carga de evento de tíquete de problema compatível com TMF. Para obter detalhes sobre o formato desta carga de evento, consulte a Especificação REST da API de gestão de tíquetes de problemas TMF621 v5.0.0 e o Guia do usuário da API de gestão de eventos TMF688 v4.0.0.

    O exemplo de código a seguir mostra como chamar este método.

    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)

    Constrói a carga compatível com TMF para o evento de mudança de atributo do tíquete de problema para o tipo de evento de incidente.

    Este método é executado quando o tipo de evento associado é TROUBLE_TICKET_ATTRIBUTE_CHANGE: "TroubleTicketAttributeChangeEvent". Este método chama dois métodos auxiliares:
    • constructTMFEvent(): adiciona os atributos de evento (TMF688) à carga útil.
    • addAttributeChangeTroubleTicketAttributes(): substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga útil. Este método é apenas um esboço na implementação padrão.

    Você pode substituir esses métodos auxiliares na inclusão de script TroubleTicketNotificationUtil para configurar o cabeçalho do evento e os atributos do tíquete de problema na carga compatível com TMF.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro de glide no formato JSON que causou a geração do evento de tíquete de problema. Use as informações neste registro de glide para criar a carga de evento de tíquete de problema compatível com TMF621.
    eventType Cadeia de caracteres
    Identificador exclusivo do tipo de evento de tíquete de problema associado. Para a implementação padrão deste método, isso deve ser sempre
    "TroubleTicketCreateEvent".

    Para obter uma lista de todos os tipos de evento de tíquete de problema base, consulte Constants.EVENT_TYPES no arquivo de inclusão de script sn_api_notif_mgmt.Constants.
    eventId Cadeia de caracteres Identificador exclusivo do evento associado.
    Tabela 10. Retornos
    Tipo Descrição
    Objeto Carga de evento de tíquete de problema compatível com TMF. Para obter detalhes sobre o formato desta carga de evento, consulte a Especificação REST da API de gestão de tíquetes de problemas TMF621 v5.0.0 e o Guia do usuário da API de gestão de eventos TMF688 v4.0.0.

    O exemplo de código a seguir mostra como chamar este método.

    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 (objeto incidentGr, cadeia de caracteres eventType, cadeia de caracteres eventId)

    Constrói a carga compatível com TMF para o evento de mudança de status do tíquete de problema associado para o tipo de evento de incidente.

    Este método é executado quando o tipo de evento associado é TROUBLE_TICKET_STATUS_CHANGE: "TroubleTicketStatusChangeEvent". Este método chama dois métodos auxiliares:
    • constructTMFEvent(): adiciona os atributos de evento (TMF688) à carga útil.
    • addStatusChangeTroubleTicketAttributes(): substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga útil. Este método é apenas um esboço na implementação padrão.

    Você pode substituir esses métodos auxiliares na inclusão de script TroubleTicketNotificationUtil para configurar o cabeçalho do evento e os atributos do tíquete de problema na carga compatível com TMF.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro de glide no formato JSON que causou a geração do evento de tíquete de problema. Use as informações neste registro de glide para criar a carga de evento de tíquete de problema compatível com TMF621.
    eventType Cadeia de caracteres
    Identificador exclusivo do tipo de evento de tíquete de problema associado. Para a implementação padrão deste método, isso deve ser sempre
    "TroubleTicketCreateEvent".

    Para obter uma lista de todos os tipos de evento de tíquete de problema base, consulte Constants.EVENT_TYPES no arquivo de inclusão de script sn_api_notif_mgmt.Constants.
    eventId Cadeia de caracteres Identificador exclusivo do evento associado.
    Tabela 12. Retornos
    Tipo Descrição
    Objeto Carga de evento de tíquete de problema compatível com TMF. Para obter detalhes sobre o formato desta carga de evento, consulte a Especificação REST da API de gestão de tíquetes de problemas TMF621 v5.0.0 e o Guia do usuário da API de gestão de eventos TMF688 v4.0.0.

    O exemplo de código a seguir mostra como chamar este método.

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