# Desfaz Cálculo do Faturamento
# Versão 1
# DESCRIÇÃO
A aplicação permite desfazer o cálculo e geração da fatura para os livros de leitura e unidades consumidoras que estiverem selecionados. Este processo quando realizado com sucesso devolverá o livro de leitura ou a unidade de consumo para situação ‘CR’ Liberado para faturamento.
# FINALIDADE
A aplicação permite desfazer o cálculo de faturamento de unidades consumidoras (UCs), com base nos critérios selecionados pelo usuário. O processo pode ser realizado para uma UC individual, para um conjunto de UCs específicas, ou até mesmo para um livro ou etapa inteira, desde que esses itens estejam aptos e em espelho. Após inserir os critérios e concluir o processo, as UCs selecionadas terão o cálculo de faturamento desfeito, retornando ao status de "Liberado para faturamento", o que possibilita a reexecução do cálculo ou ajustes necessários.
# PRINCIPAIS CAMINHOS
Login ou acesso ao sistema > Página Inicial > Workspace de Faturamento > Desfaz Cálculo do Faturamento.
# FUNCIONALIDADES
Ao acessar o item de menu Desfaz Cálculo do Faturamento, o usuário será direcionado para a tela abaixo, onde estão disponíveis todas as funcionalidades relacionadas. Para facilitar o entendimento, a tela será detalhada em seções, com explicações específicas sobre cada uma das suas funções.
# Estrutura da Tela
A tela é dividida em duas áreas principais:
Filtro do Usuário: Nesta seção, você pode aplicar filtros para segmentar as informações de acordo com os parâmetros definidos para o usuário.
Critérios: Nesta seção, você pode definir os critérios para desfazer o cálculo do faturamento seja de uma unidade consumidora específica ou por mais de uma unidade consumidora simultaneamente pelos campos livro ou etapa e referência específica, permitindo ainda delimitar o processo pelos filtros de categoria, Subcategoria, Situação e Grupo de Consumo. Para este procedimento é necessário informar no mínimo os campos Referência e Etapa.
Lista: A seção Lista tem como objetivo exibir e organizar as Unidades Consumidoras (UCs) selecionadas para desfazer o cálculo do faturamento. Após inserir uma UC válida e adicioná-la, ela é listada nessa área junto com informações como o nome do cliente associado, situação do processamento será preenchida após executar o processamento para desfazer o cálculo indicando o status atualizado de cada Unidade Consumidora (UC) processada. Essa seção permite ao usuário visualizar as UCs incluídas para desfazer o cálculo de forma clara e organizada, aplicar filtros específicos para refinar a seleção conforme necessário e revisar a quantidade de UCs que serão processadas, garantindo que apenas as UCs corretas estejam na lista antes de salvar a ação. Ao adicionar as UCs aptas, o usuário poderá desfazer o cálculo.
# 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: Este campo permite filtrar as informações de acordo com a regional. Digite o nome da regional ou selecione uma opção na lista suspensa para facilitar a escolha.
Distrital: Este campo permite especificar a distrital desejada para o filtro. Você pode digitar o nome da distrital ou escolher diretamente na lista exibida.
Seccional: Utilize este campo para escolher a seccional. Basta digitar o nome da seccional para visualizar sugestões automáticas ou selecionar uma opção na lista.
Localidade: Este campo permite filtrar as informações por localidade específica. Digite o nome da localidade no campo de busca para ver as sugestões ou selecione diretamente da lista.
O Filtro do Usuário fica oculto por padrão, sendo exibido apenas quando o usuário decide expandi-lo.
Ao clicar para abrir, todos os campos mencionados ficam visíveis, permitindo que o usuário aplique os filtros desejados. Para economizar espaço na tela, o filtro pode ser recolhido novamente, ficando oculto até que o usuário precise usá-lo.
# Critérios
Esta seção permite desfazer o cálculo do faturamento com base nos dados informados. Abaixo, descreveremos o funcionamento dos campos principais e o processo para desfazer o cálculo do faturamento de acordo com cada cenário/possibilidades.
A seção de critérios conta com os seguintes campos:
UC: Insira um número de UC válido, apto para reverter o cálculo de faturamento. Neste campo posso realizar o cálculo do faturamento de uma Unidade consumidora especifica individualmente.
Cliente: Este campo será preenchido automaticamente com o nome do cliente associado a essa UC.
Livro: Informe o código de um livro cadastrado no sistema, correspondente ao registro desejado para desfazer o cálculo. Ao tentarmos desfazer o cálculo de faturamento pelo código do livro, devemos informar no mínimo os campos de ‘Referência’ e ‘Etapa’ desejado, sendo campos obrigatórios.
Etapa: Selecione a etapa apropriada a partir das opções disponíveis. Código da etapa, se refere a lotes definidos para o calendário, possuindo uma data limite de faturamento, possibilita desfazer um processo de cálculo de faturamento da etapa inteira.
Referência: Utilize o calendário para selecionar a data de maneira precisa.
Categoria: Selecione o tipo de categoria da unidade consumidora.
Subcategoria: Ao selecionar a categoria o campo de subcategoria será habilitado para selecionar a subcategoria relacionada.
Situação: Selecione a situação de processamento da unidade consumidora.
Grupo de Consumo: Selecione o grupo de consumo da unidade consumidora. Este campo é preenchido automaticamente ao selecionar o campo Etapa.
# Desfaz Cálculo por UC
Para desfazer o cálculo do faturamento para uma UC específica individualmente, é necessário preencher os seguintes campos obrigatórios:
UC: Digite o número da unidade consumidora.
- Ao inserir o número da UC e clicar fora do campo, o sistema carregará automaticamente os dados.
O sistema verifica se a UC está em situação de espelho e se sua condição é válida para o processamento. Caso a UC não esteja em espelho ou sua situação de processamento seja inválida, o sistema exibirá alertas com as respectivas mensagens.
UC Apta e em Espelho:
Todos os outros campos relacionados, como nome cliente, livro, etapa, referência, categoria, subcategoria, situação e grupo de consumo, são preenchidos automaticamente com base nos dados cadastrados para a UC. Esses campos ficarão bloqueados para edição manual, garantindo que as informações reflitam fielmente o cadastro da unidade.
Após preencher a UC e o sistema encontrar os dados relacionados, clique no botão “Salvar”. Em seguida, será exibida uma caixa de diálogo de confirmação para desfazer o cálculo do faturamento, com as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e o processo de desfaturamento da UC selecionada não será efetuado.
Confirmar: Se optar por "Confirmar", a UC será descalculada com sucesso.
- Após a confirmação, uma nova caixa de diálogo será exibida, informando: "UCs descalculadas com sucesso". Com o descálculo efetuado devolverá o livro de leitura ou a unidade de consumo para situação ‘CR’ Liberado para faturamento.
- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de desfaz cálculo do faturamento, com os campos vazios, pronto para um novo desfaturamento, caso necessário.
# Desfaz Cálculo para Múltiplas Unidades Consumidoras
Ao realizar o descálculo por Livro ou Etapa, o sistema permite desfazer o cálculo do faturamento para várias Unidades Consumidoras (UCs) simultaneamente. Para isso, utilize os campos principais de Livro ou Etapa e Referência como critérios de seleção.
Descálculo por Livro: Preencha o campo Livro e, obrigatoriamente, os campos Etapa e Referência para delimitar o descálculo às UCs do livro especificado em uma etapa e período específicos.
- Descálculo por Etapa: Informe a Etapa e a Referência (mês e ano). Neste caso, o campo Livro é opcional.
Para refinar ainda mais o processo, é possível utilizar filtros adicionais, como Categoria, Subcategoria, Situação e Grupo de Consumo. Ao fornecer os dados, o sistema valida as informações e, caso sejam válidas, inicia o processamento do desfaturamento.
Caso algum campo obrigatório não seja preenchido, ele será exibido em estado de erro, indicando que seu preenchimento é necessário. Nessa situação, o botão Salvar será desativado, impedindo a continuação do processo até que todos os campos obrigatórios sejam devidamente preenchidos.
Após preencher os campos obrigatórios, clique no botão “Salvar”. Em seguida, será exibida uma caixa de diálogo de confirmação para desfazer o cálculo do faturamento, com as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e o processo de desfaturamento da UC selecionada não será efetuado.
Confirmar: Se optar por "Confirmar", a UC será descalculada com sucesso.
- Após a confirmação, uma nova caixa de diálogo será exibida, informando: "UC descalculada com sucesso". Com o descálculo efetuado devolverá o livro de leitura ou a unidade de consumo para situação ‘CR’ Liberado para faturamento.
- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de desfaz cálculo do faturamento, com os campos vazios, pronto para um novo desfaturamento, caso necessário.
# Lista
A seção Lista permite que você selecione e visualize Unidades Consumidoras (UCs) cujos cálculos de faturamento devem ser desfeitos. Através de filtros específicos, você pode localizar as UCs de forma rápida e precisa, para garantir que apenas as UCs desejadas sejam desmarcadas para cálculo.
Para realizar o desfaturamento de UCs na seção Lista, comece inserindo o código identificador da Unidade Consumidora no campo UC.
- Assim que uma UC é inserida, o sistema automaticamente preenche o campo Cliente com o nome correspondente ao titular dessa UC. Dessa forma, você confirma visualmente que a UC está associada ao cliente correto.
Ao clicar em Adicionar, o sistema verifica se a UC possui uma situação de processamento válida e se está marcada como "em espelho".
Caso a UC atenda aos critérios, ela será adicionada com sucesso à lista de UCs a serem desfaturadas.
Ao ser adicionada, o total de UCs para desfaturamento é automaticamente atualizado e exibido na parte inferior, permitindo que você acompanhe a quantidade de unidades consumidoras incluídas no processo.
- Se a UC não atender a um desses critérios, o sistema exibirá mensagens de alerta informando o motivo e impedirá sua inclusão na lista, garantindo que apenas UCs elegíveis sejam processadas.
- Observe que, nesse momento, a coluna Situação de Processamento ainda estará em branco, pois essa informação só será preenchida depois de salvar a ação de desfazer o cálculo.
Após adicionar uma UC à lista, você pode removê-la, caso necessário.
Para excluir uma ou mais UCs, selecione-as na lista, o que ativará o botão de Ações.
Clique em Ações e escolha a opção excluir. Uma caixa de diálogo será exibida para confirmação.
- Na caixa de diálogo, você terá as opções Cancelar e Confirmar:
- Ao selecionar Cancelar, a exclusão não será realizada, e a UC permanecerá na lista.
- Ao selecionar Confirmar, a UC será removida da lista com sucesso.
Após adicionar todas as UCs desejadas, clique em Salvar para confirmar a operação de desfazer o cálculo.
Em seguida, será exibida uma caixa de diálogo de confirmação para desfazer o cálculo do faturamento, com as opções "Cancelar" e "Confirmar".
- Cancelar: Se optar por "Cancelar", a ação será interrompida e o processo de desfaturamento da UC selecionada não será efetuado.
- Confirmar: Se optar por "Confirmar", a UC será descalculada com sucesso.
- Após a confirmação, uma nova caixa de diálogo será exibida, informando: "UC descalculadas com sucesso". Com o descálculo efetuado devolverá o livro de leitura ou a unidade de consumo para situação ‘CR’ Liberado para faturamento.
- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de desfaz cálculo do faturamento na seção de lista com a situação de processamento atualizada automaticamente após o desfaturamento e com a quantidade de UCs descalculadas.
# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
Navegação Tabela: Localizado no rodapé da tabela, o usuário pode selecionar o número de linhas a serem exibidas por página e navegar entre as páginas.
Botão Programar: O botão "Programa" é responsável por iniciar o desfaz cálculo do faturamento em segundo plano ele fica disponível na seção de critérios e habilitado após o preenchimento dos campos obrigatórios.
Botão Salvar: O botão “Salvar” é responsável por realizar o processo de desfaturamento do cálculo do faturamento em tempo real. Ao ser clicado, ele processa imediatamente os dados preenchidos e executa o desfaz cálculo de faturamento.
Adicionar Filtro: Ao clicar em "Adicionar Filtro" na seção de lista de UCs adicionadas, uma área adicional será exibida, permitindo a aplicação de filtros específicos, como a situação de processamento e outros critérios personalizados. Essa funcionalidade proporciona uma maneira eficiente de segmentar as UCs de acordo com características específicas.
Alternar - Critérios e Lista: A aplicação permite alternar entre os modos de seleção "Critérios" e "Lista" para desfazer o cálculo de faturamento. No modo "Critérios", você pode definir parâmetros específicos para selecionar uma UC individual ou até mesmo um livro ou etapa inteira. Já no modo "Lista", você pode escolher diretamente as UCs desejadas.
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante o Desfaz Cálculo do Faturamento.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Faturamento | Aplicar filtros para segmentar as informações de acordo com os parâmetros definidos para o usuário |
| Realizar o desfaz cálculo do faturamento por uma UC específica | |
| Realizar o desfaz cálculo para múltiplas UCs seja por livro ou etapa inteira. | |
| Realizar o desfaturamento através de uma lista de UCs selecionadas | |
| Realizar o desfaturamento de UCs em situação de processamento válida e em espelho | |
| Realizar a programação em background por etapa, livro e UC. | |
| Poderá excluir uma ou mais UCs incluídas na lista para o processamento | |
| Poderá visualizar a quantidade de itens adicionados na lista e o total de UCs descalculadas após o processamento |
# 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 | LINK |
|---|---|
| Desfaz Cálculo do Faturamento | - |