# Agrupamento de Mensagens
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Agrupamento de Mensagens tem como objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de consulta, edição, inclusão, exclusão e exportação do agrupamento de mensagens, bem como a visualização das mensagens de leiturista associadas a cada agrupamento.
# FINALIDADE
O objetivo desta aplicação é consultar, cadastrar e gerenciar agrupamentos de mensagens, além de visualizar as mensagens de leituristas relacionadas a cada agrupamento, caso já estejam associadas.
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 Medição > Dashboard > Agrupamento de Mensagens.
# FUNCIONALIDADES
Ao acessar o item ‘Agrupamento de Mensagens' no menu do workspace de Medição, você visualizará a tela de Agrupamento de Mensagens, que apresenta as seguintes estruturas e ações:
# Lista de Agrupamento de Mensagens
# → Sem agrupamentos cadastrados
Caso nenhum agrupamento seja encontrado, o sistema carregará a tabela sem dados e contendo a mensagem: "Nenhum agrupador a ser exibido. Comece adicionando um novo agrupamento". Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de Agrupamento de Mensagem.
# → Com agrupamentos cadastrados
Ao clicar em “Agrupamento de Mensagens”, será exibida a tela com a lista de agrupamento de mensagens cadastrados, apresentando os seguintes dados de visualização na tabela:
- Cód. Agrupamento: exibe o código do agrupamento;
- Descrição do Agrupamento;
- Qtd Limite de Rep. Da Ocor.: exibe a quantidade limite de repetições da ocorrência;
- Status da Ocor. Unitária: exibe o status da ocorrência unitária;
- Rotina da Ocor. Unitária: exibe a rotina da ocorrência unitária;
- Status da Ocor. Limite: exibe o status da ocorrência limite;
- Rotina da Ocor. Limite: exibe a rotina da ocorrência limite;
- Data Inclusão;
- Usuário Inclusão;
- Data Alteração;
- Usuário Alteração;
Para localizar um tipo de agrupamento 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.

# Lista de Agrupadas
Ao abrir a aplicação, a tabela será exibida sem dados e com a mensagem: "Nenhuma mensagem agrupada a ser exibida. Selecione um Agrupamento de Mensagens para ver a lista de mensagens agrupadas." As mensagens dos leituristas são associadas aos Agrupamentos de Mensagens na aplicação F5GMSGL0-Mensagens do Leiturista. Portanto, caso o relacionamento já tenha sido estabelecido, ao selecionar um agrupamento na tabela 'Agrupamento de Mensagens', a tabela 'Agrupadas' será preenchida com os dados correspondentes. A lista apresentará os seguintes dados de visualização:
- Cód. Mensagem: exibe o código da mensagem;
- Grupo de Consumo;
- Mensagem;
- Rotina de Crítica;
Para localizar um tipo de mensagem agrupada em 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 Agrupamento de Mensagens
Ao clicar no botão “Novo” na tela de "Agrupamento de Mensagens", será exibida uma janela de formulário de cadastro para adicionar um novo agrupamento ao sistema. Este formulário contém os seguintes campos divididos em duas seções:
Agrupamento de Mensagem
- Cód. Agrup. Msg: campo para inserir o código do agrupamento de mensagem;
- Descrição do Agrupamento: campo para inserir o código do agrupamento de mensagem;
- Qtd de Repetições Limite: campo para inserir a quantidade de repetições limite;
- Status da Ocorrência Unitária: campo para selecionar o status da ocorrência unitária;
- Rotina da Ocorrência Unitária: campo para selecionar a rotina da ocorrência unitária;
- Status da Ocorrência Limite: campo para selecionar o status da ocorrência limite;
- Rotina da Ocorrência Limite: campo para selecionar a rotina da ocorrência limite.
Coletor
- Qtd Repetições Limite: campo para inserir a quantidade de repetições limite;
- Msg quando Qtd Limite for atingida: campo para inserir a mensagem que será exibida quando a quantidade limite for atingida.

Caso algum campo obrigatório não seja preenchido no momento de salvar os dados do cadastro, será exibido um aviso de "Erros de Validação" com a lista das obrigatoriedades não atendidas nos campos correspondentes.
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 efetuado com sucesso!". Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de agrupamento de mensagens já com o agrupamento cadastrado na lista.

# Ações - Agrupamento de Mensagens
# → Editar
- Selecione o agrupamento na tabela. Para isso, basta marcar a caixa de seleção disponível na tabela.
- Clique no botão "Ações" da tabela. Ao fazer isso, uma lista será exibida com as opções: Editar e Excluir.
- Selecione a opção "Editar" na lista exibida. Após clicar em "Editar", a tela de formulário de cadastro será exibida no modo de edição, contendo as opções “Cancelar” e “Salvar”. Os dados do Agrupamento selecionado já estarão preenchidos, permitindo que você faça as alterações necessárias antes de salvar ou cancelar as modificações.

Ao inserir novas alterações, clique em "Salvar" para efetivar as mudanças. Em seguida, o sistema exibirá uma caixa de diálogo para confirmar alteração cadastral 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 "Dados atualizados com sucesso!". Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de agrupamento de mensagens.
# → Excluir
Somente será possível excluir agrupamentos que não possuem nenhuma mensagem do leiturista relacionada; caso não haja, o seguinte procedimento será seguido:
- Selecione o agrupamento na tabela. Para isso, basta marcar a caixa de seleção disponível na tabela.
- Clique no botão "Ações" da tabela. Ao fazer isso, uma lista será exibida com as opções: Editar e Excluir.
- Selecione a opção "Excluir" na lista exibida.

Ao clicar, 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 Agrupamento do sistema.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Dados excluídos com sucesso!". Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Agrupamento de Mensagens, já com o tipo excluído da lista.
# Exportar Agrupamento de Mensagens para o coletor
O usuário poderá exportar agrupamentos de mensagens para o coletor. Para isso, é necessário selecionar um agrupamento específico ou realizar uma multi-seleção. Após selecionar os agrupamentos, o usuário deve clicar no botão ‘Exportar’. Ao fazer isso, uma modal será exibida, contendo um campo de seleção de empresa e o botão ‘Exportar’.

Ao clicar em ‘Exportar’, o sistema exportará as mensagens, e uma caixa de diálogo aparecerá informando que os dados foram exportados com sucesso. Caso o usuário não queira prosseguir com a exportação, ele poderá clicar no símbolo ‘x’, o que fechará a modal e retornará à tela de Agrupamento de Mensagens.
Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Dados exportados com sucesso!". Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Agrupamento de Mensagens.

# 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 Novo na lista de tipos de agrupamento de mensagens direcionam diretamente para a tela de cadastro do respectivo agrupamento.
Botão Ações: Este botão exibe uma lista de opções contextuais aplicáveis ao item selecionado. As opções podem incluir ações como editar ou excluir o item.
Adicionar Filtro: Localizado na tabela, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca na tabela. 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 Exportar: Este botão abre uma modal para que o usuário selecione a empresa e faça a exportação dos agrupamentos para o coletor.
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 Tipos de Equipamentos do sistema SOMUS.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Medição | Poderá cadastrar agrupamento de mensagens |
| Poderá editar agrupamentos de mensagens | |
| Poderá visualizar os agrupamentos de mensagens cadastrados | |
| Poderá excluir tipos de equipamentos existentes | |
| Poderá filtrar por agrupamentos específicos | |
| Poderá visualizar as mensagens de leiturista associadas ao agrupamento selecionado | |
| Poderá exportar os agrupamentos selecionados para o coletor |
# 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 |
|---|---|---|
| Agrupamento de Mensagens | 1° | - |
# CONTATOS
Entre em contato conosco 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>