# Modelos de Calendário
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Modelos de Calendário tem como objetivo exemplificar o processo de cadastro e gerenciamento dos modelos. Ao executar a aplicação, o usuário poderá cadastrar, editar, excluir e copiar modelos de calendário.
# FINALIDADE
O objetivo desta aplicação é delinear como serão modelados os calendários de medição e faturamento, permitindo que o usuário defina a quantidade de eventos e configure como as datas devem se comportar de acordo com o tipo de dias e as alterações selecionadas. Nesta aplicação, o usuário poderá consultar calendários já cadastrados, criar um modelo de calendário, copiar modelos, além de editar ou excluir itens do calendário.
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 Planejamento > No menu de navegação selecione o item “Modelos de Calendário”.
# FUNCIONALIDADES
Com estas funcionalidades, os usuários podem consultar calendários já cadastrados, criar um modelo de calendário, copiar modelos, além de editar ou excluir itens do calendário.
# Consulta de Modelos de Calendário
Ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento.
Lista de Modelos de Calendário
A tabela lista os modelos e exibe alguns detalhes dos modelos de calendário cadastrados até o momento.
- Nome do modelo: exibe o nome do modelo;
- Sigla: exibe a sigla do modelo;
- Descrição: exibe a descrição do modelo;
- Usuário inclusão: exibe o usuário que cadastrou o modelo;
- Data Inclusão: exibe a data de cadastro do modelo;
- Observação: exibe quaisquer informações que tenham sido acrescentadas pelo usuário.

O usuário pode navegar pela lista e selecionar o calendário desejado. Para consultar o calendário, ele deve clicar no botão de ações e, em seguida, escolher a opção "Editar".

Após clicar na opção “Editar”, será aberta uma tela com todos os detalhes do modelo, como o nome do modelo, sigla, descrição, usuário de inclusão, data de inclusão e observações, além de uma tabela com os itens do modelo de calendário.

# Cadastro de novo modelo de calendário
Ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento, juntamente com um botão de cadastro chamado "Novo"

Ao clicar no botão "Novo", uma nova tela será aberta com os campos para preenchimento e um botão para a inclusão de novos itens de calendário.

Campos de preenchimento
Nesta seção, é possível inserir as informações nos campos "nome do modelo", "sigla do modelo", “descrição do modelo” e “observações”. Os campos “usuário inclusão” e “data inclusão” são automaticamente preenchidos pelo sistema.
- Nome do modelo: campo para digitar o nome do modelo;
- Sigla do modelo: campo para digitar a sigla do modelo;
- Descrição do modelo: campo para digitar a descrição do modelo;
- Observações: campo para digitar observações sobre o modelo;
- Usuário inclusão: campo preenchido com o nome do usuário que cadastrou ou cadastrará o modelo;
- Data inclusão: campo preenchido com a data do cadastro do novo modelo.
Após preencher os campos com os dados necessários, o usuário poderá adicionar novos itens ao calendário clicando no botão "Novo item"

Ao clicar no botão “Novo item”, será exibida uma tela para seleção e preenchimento dos itens do modelo de calendário. Depois de preencher os itens do modelo, o usuário poderá clicar em "Confirmar" para salvar essas informações no novo modelo de calendário.
Cadastro de itens do modelo
Nesta seção, é possível selecionar e inserir as informações nos campos "tipo de evento”, “evento”, “alteração da data”, “tipos de dias”, “qtd de dias”, “qtd mensal” e “evento padrão”.
- Tipo de evento: campo para selecionar o tipo de evento;
- Evento: campo para selecionar os subtipos de eventos;
- Alteração de data: campo para selecionar como será a alteração da data;
- Tipos de dias: campo para selecionar o tipo de dias;
- Qtd de dias: campo para digitar a quantidade de dias que o evento será executado a partir ou antes da data de leitura do livro;
- Qtd mensal: campo para digitar a quantidade de vezes que o evento ocorrerá no mês.

Depois de confirmar a inclusão de cada item, a tabela será preenchida com as informações inseridas, com uma nova linha adicionada para cada item incluído.

Para finalizar a ação, o usuário deve clicar em "Salvar" para cadastrar o novo modelo de calendário. Em seguida, será exibida uma janela de confirmação.

Ao clicar no botão “Confirmar”, uma caixa de diálogo será exibida informando que o calendário foi adicionado com sucesso.

# Edição do modelo de calendário
Ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento. O usuário pode navegar pela lista e selecionar o calendário desejado. Para editar o calendário, ele deve clicar no botão de ações e, em seguida, escolher a opção "Editar".

Após clicar na opção “Editar”, será aberta uma tela com todos os detalhes do modelo, como o nome do modelo, sigla, descrição, usuário de inclusão, data de inclusão e observações, além de uma tabela com os itens do modelo de calendário. Nesta tabela, o usuário deve selecionar uns dos itens e clicar no botão ações e, em seguida, escolher a opção “Editar”.

Ao clicar no botão “Editar”, será exibida uma tela para alteração itens do modelo de calendário. Depois de alterar os itens do modelo, o usuário poderá clicar em "Confirmar" para salvar essas informações no novo modelo de calendário.

Ao clicar no botão “Confirmar”, uma caixa de diálogo será exibida informando que os dados foram atualizados com sucesso.

# Exclusão
# 1. Exclusão dos itens do modelo de calendário
Ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento. O usuário pode navegar pela lista e selecionar o calendário desejado. Para editar o calendário, ele deve clicar no botão de ações e, em seguida, escolher a opção "Editar".

Após clicar na opção “Editar”, será aberta uma tela com todos os detalhes do modelo, como o nome do modelo, sigla, descrição, usuário de inclusão, data de inclusão e observações, além de uma tabela com os itens do modelo de calendário. Nesta tabela, o usuário deve selecionar um dos itens e clicar no botão ações e, em seguida, escolher a opção “Excluir”.

Ao clicar no botão “Excluir”, será exibida uma janela de confirmação.

Após a confirmação, a tabela de itens será atualizada. Em seguida, será exibida uma janela de confirmação.

# 2. Exclusão do modelo de calendário
Caso o calendário não possua itens, o usuário poderá excluir o modelo. Para fazer isso, ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento. O usuário pode navegar pela lista e selecionar o calendário desejado. Para editar o calendário, ele deve clicar no botão de ações e, em seguida, escolher a opção "Excluir".

Ao clicar no botão “Excluir”, será exibida uma janela de confirmação.

Ao clicar no botão “Confirmar”, uma caixa de diálogo será exibida informando que o calendário foi excluído com sucesso.

# Copiar modelo de calendário
Ao abrir a aplicação, uma tabela é exibida, listando os modelos de calendário cadastrados até o momento. O usuário pode navegar pela lista e selecionar o calendário desejado. Para copiar o calendário, ele deve clicar no botão de ações e, em seguida, escolher a opção "Copiar modelo".

Ao clicar na opção “Copiar modelo”, uma modal é exibida, mostrando dois campos, “modelo original” e “novo modelo”.
- Modelo original: campo preenchido automaticamente com o nome do modelo selecionado na tabela;
- Novo modelo: campo para digitar o nome da cópia do modelo.
Após preencher o campo com o nome da cópia, o usuário pode clicar no botão “Copiar modelo”.

Depois de clicar no botão “Copiar modelo”, o modelo será copiado e a tela com todos os dados e itens do modelo original estarão disponíveis para consulta, edição e exclusão.
# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas durante a Geração de Espelho
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Medição | Poderá consultar modelos de calendário |
| Poderá cadastrar um novo modelo de calendário | |
| Poderá editar os itens do modelo de calendário | |
| Poderá excluir os itens do modelo de calendário | |
| Poderá excluir um modelo de calendário | |
| Poderá copiar um modelo de calendário |
# 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 |
|---|---|---|
| Modelos de Calendário | 1° | - |
# CONTATOS
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>
Eventos →