Configurar um conector personalizado

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 7 min. de leitura

    • Autentique seu conector personalizado como uma fonte de dados para habilitar o envio por push de informações de evento para sua instância ServiceNow. Defina o conector personalizado fornecendo seus detalhes e campos de mapeamento. Isso permite que as informações extraídas das mensagens de evento do conector personalizado preencham os campos de evento obrigatórios. Por fim, crie e forneça um URL para o webhook do conector personalizado.

    Antes de Iniciar

    • Certifique-se de que o plug-in Gestão de eventos conectores (sn_em_connector) esteja instalado na instância Now Platform. Para obter mais informações, consulte Configurar Gestão de eventos conectores.
    • Certifique-se de que os itens de configuração dos hosts gerenciados pelo conector personalizado existam na instância Now Platform. Esses ICs podem ser físicos ou virtuais e podem ser criados manualmente ou descobertos por meio de descoberta de IP ou Descoberta na nuvem. Para obter mais informações, consulte Acesso a ambientes de nuvem para produtos ITOM.

    Função necessária: evt_mgmt_admin

    Por Que e Quando Desempenhar Esta Tarefa

    Para começar a enviar informações de evento para sua instância ServiceNow, você deve definir sua instância Now Platform como o endpoint REST usando um webhook padrão em seu conector personalizado.

    Ao fornecer detalhes do conector e campos de mapeamento, você define o conector personalizado. As informações extraídas das mensagens de evento do conector personalizado preenchem os campos de evento necessários e inserem o evento no banco de dados.

    O URL é gerado pelo código com base na instância ServiceNow e no conector personalizado. Use este URL para criar um webhook que permite que o conector personalizado envie eventos para a instância ServiceNow.

    Procedimento

    1. Navegar até Espaços > Espaço de operações de serviços.
    2. No painel esquerdo, selecione o ícone do Launchpad de integrações ( ícone do Launchpad de integração)
    3. Na guia Procurar integrações, selecione a lista suspensa Todas as integrações e selecione Personalizado.
      Somente blocos de conector personalizados são exibidos.
      Figura 1. Conectores push
      Filtragem com conectores personalizados
    4. Selecione um bloco de tipo de conector personalizado.
    5. Na página Fornecer detalhes, forneça os detalhes do conector.
      Figura 2. Página de detalhes de conectores personalizados
      Página de detalhes do conector personalizado
      1. No campo Nome do conector, insira um nome de integração exclusivo para o conector.
      2. Opcional: No campo Marcadores, insira marcadores para ajudar a localizar e identificar conectores desse tipo no Lista expressa.
        Para adicionar mais marcadores, selecione o ícone de adição (sinal de mais para adicionar mais marcadores) ao lado do campo Marcadores. A janela Adicionar marcadores é aberta.
        1. No campo Chave, insira uma chave de marcador.
        2. No campo Valor, insira um valor de marcador.
        3. Selecione Adicionar.
      3. Opcional: No campo Descrição, insira informações resumidas sobre este conector.
      4. No campo Origem, insira o fornecedor usado para coletar eventos da origem de evento externa.

        O campo Origem identifica o conector e serve como um identificador para reconhecer a origem de eventos e alertas quando o conector está ativo.

      5. Opcional: Na lista suspensa Grupo de atribuição, selecione o grupo ou a equipe responsável por gerenciar e manter o conector.
    6. Opcional: Arraste ou carregue uma imagem para exibir no bloco do conector.
      • Arraste uma imagem para a caixa.
      • Navegue até o arquivo de imagem selecionando Carregar imagem e escolha o arquivo.
      O tamanho máximo do arquivo de carregamento é de 1 MB.
    7. Determine se você deseja conectar eventos diretamente à instância ITOM ou por meio de um MID Server.

      • Para enviar eventos diretamente para a instância ITOM, selecione Diretamente para a instância do ITOM.

      • Para enviar eventos por meio de um MID Server, que processa e passa o evento para a instância, selecione Via MID Server.

        Se houver um MID Server, no campo Selecionar MID Server, selecione um MID Server disponível conectado a um ouvinte de eventos.

        Se você precisar criar um MID Server, selecione uma das seguintes opções.
        • Configurar extensão do servidor web MID
        • Configurar o contexto do coletor de eventos do servidor web MID
        Para obter mais informações, consulte Configurar a extensão MID Web Server e Configurar o Contexto do coletor de eventos de MID Web Server.
    8. Selecione Avançar.
      Método de entrada do conector personalizado
    9. Na página Configurar método de entrada, selecione um método para coletar dados de eventos.
      MétodoDescrição
      Reúna eventos de origem reais para definir campos
      1. Selecione Reunir eventos de origem reais para definir campos.
        Nota:
        Ao coletar eventos de origem real do seu conector personalizado, você aumenta a precisão dos eventos e alertas usando vários eventos como referência para definir os campos.
      2. Selecione Copiar para área de transferência e copie a URL.
      3. Cole o URL na configuração de webhook do conector personalizado para criar um webhook que permite que o conector personalizado envie eventos para a instância ServiceNow. Insira suas credenciais de autenticação básica na configuração do webhook do sistema de monitoramento (como o nome de usuário e a senha). O webhook permite que o conector personalizado envie eventos para a instância.
      4. Selecione Verificar eventos. O número de eventos é exibido. O evento cria arquivos JSON que você pode navegar depois de selecionar Avançar.
      Usar uma amostra JSON para mapear campos
      1. Selecione Usar uma amostra JSON para mapear campos.
        Nota:
        Somente se você tiver um JSON de amostra, selecione esta opção.
      2. Na caixa de diálogo Inserir carga útil, copie e cole a carga de amostra JSON para criar e exibir o mapeamento para mapear os campos.
        Carregamento de carga JSON do conector personalizado
      3. Selecione Carregar JSON.
      4. Selecione Editar ou colar novo JSON para editar o JSON que você carregou ou colar um novo.
      5. Selecione Copiar para área de transferência e copie a URL.
      6. Cole o URL na configuração de webhook do conector personalizado para criar um webhook que permite que o conector personalizado envie eventos para a instância ServiceNow. Insira suas credenciais de autenticação básica na configuração do webhook do sistema de monitoramento (como o nome de usuário e a senha). O webhook permite que o conector personalizado envie eventos para a instância.
    10. Selecione Avançar.
      A página é aberta e você pode mapear campos.
      Página de opção de mapeamento do campo do conector personalizado.
    11. Na página Mapear campos, na coluna Nomes de campo do conector, insira pelo menos um valor que seja mapeado para os valores de gravidade listados na coluna Campo de ServiceNow gravidade.
    12. Na página Mapear campos, na coluna Nomes de campo do conector, insira pelo menos um valor que seja mapeado para os valores de gravidade listados na coluna Campo de ServiceNow gravidade.

      Você pode inserir o valor de severidade da amostra de código JSON. Para definir um valor de severidade, você deve estar familiarizado com a carga do conector personalizado e os tipos de severidade aos quais ele oferece suporte. Os valores de severidade dos eventos recebidos devem corresponder aos eventos gerados em seu sistema.

      Habilite o sistema a criar eventos corretamente a partir dos dados de entrada, mapeando os campos na amostra de código JSON para os campos ServiceNow. As informações de Severidade e Chave de mensagem são preenchidas automaticamente para poupar tempo e esforço. A chave Mensagem fornece o identificador correto para os eventos, garantindo que a desduplicação funcione corretamente e que alertas redundantes não sejam gerados.

    13. Opcional: Para exibir vários arquivos JSON, selecione a seta acima da amostra JSON.
    14. Opcional: Na seção Outros campos, na coluna seu conector, especifique parâmetros de evento personalizados que são opcionais, mas fornecem informações adicionais sobre o evento.
      Se você optar por não fornecer as informações opcionais, deixe o campo em branco.
      1. No campo Descrição, insira uma descrição de alerta significativa.
      2. No campo Nome da métrica, insira um nome de métrica que permita associar eventos às métricas de desempenho ou KPIs que acionaram o alerta.
      3. No campo Nó, insira um valor de nó a ser usado para vinculação de IC.
      4. No campo Hora do evento, insira a hora de criação do evento do conector personalizado.
        Se a hora do evento não estiver mapeada, o sistema usará a hora do evento padrão.
      5. No campo Configurações de hora do evento, selecione o formato de hora e o fuso horário do evento.
        • Formato de hora: um campo GlideDateTime no formato UTC ou GMT, com tamanho máximo de 40 caracteres.
        • Fuso horário: os horários são armazenados no Tempo Universal Coordenado (UTC) e exibidos globalmente com base no fuso horário do sistema.
    15. Ative e salve o conector selecionando Ativar e OK na janela pop-up de confirmação.
      Você pode exibir os detalhes do conector na guia Detalhes e os mapeamentos de campo na guia Mapeamento de campos.

    Resultado

    Depois que o conector é ativado, os eventos começam a fluir do console do conector personalizado para a instância ServiceNow. O plug-in extrai informações da mensagem de evento do conector personalizado original para preencher os campos de evento obrigatórios e insere o evento no banco de dados. Para ver os eventos em sua instância Now Platform, navegue até Todos Eventos. Para obter mais informações, consulte Exibir eventos.

    O que Fazer Depois

    Para verificar se o processo foi concluído com sucesso e se os eventos estão fluindo para o sistema, exiba os eventos relacionados na guia Eventos relacionados. Se a configuração for bem-sucedida, prossiga para Adicionar automação para estabelecer uma automação de alerta. Para obter informações sobre automação de alertas, consulte Automação de alerta em Espaço de operações de serviços para ITOM.