O relatório de documentos do Zenvia Docs permite o acompanhamento do processo de geração de documentos dentro da ferramenta, dando visibilidade das solicitações feitas, dos documentos gerados e de erros ocorridos durante o fluxo. O relatório é atualizado em D-1. Para acessá-lo, no menu lateral esquerdo, clique em Análises > Documentos.

Além disso, dentro do relatório é possível configurar alertas de entregabilidade via e-mail. Por exemplo, você pode configurar um alerta para receber notificações quando a taxa de erro for maior que 2%. Com isso, você é alertado sobre qualquer problema e nossa equipe interna pode tomar as ações necessárias e reduzir o impacto de erros em suas operações.

Neste artigo, veja como usar o relatório e criar alertas personalizados.

Como usar o relatório

Para começar:

1. Filtre o intervalo que deseja visualizar, ou seja, o período de tempo dos documentos gerados;
2. Se optar por comparar com outro intervalo de tempo de geração de documentos, selecione o período na caixa Comparação;
3. Aplique os filtros para gerar os dados.

A seguir, confira quais são os dados gerados no relatório e como interpretá-los.

Métricas do relatório de documentos

O relatório está estruturado em três partes, cada uma delas contendo métricas que facilitam o acompanhamento dos dados relacionados ao processo de geração de documentos.

Visão geral sobre geração de documentos

Aqui são exibidas as seguintes informações:

• O número de documentos solicitados e modelos utilizados. Um modelo é a máscara do documento, semelhante a um layout. Por exemplo, é possível solicitar até 100 documentos, todos seguindo o mesmo modelo, como uma fatura;
• O número e a taxa de documentos gerados com sucesso;
• O número de documentos não gerados e a taxa desses documentos não gerados com erros;
• Tempo médio de geração de documentos e o número médio de documentos por contato.

Geração de documentos por pedido

Exibe o desempenho do processo de geração por dia, considerando o primeiro intervalo de tempo selecionado no filtro.

Esse gráfico não exibe uma comparação com outro período de tempo. Apenas compara a quantidade de documentos solicitados, gerados e não gerados.

• Solicitados: é o total de documentos pedidos para geração;
• Gerados: é o total de documentos produzidos com sucesso;
• Não gerados: é o total de documentos que não foram produzidos devido a um erro.

Logo abaixo, a tabela mostra pedidos de documentos e o quantitativo do respectivo desempenho, ou seja, quantos documentos foram solicitados, gerados e não gerados naquele lote específico.

⚠️ Atenção: Um pedido representa a solicitação feita ao sistema em relação a um conjunto de documentos. Cada pedido é identificado por um campo chamado lote. Se você não especificou um número de lote ao fazer a solicitação para gerar os documentos, o sistema preencherá automaticamente esse campo com o valor padrão 00001. Nesse caso, para identificar o pedido, é recomendável que você consulte a data que corresponde à mesma data registrada no campo de solicitação.

💡 Dica: Os gráficos detalhados acima são interativos. Basta mover o cursor do mouse sobre eles para ver informações detalhadas. Para habilitar ou desabilitar as linhas do gráfico, além de ter outras formas de visualização do gráfico, clique nos botões: Solicitados, Gerados e Não Gerados. 

Erros mais comuns

O gráfico de barras exibe seis erros mais comuns com a respectiva quantidade e frequência de cada um.

É possível visualizar os erros de um único intervalo de tempo ou fazer a comparação com outro período. Basta selecionar o período de comparação no filtro para que o gráfico exiba os dados de cada um.

• Confira os erros mais comuns do processo de geração de documentos:
• Connection key missed: Campo connection key da API de geração de documentos não inserido corretamente;
• Fatal on Export: Erro interno;
• An error occurred while trying to generate a document: Erro interno, é necessário verificar com o suporte;
• Loading Sourcefile: Arquivo não encontrado;
• Assembling Dataset: Modelo de dados incorreto;
• Erro numérico: Erro interno.

Alertas

Alertas são notificações enviadas quando uma determinada condição é identificada. Criar alertas possibilita monitorar o desempenho na geração de documentos de forma automatizada. Para isso, clique em Alertas, no canto superior direito.

Para receber notificações diretamente por e-mail, basta inserir o seu endereço de e-mail no campo designado. Se desejar que outras pessoas também recebam esses alertas, adicione os endereços de e-mail separados por ponto e vírgula.

As condições estabelecem os critérios para que o alerta seja acionado e enviado a você. Os alertas podem ser acionados quando há uma anomalia na taxa de:

• Erros: esse alerta monitora a frequência de erros na geração de documentos. Você tem a opção de configurar um alerta para ser notificado quando uma certa irregularidade ocorrer, por exemplo, quando a taxa de erros for igual ou maior que 2%.
• Geração: esse alerta monitora documentos gerados com sucesso em relação à quantidade solicitada.

Pronto! Com essas métricas você consegue acompanhar o processo de geração e entregas dos seus documentos.