TroubleticketNotificationUtilOOB - Com escopo

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

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

    Substitua os métodos nesta inclusão de script para:
    • Adicione/remova atributos a 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 Configure notificações de tíquete de problemas usando a Estrutura de notificação de evento do produtor.

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

    O usuário solicitante 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 de TMF aprovada. Os atributos adicionados por este método são adicionados ao cabeçalho de nível de evento para todos os eventos de tíquete de problemas.

    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 TMF621 Trouble Ticket Management REST Especificação v5.0.0 e o. TMF688 Guia do usuário da API de gestão de eventos 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(String eventId)

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

    Na implementação padrão, este método adiciona o. eventIde o. @typeatributos do cabeçalho.

    Este método chama o método auxiliar Attributes() . Neste método, você pode adicionar outros atributos de cabeçalho à carga do evento. Para obter detalhes, consulte Modifique a carga de um evento de tíquete de problemas.

    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 passar o ID do evento, o valor será definido como um GUID gerado pelo sistema.
    Tabela 4. Retornos
    Tipo Descrição
    Objeto Carga de TMF com os atributos de nível de evento definidos. Para obter detalhes sobre o formato desta carga de evento, consulte TMF688 Guia do usuário da API de gestão de eventos v4.0.0 .

    O exemplo de código a seguir mostra como chamar esse método para construir os atributos de cabeçalho de 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(Object incidentGr, cadeia de caracteres eventType, cadeia eventId)

    Cria a carga compatível com TMF para o tipo de evento de incidente Criar 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.
    • Attributes() : Substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga. Este método é apenas um stub na implementação padrão.

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

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro do Glide formatado JSON que causou a geração do evento de tíquete de problemas. Use as informações neste registro do 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 de base, consulte EVENT_TYPES.EVENT_TYPES em Constantes sn_api_notif_mgmt.constantes arquivo de inclusão de script.
    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 TMF621 Trouble Ticket Management REST Especificação v5.0.0 e o. TMF688 Guia do usuário da API de gestão de eventos 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(Object incidentGr, cadeia de caracteres eventType, cadeia de caracteres eventID)

    Cria a carga compatível com TMF para o tipo de evento de caso Criar tíquete de problema associado.

    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 do evento (TMF688) à carga.
    • AddCreateTroubleTicketAttributesForCase() : Substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga. Este método é apenas um stub na implementação padrão.

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

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro do Glide formatado JSON que causou a geração do evento de tíquete de problemas. Use as informações neste registro do 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 de base, consulte EVENT_TYPES.EVENT_TYPES em Constantes sn_api_notif_mgmt.constantes arquivo de inclusão de script.
    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 TMF621 Trouble Ticket Management REST Especificação v5.0.0 e o. TMF688 Guia do usuário da API de gestão de eventos 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, cadeia de caracteres eventType, cadeia de caracteres eventID)

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

    Este método é executado quando o tipo de evento associado é TROUBLE_TICKET_ATTRITE_CHANGE: "TROUBLETICKETATTRIBUTECHANGEEVENT" . Este método chama dois métodos auxiliares:
    • ConstructTMFEvent() : Adiciona os atributos do evento (TMF688) à carga.
    • AttributeChangeTroubleTicketAttributes() : Substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga. Este método é apenas um stub na implementação padrão.

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

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro do Glide formatado JSON que causou a geração do evento de tíquete de problemas. Use as informações neste registro do 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 de base, consulte EVENT_TYPES.EVENT_TYPES em Constantes sn_api_notif_mgmt.constantes arquivo de inclusão de script.
    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 TMF621 Trouble Ticket Management REST Especificação v5.0.0 e o. TMF688 Guia do usuário da API de gestão de eventos 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(Object incidentGr, cadeia de caracteres eventType, cadeia de caracteres eventId)

    Cria 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 do evento (TMF688) à carga.
    • Attributes() : Substitua este método para adicionar atributos de tíquete de problema (TMF621), obrigatórios e opcionais, à carga. Este método é apenas um stub na implementação padrão.

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

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    incidentGr Objeto Registro do Glide formatado JSON que causou a geração do evento de tíquete de problemas. Use as informações neste registro do 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 de base, consulte EVENT_TYPES.EVENT_TYPES em Constantes sn_api_notif_mgmt.constantes arquivo de inclusão de script.
    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 TMF621 Trouble Ticket Management REST Especificação v5.0.0 e o. TMF688 Guia do usuário da API de gestão de eventos 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;
},