# Resumo Coletor
# Versão 1
# DESCRIÇÃO
A documentação de usuário do Resumo do Coletor tem como objetivo detalhar o funcionamento da consulta retornada pelo coletor. Este sistema permite que os usuários visualizem, analisem e gerenciem informações referentes aos livros coletados e aos processos associados.
# FINALIDADE
Esta funcionalidade, fornece detalhes sobre os envios e retornos dos livros para coleta de leitura. Exibe informações como UC, especificação, 1ª leitura, mensagem leiturista, data e hora da leitura, releitura (se aplicável), mensagem de releitura, data e hora da releitura, data e código da situação, descrição da situação, tipo de envio, situação plurimensal e se o livro foi incluído no faturamento. Abaixo podemos acompanhar os principais caminhos de acesso.
# PRINCIPAIS CAMINHOS
Login ou acesso ao sistema > Página Inicial > Workspace de Medição > No menu de navegação selecione o item Resumo Coletor > Tela Resumo Coletor
# FUNCIONALIDADES
# Filtro do Usuário
Ao abrir a aplicação Resumo do Coletor, a primeira seção disponível será o Filtro do Usuário. O Filtro do Usuário é alimentado pela aplicação Usuários, na qual são cadastrados os parâmetros para definir o que cada usuário pode filtrar na seção Filtro do Usuário. O filtro padrão de usuário possui 5 campos, sendo eles: empresa, regional, distrital, seccional e localidade.
- Empresa: campo parametrizado com os dados da empresa 0001 – Sonda.
- Regional: campo de seleção de regionais
- Distrital: campo de seleção de distritais
- Seccional: campo de seleção de seccionais
- Localidade: campo de seleção de localidades
# Busca
Nesta seção, você pode buscar livros, irregularidades e livros não enviados, além de deletar o histórico, utilizando os campos "Etapa" e "Referência". Ambos os campos são obrigatórios para realizar a busca.
# Campos de Busca
Etapa: Selecione a etapa desejada na lista que será exibida; Referência: Informe a data de referência.
# Botões de Ação
Buscar: Após inserir os campos obrigatórios, clique no botão Buscar. O sistema identificará se existem dados para essa busca e, em caso positivo, carregará a lista de livros, irregularidades e livros não enviados. Em caso negativo, será exibida uma mensagem informando que não há resultados para a busca realizada.
Limpar: Clique no botão Limpar para resetar todos os campos e iniciar uma nova busca.
# Deletar Histórico
O limpar histórico permite ao usuário deletar registros históricos do coletor a partir da referência e do parâmetro utilizado.
Após realizar uma busca por etapa e referência o botão “Deletar Histórico” ficará habilitado.
Ao clicar em “Deletar Histórico” a janela limpar histórico do coletor será apresentada.
Na tela encontra- se a seguinte estrutura:
- Mensagem informativa: Indica a importância/atenção que a ação irá resultar.
- Data de Referência: data carregada automaticamente da tela de busca anterior. Se necessário, altere a data de referência a partir da qual os históricos serão deletados. Este campo é de preenchimento obrigatório.
- Parâmetro do coletor: O campo "Parâmetro do Coletor" estará preenchido automaticamente e é apenas de leitura, indicando que o histórico dos últimos 12 meses antes da data de referência será limpo.
# Botões da janela Limpar Histórico do Coletor
Ao clicar no botão “Cancelar” é retornado para tela anterior do resumo do coletor;
Ao clicar no botão “Confirmar” é exibido uma caixa de diálogo/alerta para confirmar a exclusão;
# Fechar
Fecha a mensagem e retorna à tela principal do resumo do coletor.
# Caixa de Diálogo de Confirmação
Ao clicar no botão “Cancelar” retorna para tela anterior de “Limpar Histórico do Coletor;
Ao continuar a exclusão clicando no botão “Confirmar” é exibido uma nova caixa de dialógo com uma mensagem de sucesso.
Para retornar a tela anterior clique em “Fechar”
# Fechar
Fecha a mensagem e retorna à tela principal do resumo do coletor.
# Livros
- Sem livros disponíveis para exibição
Se, após preencher todos os campos obrigatórios e clicar no botão "Buscar", não houver livros que correspondam aos critérios fornecidos, o sistema exibirá uma mensagem indicando que nenhum livro foi encontrado para os valores inseridos.
- Livros Encontrados Após clicar no botão “Buscar”, o sistema carregará e exibirá os livros que correspondem à etapa e referência informadas. A seção "Livros" oferece duas opções de visualização:
Todos os Livros da Etapa e Referência Aqui, você pode visualizar todos os livros registrados para a etapa e o mês/ano especificados.
Livros com Diferenças
Esta opção destaca livros que apresentam discrepâncias entre as quantidades de envio, retorno e gravação de espelho.
A tabela de resultados inclui os seguintes dados para cada livro: número do livro, localidade, data de envio, data retorno, data gravação de espelho, quantidade gerado, quantidade enviado, quantidade retornado, quantidade em espelho, envio simultâneo, faturados onsite, faturados online e situação.
Para cada livro listado, você pode realizar as seguintes ações: releitura, detalhes, consultar resumo coletor.
# Ações - Livro
Para cada livro encontrado existe algumas ações que podem ser executadas, são elas:
- Releitura
- Selecione o Livro: Clique no livro desejado para selecioná-lo.
- Acesse as Ações: Clique no botão "Ações".
- Escolha Releitura: Selecione a opção "Releitura" no menu.
- Uma janela será exibida com os seguintes dados para consulta: data e hora do envio, quantidade de envio, data e hora do retorno, quantidade de retorno, data e hora da gravação do espelho e quantidade em espelho.
# Fechar
Fecha a mensagem e retorna à tela principal do resumo do coletor.
- Detalhes
- Selecione o Livro: Clique no livro desejado para selecioná-lo.
- Acesse as Ações: Clique no botão "Ações".
- Escolha Detalhes: Selecione a opção "Detalhes" no menu.
- Uma janela será exibida com os seguintes dados para consulta: data e hora ressequência, usuário, leiturista, data leitura, hora início, hora fim, usuário envio, usuário retorno, usuário gravação espelho, data da última atualização, empresa e prestadora.
# Fechar
Fecha a mensagem e retorna à tela principal do resumo do coletor.
- Consultar Resumo Coletor
- Dados Gerais
Ao selecionar a opção “Consultar Resumo Coletor” para o livro desejado, a tela exibirá os dados detalhados do livro. A primeira seção apresentada é "Dados Gerais", que inclui um resumo das informações da tela anterior de busca.
Dados Gerais inclui:
- Empresa: Empresa filtrada.
- Etapa: Etapa atual associada ao livro.
- Referência: Referência específica do livro.
- Livro Selecionado: Número do livro selecionado.
Seção fixa para todas as abas descritas abaixo.
# Navegação entre Abas
Leituras: Exibe informações sobre as leituras registradas.
Motivos: Fornece uma tabela com os motivos associados ao livro.
UCs Não Enviadas: Lista as Unidades Consumidoras (UCs) que não foram enviadas.
Log Alteração: Mostra o histórico de alterações realizadas.
Integração: Detalha os dados de integração.
Log Online: Exibe operações realizadas online.
Leituras
Ao selecionar “Consultar Resumo Coletor”, a primeira aba exibida será a aba “Leituras”. Nesta seção, você encontrará uma lista de leituras, além de dados detalhados para cada item selecionado.
Na lista de leituras, são exibidos os seguintes dados para cada item listado: UC, especificação, 1ª leitura, mensagem leiturista, data leitura, hora leitura, releitura, mensagem releitura, data releitura, hora releitura, data situação, código situação, situação, tipo envio, situação plurimensal e fat. Sim. Para visualizar detalhes adicionais de um item, selecione o item desejado na tabela.
Ao selecionar a leitura desejada o sistema preencherá e exibirá os dados dos seguintes campos: data origem, tipo origem, origem, tipo UC, DOP, latitude, longitude, sequência, nova sequência, mensagem auxiliar, leitura obrigatória, motivo obrigatório, foto leitura, foto releitura, texto livre e texto releitura.
Caso possua fotos associados é necessário clicar no botão para exibir a janela contendo a foto respectiva.
- Motivos
Ao selecionar a aba "Motivos", a tela exibirá uma tabela com a seguinte estrutura de dados: unidade consumidora (UC) e motivo.
Nesta seção, você encontrará todas as mensagens que explicam os motivos pelos quais a UC foi rejeitada durante o processo de faturamento simultâneo.
- UCs não enviadas
Ao selecionar a aba de “UCs não enviadas”, a tela exibirá uma tabela com informações sobre as Unidades Consumidoras que estão dentro do livro e não foram enviadas para o coletor. A tabela contém lista: UC, situação, situação espelho e data situação.
- Logs Alteração
Ao selecionar a aba “Log Alteração”, a tela exibirá uma tabela com os seguintes dados para cada log listado: situação atual, situação anterior, data da situação, módulo, quantidade de leitura enviada, quantidade de leitura retirada, usuário inclusão, data de inclusão e descrição de alteração.
- Integração
Ao selecionar a aba “Integração”, a tela exibirá duas seções:
# Interface
Na seção "Interface", será exibida uma tabela contendo os seguintes dados: situação, data da situação, usuário situação, número tentativa de retorno, data inclusão, usuário inclusão, sequência da tarefa e situação origem.
Para cada item listado na tabela, você tem as seguintes opções de ação:
Consultar XML: Para consultar o XML, selecione o item de interface desejado e clique na opção “Ações”. Em seguida, escolha a opção “Consultar XML”.
Reprocessar: Para reprocessar um item, selecione o item desejado e clique na opção “Ações”. Em seguida, escolha a opção “Reprocessar”. Uma janela será exibida solicitando uma justificativa ou observação para o reprocessamento. Após preencher a justificativa, clique no botão “Confirmar”. Em seguida, será exibida uma janela de confirmação; selecione “Confirmar” para prosseguir. Após a confirmação, uma mensagem de sucesso será exibida, confirmando que o reprocessamento foi efetuado com sucesso.
# Erros Faturamento
Nesta seção são listados os erros de faturamento. As informações apresentadas são: UC, número do livro, data de ocorrência, descrição da ocorrência, leitura atual, código da mensagem, e impressão.
- Log Online
Ao selecionar a aba “Log Online”, a tela exibirá uma tabela com a lista de logs online. A tabela conterá os seguintes dados: UC, mês de referência, etapa, parâmetros de entrada, resultado e data.
# Irregularidades
- Sem Irregularidades disponíveis para exibição
Se, após preencher todos os campos obrigatórios e clicar no botão "Buscar", não houver irregularidades que correspondam aos critérios fornecidos, o sistema exibirá uma mensagem indicando que não há irregularidades para serem exibidas.
- Irregularidades encontrada
Após clicar no botão “Buscar”, o sistema carregará e exibirá as irregularidades que correspondem à etapa e referência informadas. A seção "Irregularidades" apresenta os seguintes dados para consulta: número do livro, localidade, UC, data, mensagem leitura, mensagem releitura e texto do livro enviado no coletor.
# Livros não enviados
- Sem Livros não enviados para exibição
Se, após preencher todos os campos obrigatórios e clicar no botão "Buscar", não houver livros não enviados, o sistema exibirá uma mensagem informando que não há livros não enviados para exibição.
- Livros não enviados encontrados
Nesta seção são apresentados os livros que foram selecionados para envio, mas que por algum motivo não foram enviados.
Após clicar no botão “Buscar”, o sistema carregará e exibirá a lista de livros não enviados. A seção "Livros Não Enviados" fornece os seguintes dados para consulta: número do livro, localidade, UC, data, mensagem leitura, mensagem releitura e texto do livro enviado no coletor.
# Relatórios
Nesta seção, você pode gerar e imprimir relatórios de irregularidades e efetividade.
# Como Gerar Relatórios
Para gerar o relatório, siga as etapas abaixo:
# Selecione o tipo de relatório que deseja gerar:
- Irregularidades: Relatório que detalha todas as irregularidades encontradas durante a leitura.
- Efetividade: Relatório de efetividade.
# Clique no botão Imprimir:
- Após selecionar o tipo de relatório, clique no botão Imprimir.
# Visualize ou Imprima o Relatório:
- O relatório será gerado e você poderá visualizá-lo ou imprimi-lo conforme necessário.
# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
Foto Leitura e Releitura: Ao clicar no botão "Leitura" ou "Releitura", uma janela será exibida mostrando a foto associada com data e nome relacionados. Se o botão estiver ativo, indica que a foto está disponível para visualização. Se estiver inativo, a foto não foi registrada ou não está disponível.
Consultar Registro UC XML: Para consultar o XML da UC, selecione a UC desejada na aba "Leituras" da tela exibida após a seleção do livro (Consultar Resumo Coletor).
Consultar XML Interface: Para consultar o XML, selecione a interface desejada na aba "Integração".
Reprocessar Interface: Na aba de Integração da tela de Consulta Detalhada do Resumo do Coletor, exibida após a seleção do livro, você pode:
- Selecionar a Interface Desejada: Escolha a interface que deseja reprocessar.
- Ações: Clique no botão "Ações" e selecione a opção "Reprocessar".
- Inserir Justificativa: Será exibida uma janela solicitando a justificativa para o reprocessamento. Preencha o campo com a justificativa adequada.
- Confirmar Reprocessamento: Após preencher a justificativa, clique em "Confirmar". Uma nova janela de confirmação será exibida para revisar a ação.
- Efetuar Reprocessamento: Ao confirmar na janela de confirmação, o reprocessamento será efetuado.
Filtro Lógico: Ao clicar na opção "Filtro Lógico" exibida nas tabelas de dados, você pode aplicar filtros para refinar a visualização das informações. Esta ferramenta permite selecionar e exibir apenas os dados que atendem a critérios específicos definidos por você.
Alternar entre Irregularidades e Livros não Enviados: Na seção localizada logo após a lista de livros, você pode alternar entre a visualização de irregularidades e livros não enviados. Para isso, clique na opção desejada para exibir as informações correspondentes.
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante a consulta Resumo Coletor:
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Medição | Realizar filtros de Usuário |
| Buscar por Etapa e Referência | |
| Gerar Relatório de Irregularidades e Efetividade | |
| Consultar Livros | |
| Consultar Irregularidades e Livros não enviados | |
| Consultar detalhes de releitura | |
| Consultar detalhes do livro | |
| Consultar resumo de cada livro | |
| Visualizar seções de: leituras, motivo, ucs não enviadas, logs alteração, integração e log online | |
| Visualizar foto de leitura e releitura | |
| Consultar XML | |
| Reprocessar XML do livro | |
| Deletar Histórico | |
| Limpar Busca |
# TECLAS DE ATALHO
# [Mapeamento das teclas de atalhos utilizados na funcionalidade]
| AÇÃO/FUNÇÃO | PORTUGÊS | INGLÊS | ESPANHOL |
|---|---|---|---|
# RELATÓRIO DE INCIDÊNCIAS
Seção destinada a resolução de problemas e erros que podem ocorrer e como pode ser solucionado.
| PROBLEMA | CAUSA | SOLUÇÃO |
|---|---|---|
# DOCUMENTOS RELACIONADOS
| TÍTULO | VERSÃO | LINK |
|---|---|---|
| Resumo Coletor | 1° | - |
# CANAIS DE SUPORTE
# Fale com a gente e tire suas dúvidas!
Email: <Variáveis parametrizáveis a serem definidas>
Telefone: <Variáveis parametrizáveis a serem definidas>
Área Responsável: <Variáveis parametrizáveis a serem definidas>