Documentação

# Logradouros

# DESCRIÇÃO

A documentação da aplicação Logradouros tem como objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de visualização, cadastro – preenchimento dos campos, edição e exclusão de logradouros no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

  • Visualização: Consulte os detalhes dos logradouros cadastrados.

  • Cadastro: Adicione novos logradouros ao sistema.

  • Edição: Modifique as informações dos logradouros existentes conforme necessário.

  • Exclusão: Remova 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> Logradouros.

# FUNCIONALIDADES

Ao acessar o item "Logradouros" no menu do workspace de Enterprise, você visualizará a tela de Logradouros, que apresenta as seguintes estruturas e ações:

# Lista de Logradouros

# Sem Resultados

Caso nenhum logradouro seja encontrado, o sistema exibirá a mensagem: "Nenhum logradouro disponível para exibição." Isso indica que não há logradouros cadastrados. Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de logradouro. Logradouros - Sem Resultados

# Com Resultados

Ao clicar em "Logradouros", será exibido a tela com a lista de Logradouros cadastrados, apresentando os seguintes dados de visualização: código do CEP, tipo/logradouro, bairro, face, numeração inicial, numeração final, localidade, município, UF, data/hora inclusão, usuário inclusão, data/hora alteração e usuário alteração.

Para localizar um 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 Logradouro

  • 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 Logradouro ao sistema. Este formulário contém os seguintes campos:

  • UF: Selecione na lista de valores exibida após clicar no campo a UF no qual o logradouro faz parte.

  • Município: Selecione na lista de valores exibida após clicar no campo o município no qual o logradouro faz parte.

  • Bairro: Selecione na lista de valores exibida após clicar no campo o bairro na qual o logradouro faz parte.

  • CEP: Selecione na lista de valores exibida após clicar no campo o CEP no qual o logradouro faz parte.

  • Tipo: Selecione na lista de valores exibida após clicar no campo o tipo de logradouro na qual o logradouro faz parte. Ex: Rua, Avenida, Travessa.

  • Nome do Logradouro: Preencha o nome completo do logradouro a cadastrar. Limite de caracteres de 0 – 255.

  • 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 realizado com sucesso!".

  • Retorno à tela principal: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de Logradouros já com o logradouro cadastrado na lista.

Cadastro de Logradouro

# Ações - Logradouro

# Editar

  • Selecione o 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.

  • Logradouro: Após clicar em editar será exibida a tela de formulário do cadastro em modo edição contendo as opções “Cancelar” e “Salvar”. Nesta tela, os dados do 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 Logradouros, já com o logradouro editado na lista.

  • Excluir

  • Selecione o 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 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 Logradouros, já com o logradouro excluído da lista.

#PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES

# Botão Novo: Botão de ação para incluir um novo logradouro no sistema.

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão do logradouro selecionado.

Botão Ações

# Adicionar Filtro: Localizado na tabela, o botão "Adicionar Filtro" permite inserir critérios específicos para refinar a busca na tabela de logradouros. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.

Botão adicionar filtro

# 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.

Caixa de seleção

Paginação da tabela

# Botão Fechar: Ao clicar no botão 'Fechar', o usuário será redirecionado para a tela/caminho anterior.

Botão fechar

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir um novo logradouro no sistema
Poderá visualizar os logradouros já cadastrados
Poderá aplicar filtros específicos e refinar a lista de logradouros exibida.
Poderá editar logradouros já cadastrados
Poderá adicionar um novo endereço para vincular ao cliente durante o cadastro
Poderá excluir logradouros da lista

# 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
Unidade Federativa (UF) 1º -
Municípios 1º -
Bairros 1º -
CEP 1º -
Tipo 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 →