Documentação

# Bairros

# Versão 1

# DESCRIÇÃO

A documentação da aplicação Bairros tem objetivo fornecer instruções detalhadas para que o usuário possa realizar operações de visualização, cadastro, edição e exclusão de bairros no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

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

  • Cadastro: Adicione novos bairros ao sistema.

  • Edição: Modifique as informações dos bairros existentes.

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

# FUNCIONALIDADES

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

# Lista de Bairros

# Sem Resultados

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

# Com Resultados

Ao clicar em "Bairros", será exibido a tela com a lista das Unidades Federativas cadastradas, apresentando os seguintes dados de visualização: sigla, nome do bairro, município e UF.

Para localizar um bairro 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 Bairros

# Novo – Cadastro de Bairros

  • Ao clicar no botão “Novo” na tela de "Lista de Bairros", será exibido uma janela de formulário de cadastro para adicionar um novo Bairro 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 bairro faz parte.

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

  • Sigla: Digite a sigla do bairro. O campo permite até 10 caracteres.

  • Nome do Bairro: Digite o nome do Bairro. O campo permite até 40 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 Bairros, já com o Bairro cadastrado na lista.

Cadastro de Bairros

# Ações - Bairros

# Editar

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

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

# Excluir

  • Selecione o Bairro 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 Bairro 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 Bairros, já com o Bairro excluído. Confirmar Exclusão

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

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

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão do Bairro 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 Bairros. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.

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

# REQUISITOS DE USUÁRIOS

Principais ações que poderão ser executadas durante a solicitação de Equipamentos de Medição:

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir um novo bairro no sistema.
Poderá visualizar os bairros cadastrados.
Poderá aplicar filtros específicos e refinar a lista de bairros exibida.
Poderá editar bairros já cadastrados.
Poderá excluir bairros da lista do sistema.

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

# CONTATOS

Fale com a gente e tire suas dúvidas!

Email: <Variáveis parametrizáveis a serem definidas>

CEP →