# Geração do Espelho de Faturamento
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Geração do Espelho de Faturamento tem como objetivo exemplificar o processo de geração do espelho. Ao executar a aplicação, o usuário poderá gerar o espelho online ou programar a geração do espelho em background.
# FINALIDADE
O objetivo desta aplicação é automatizar e facilitar o processo de geração dos espelhos de faturamento. Através dela, o usuário poderá gerar o 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 específicos como data de referência, etapa, livro, unidade consumidora 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 “Gerar Espelho de Faturamento”.
# FUNCIONALIDADES
Com estas funcionalidades, os usuários podem gerar o espelho de faturamento:
# Filtro do usuário
Ao abrir a aplicação Gerar 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
# Geração de Espelho de Faturamento
Nesta seção, é possível selecionar os dados da referência, etapa e livro, bem como inserir os dados de unidade consumidora e grupo de consumo que se deseja gerar o espelho.
- Referência: campo para selecionar o mês de referência
- Etapa: campo para selecionar a etapa do calendário de medição
- Livro: campo para selecionar o livro
- UC: campo para inserir o código da unidade consumidora
- Grupo de consumo: campo para inserir o código do grupo de consumo

# Gerar o espelho
Após incluir os dados necessários, será possível gerar o espelho de faturamento clicando no botão “Salvar”.
- Em seguida, uma janela será exibida para confirmar a geração do espelho.

- Ao clicar no botão “Confirmar”, uma caixa de diálogo será exibida informando que a geração foi efetuada com sucesso, incluindo a quantidade de UCs geradas e as com irregularidades.

# Programar em background
Este botão executa a aplicação ABPSOOBG para fazer a programação do background de 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.

# UC já faturada
Após clicar em “Salvar”, caso a UC já tenha sido faturada na referência selecionada, será exibida uma caixa de diálogo, alertando que a UC já está faturada.

# Não há relacionamento etapa x localidade
Após clicar em “Salvar”, caso não haja relacionamento entre a etapa e localidade, será exibida uma caixa de diálogo alertando que não existe relacionamento.

# UC com outra referência
Após clicar em “Salvar”, caso o livro possua UCs no espelho com outra referência, será exibida uma caixa de diálogo alertando que o livro tem UCs no espelho com outra referência.

# Referência menor ou igual ao último log
Após clicar em “Salvar”, caso a referência seja menor ou igual ao último log fechado do faturamento, será exibida uma caixa de diálogo, alertando que a referência é menor ou igual ao último log.

# Programação em background não permitida
Caso o usuário deseje fazer a programação em background da geração do espelho, mas tenha inserido os dados do livro e da unidade consumidora, será exibida uma caixa de diálogo alertando que a programação não é permitida para apenas um livro ou apenas uma UC.

# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante a geração de espelho de faturamento.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Atendente | Poderá gerar o espelho de faturamento de um livro ou unidade consumidora dentro de uma etapa e referência online |
| Poderá programar a 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 |
|---|---|---|
# DOCUMENTOS RELACIONADOS
| TÍTULO | VERSÃO | LINK |
|---|---|---|
| Barra de Atendimento | 1° | - |
| Cadastro de Senha | 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>