# Tipo de Logradouros
# Versão 1
# DESCRIÇÃO
A documentação da aplicação Tipo de Logradouros tem como objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de visualização, cadastro, edição e exclusão de tipo de logradouros no sistema.
# FINALIDADE
Nesta funcionalidade devemos realizar as seguintes ações:
Visualização: Consulte os detalhes dos tipos de logradouros cadastrados.
Cadastro: Adicione novos tipos de logradouros ao sistema.
Edição: Modifique as informações dos tipo de logradouros existentes conforme necessário.
Exclusão: Remova tipo de logradouros da lista cadastrada.
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 Enterprise > Dashboard > Segmentação Geográfica > Tipo de Logradouros.
# FUNCIONALIDADES
Ao acessar o item "Tipo de Logradouros" no menu do workspace de Enterprise, você visualizará a tela de Tipo de Logradouros, que apresenta as seguintes estruturas e ações:
# Lista de Tipo de Logradouros
# Sem Resultados
Caso nenhum tipo de logradouro seja encontrado, o sistema exibirá a mensagem: "Nenhum tipo de logradouro disponível para exibição." Isso indica que não há tipo de logradouros cadastrados. Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de tipo de logradouros.
# Com Resultados
Ao clicar em "Tipo de Logradouros", será exibido a tela com a lista de logradouros cadastrados, apresentando os seguintes dados de visualização: sigla e descrição.
Para localizar um tipo de logradouro 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 Logradouros
Ao clicar no botão “Novo” na tela de "Lista de Logradouros", será exibido uma janela de formulário de cadastro para adicionar um novo tipo de logradouro ao sistema. Este formulário contém os seguintes campos:
Sigla: Digite a sigla do Tipo de Logradouro. O campo permite até 7 caracteres.
Descrição: Preencha a descrição. O campo permite até 15 caracteres.
Se algum campo obrigatório não for informado, no momento de salvar os dados do cadastro “Erros validação” será apresentada 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 Tipos de Logradouros, já com o tipo cadastrado na lista
# Ações - Tipos de Logradouros
# Editar
Selecione o Tipo de Logradouro 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 Logradouros: Após clicar em editar será exibido a tela de formulário do cadastro em modo edição contendo as opções “Cancelar” e “Salvar”. Nesta tela, os dados do Tipo de Logradouro selecionado já estarão preenchidos, permitindo que você altere as informações conforme necessárias.
Ao inserir novas alterações, clique em "Salvar" para efetivar as mudanças. 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 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 "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 Tipos de Logradouros, já com o tipo editado na lista.
# Excluir
Selecione o Tipo de Logradouro 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 logradouro 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 Tipos de Logradouros, já com o tipo excluído na lista.
# 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 incluir um novo Tipo de Logradouro no sistema.
# Botão Ações: Botão de ação que permite a edição e exclusão do Tipo de Logradouro selecionado.
# Adicionar Filtro: Localizado na tabela, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca na tabela de lista de logradouros. 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 Tipos de Logradouros do sistema SOMUS.
| USUÁRIO | RESPONSABILIDADES |
|---|---|
| Enterprise | Poderá incluir um novo tipo de logradouro no sistema |
| Poderá visualizar os tipo de logradouros já cadastrados | |
| Poderá aplicar filtros específicos e refinar a lista de tipo de logradouros exibido | |
| Poderá editar tipo de logradouros já cadastrados | |
| Poderá excluir tipo de logradouros da lista |
# 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 |
|---|---|---|
| Tipos de Logradouros | 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>
← Municípios UF →