# Desfaz Geração do Espelho
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Desfaz Geração do Espelho de Faturamento tem como objetivo detalhar o processo de desfazer a geração do espelho. Ao executar a aplicação, o usuário poderá desfazer o espelho online ou programar para desfazer a geração do espelho em background.
# FINALIDADE
O objetivo desta aplicação é desfazer os espelhos de faturamento caso já tenham sido gerados, mas devido alguma alteração precisem ser desfeitos. Através dela, o usuário poderá desfazer a geração do espelho online ou agendar a geração dos espelhos de faturamento para ocorrer automaticamente em background. Para executar a ação, o usuário precisará inserir dados como o código da unidade consumidora, etapa, referência, livro e grupo de consumo.
Abaixo podemos acompanhar o caminho de acesso e o fluxo de cada validação feita pelo sistema ou definição feita pelo usuário.
# PRINCIPAIS CAMINHOS
Login ou acesso ao sistema > Página Inicial > Workspace de Medição > No menu de navegação selecione o item “Desfaz Geração do Espelho de Faturamento”.
# FUNCIONALIDADES
Com estas funcionalidades, os usuários podem desfazer a geração do espelho de faturamento:
# Filtro do usuário
Ao abrir a aplicação Desfaz Geração de Espelho de Faturamento, 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

# Desfaz Geração de Espelho de Faturamento
# Campos de preenchimento
Nesta seção, é possível selecionar os dados da referência, etapa e livro, bem como inserir os dados da unidade consumidora e do grupo de consumo cujo espelho se deseja desfazer. Os campos "etapa" e "referência" são de preenchimento obrigatório. Ao preencher o campo da unidade consumidora (UC), todos os outros dados são preenchidos automaticamente.
- UC: campo para inserir o código da unidade consumidora
- Etapa: campo para selecionar a etapa do calendário de medição
- Referência: campo para selecionar o mês de referência
- Livro: campo para selecionar o livro
- Grupo de consumo: campo para inserir o código do grupo de consumo
# Situações
O filtro de Situações permite ao usuário desfazer as UCs que estão em determinadas situações de espelho, sendo elas: irregular, regerado, gerado, digitado e corrigido. Além disso, é possível filtrar pelas UCs em todas as situações mostradas no filtro.
- Todos: filtra as UCs por todas as situações que estão no filtro
- Irregular: filtra pelas UCs na situação IR – fatura irregular
- Regerado: filtra pelas UCs na situação RG – regerado
- Gerado: filtra pelas UCs na situação GE – gerado
- Digitado: filtra pelas UCs na situação DG – digitado
- Corrigido: filtra pelas UCs na situação CR – corrigido

# Desfaz Geração do espelho
Após incluir os dados necessários e escolher a opção no filtro de Situações, será possível desfazer a geração do espelho de faturamento clicando no botão “Salvar”.

- Em seguida, uma janela será exibida para confirmar a ação.

- Ao clicar no botão “Confirmar”, uma caixa de diálogo será exibida informando que os espelhos foram desfeitos com sucesso, incluindo a quantidade de UCs desfeitas.

# Programar em background
Este botão executa a aplicação ABPSOOBG para fazer a programação do background de desfaz a geração do espelho. Caso o usuário queira fazer a programação em background, deve informar somente os campos de etapa e referência.

# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
# Campos de preenchimento obrigatório
Os campos de preenchimento obrigatório possuem um asterisco como indicação, conforme a instrução na seção dos campos.

# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante a geração de espelho de faturamento.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Medição | Poderá desfazer a geração do espelho de faturamento de um livro ou unidade consumidora dentro de uma etapa e referência online |
| Poderá programar o desfaz da geração do espelho de faturamento de uma etapa e referência em background |
# 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 |
|---|---|---|
# Cenários de exceção
# Não há espelhos na situação selecionada
Após clicar em “Salvar”, caso a UC não esteja dentro da situação escolhida no filtro de Situações, será exibida uma caixa de diálogo alertando que não há espelhos para serem desfeitos nesta situação.

# Situações impeditivas
Após clicar em “Salvar”, caso as UCs da referência, livro e etapa selecionados estejam com as seguintes situações no espelho, não poderão ser desfeitas:
- Situação FA – faturada Caso a UC não esteja nesta situação, será exibida uma caixa de diálogo alertando que a UC não pode ser desfeita.

- Situação IR – fatura irregular Caso a UC não esteja nesta situação, será exibida uma caixa de diálogo alertando que a UC não pode ser desfeita.

- Situação IC – irregularidade na checagem Caso a UC não esteja nesta situação, será exibida uma caixa de diálogo alertando que a UC não pode ser desfeita.

- Situação IS – irregular na consolidação Caso a UC não esteja nesta situação, será exibida uma caixa de diálogo alertando que a UC não pode ser desfeita.

- Situação NF – não faturar Caso a UC não esteja nesta situação, será exibida uma caixa de diálogo alertando que a UC não pode ser desfeita.

# UC não encontrada no espelho
Após clicar em “Salvar”, caso a UC não esteja presente no espelho, será exibida uma caixa de diálogo alertando que essa UC não pode ser desfeita pois não foi encontrada no espelho.

# DOCUMENTOS RELACIONADOS
| TÍTULO | VERSÃO | LINK |
|---|---|---|
| Desfaz Geração do Espelho de Faturamento | 1° | - |
| Programação em background | 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>