# Eventos
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Eventos tem como objetivo fornecer instruções detalhadas para que o usuário possa gerenciar os tipos de eventos e seus eventos relacionados, permitindo operações de visualização, cadastro, edição e exclusão.
# FINALIDADE
Esta funcionalidade permite a visualização, inclusão, edição e exclusão de tipos de eventos do calendário. Além disso, é possível vincular eventos ao tipo de evento desejado. Após o vínculo, é possível visualizar a lista de eventos associados ao tipo de evento selecionado, incluir novos eventos, editar ou excluir eventos existentes e adicionar atributos aos eventos já vinculados.
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 Planejamento > Dashboard > Eventos.
# FUNCIONALIDADES
Ao acessar o item "Evento" no menu do workspace de Planejamento, você visualizará a tela de Eventos, que apresenta as seguintes estruturas e ações:
# Tipos de Eventos
# → Sem Resultados
Caso nenhum tipo de evento seja encontrado, o sistema exibirá a mensagem: "Nenhum tipo de evento disponível para exibição." Isso indica que não há tipos de eventos cadastrados. Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de Tipo de evento.
# → Com Resultados
Ao clicar em "Eventos", será exibida a tela com uma lista detalhada dos tipos de eventos do calendário já cadastrados, apresentando os seguintes dados de visualização: código, sigla e descrição.
Para localizar um tipo de evento específico, clique no botão "Adicionar Filtro" na tabela e aplique os critérios desejados. Os resultados serão atualizados na lista conforme os filtros aplicados.

# Novo – Cadastro de Tipos de Eventos
Ao clicar no botão “Novo” na "Lista de Tipos de Eventos", será exibido uma janela de formulário de cadastro para adicionar um novo Tipo de Evento ao sistema. Este formulário contém os seguintes campos:
- Código: Preencha o código da empresa.
- Sigla: Preencha a sigla do tipo de evento a cadastrar.
- Descrição: Preencha a descrição do tipo de evento.
Se algum campo obrigatório não for informado, no momento de salvar os dados do cadastro “Erros validação” será apresentado com a relação de obrigatoriedades não cumpridas nos respectivos campos.
Após preencher todos os campos, clique no botão “Salvar”. Em seguida, o sistema exibirá uma caixa de diálogo de confirmação do cadastro com as opções "Cancelar" e "Confirmar".
Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhum cadastro será efetuado.
Confirmar: Se optar por "Confirmar", o sistema concluirá o cadastro.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro realizado com sucesso!".
Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de eventos já com o tipo cadastrado na lista.

# Seleção do Tipo de Evento
Para cada tipo de evento cadastrado, você pode associar eventos específicos ao tipo principal. Isso permite consultar todos os eventos relacionados ao tipo selecionado, além de incluir novos eventos.
# → Sem Resultados
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Novo: Quando um tipo de evento for selecionado na tabela, o botão “Novo” será ativado, permitindo o cadastro de novos eventos relacionados.
- Lista de Eventos: Se não houver eventos relacionados ao tipo de evento selecionado, o sistema exibirá a seguinte mensagem: “Não há eventos relacionados. Selecione um tipo de evento existente para cadastrar novos eventos ou para visualizar e adicionar eventos ao tipo selecionado.”

# → Com Resultados
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Novo: Quando um tipo de evento for selecionado na tabela, o botão “Novo” será ativado, permitindo o cadastro de novos eventos relacionados.
- Lista de Eventos: será exibido a lista de eventos relacionados ao tipo de evento selecionado, apresentando os seguintes dados de visualização: código, sigla, descrição, tipo de evento base, evento base, impressão, descrição simulação cop, cop e atributos.
- Ao selecionar o ícone associado a um evento na lista, será exibida uma janela contendo os atributos do evento contendo os seguintes dados: categoria, subcategoria, localidade, tarifa, grupo de consumo, cliente, livro e Unidade Consumidora (UC).

# Ações - Tipo de Evento
# → Editar
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Acesse as Ações: Clique no botão "Ações".
- Escolha Editar: Selecione a opção "Editar" na lista de valores exibida após clicar em ações.

- Tipo de Evento: Após clicar em editar será exibida a janela de formulário do cadastro em modo edição. Nessa janela, os campos do tipo de evento selecionado já estarão preenchidos. Você poderá alterar apenas o campo descrição.
- Os campos de código e sigla são exibidos apenas em formato de visualização sem possibilidade de edição.
- A janela de cadastro, você encontrará as seguintes opções: “Cancelar” e “Salvar”

Ao inserir novas alterações, clique em "Salvar" para efetivar as mudanças. Em seguida, o sistema exibirá uma caixa de diálogo de atualização do cadastro com as opções "Cancelar" e "Confirmar".

- Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma alteração será efetuada.
- Confirmar: Se optar por "Confirmar", o sistema concluirá a alteração cadastral.
- Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Alteração efetuada com sucesso!".

- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de eventos, já com o tipo editado na lista.
# → Excluir
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Acesse as Ações: Clique no botão "Ações".
- Escolha Excluir: Selecione a opção "Excluir" na lista de valores exibida após clicar em ações.

- Caixa de dialógo: Uma caixa de diálogo será exibida para confirmar a exclusão, informando que os dados não poderão ser recuperados após a exclusão. A caixa de diálogo conterá as opções "Cancelar" e "Confirmar".

- Cancelar: Se optar por "Cancelar", a ação será interrompida e nenhuma exclusão será efetuada.
- Confirmar: Se optar por "Confirmar", o sistema concluirá a exclusão do Tipo de Evento do sistema.
- Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro excluído com sucesso!".

- Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de eventos, já com o tipo de evento excluído da lista.
# Eventos
# → Sem Resultados
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Botão Novo: Ao selecionar um tipo de evento, o botão “Novo” na lista de eventos será ativado, permitindo a inclusão de novos eventos relacionados ao tipo selecionado.
- Caso nenhum evento relacionado ao tipo selecionado seja encontrado o sistema exibirá a mensagem: “Não há eventos relacionados. Selecione um tipo de evento existente para cadastrar novos eventos ou para visualizar e adicionar eventos ao tipo selecionado.”
# → Com Resultados
- Selecione o tipo de evento na tabela: Basta marcar a caixa de seleção disponível na tabela;
- Botão Novo: Ao selecionar um tipo de evento, o botão “Novo” na lista de eventos será ativado, permitindo a inclusão de novos eventos relacionados ao tipo selecionado.
- Lista de Eventos: Lista de Eventos: será exibido a lista de eventos relacionados ao tipo de evento selecionado, apresentando os seguintes dados de visualização: código, sigla, descrição, tipo de evento base, evento base, impressão, descrição simulação cop, cop e atributos.

- Ao selecionar o ícone associado a um evento na lista, será exibida uma janela contendo os atributos do evento contendo os seguintes dados: categoria, subcategoria, localidade, tarifa, grupo de consumo, cliente, livro e Unidade Consumidora (UC).

- Se não houver atributos relacionados ao evento e ao tipo de evento, ao selecionar o ícone na lista de eventos do evento desejado, o sistema exibirá a seguinte mensagem: “Não foram encontrados resultados para essa busca”. Isso indica que nenhum atributo foi cadastrado para o evento e tipo selecionado.

# Cadastro Novo Evento
# Ações - Evento
→ Editar
→ Excluir
# ESPECIFICIDADES
Descreva os itens abaixo referente as validações.
| FUNÇÃO | PARÂMETROS | STATUS/COMPORTAMENTO |
|---|---|---|
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
Botão Novo: Botão de ação para acionar as telas de cadastro de Tipo de Evento e de Novo Evento
Botão Ações: Botão de ação que permite a edição e exclusão do tipo de evento ou do evento cadastrado
Adicionar Filtro: Localizado na tabela de tipo de evento e na de evento, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca nas listas exibidas. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.

Caixa de Seleção: Ao marcar a caixa de seleção na tabela, o usuário ativa o botão de ações, permitindo a execução de operações relacionadas à linha selecionada.
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 Fechar: Ao clicar no botão 'Fechar', o usuário será redirecionado para a tela/caminho anterior.
# REQUISITOS DE USUÁRIOS
Principais ações que poderão ser executadas na tela de Empresa do sistema SOMUS.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Enterprise | Poderá incluir uma nova empresa no sistema |
| Poderá visualizar as empresas já cadastradas | |
| Poderá aplicar filtros específicos e refinar a lista de empresas exibida. | |
| Poderá editar empresas já cadastradas | |
| Poderá excluir empresas da lista | |
| Poderá ativar ou inativar o cadastro. |
# 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 |
|---|---|---|
| Empresa | 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>