Documentação

# Municípios

# Versão 1

# DESCRIÇÃO

A documentação da aplicação Municípios 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 Municípios no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

  • Visualização: Consulte os detalhes dos municípios cadastrados.

  • Cadastro: Adicione novos municípios ao sistema.

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

  • Exclusão: Remova Municípios.

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> Municípios.

# FUNCIONALIDADES

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

# Lista de Municípios

# Sem Resultados

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

# Com Resultados

Ao clicar em "Município", será exibido a tela com a lista de Municípios cadastrados, apresentando os seguintes dados de visualização: Código do IBGE, sigla e nome do município e UF.

Para localizar um município 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 municípios

# Novo – Cadastro de Município

  • Ao clicar no botão “Novo” na tela de "Municípios", será exibido uma janela de formulário de cadastro para adicionar um novo Município ao sistema. Este formulário contém os seguintes campos:

  • UF: Selecione a UF. Ao clicar no campo será exibida a lista de valores para seleção.

  • Código do IBGE: Digite o número do código. O campo permite até 7 caracteres.

  • Sigla: Digite a sigla do Município. O campo permite até 10 caracteres.

  • Nome do Município: Digite o nome do Município. 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 Município, já com o município cadastrado na lista.

Cadastro de Município

# Ações - Município

# Editar

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

  • Município: 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 Município 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 Município, já com o município editado na lista. Editar Município

# Excluir

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

FUNÇÃO PARÂMETROS STATUS/COMPORTAMENTO

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

# Botão Novo: Botão de ação para incluir uma novo Município no sistema.

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão do Município 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 municípios. 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

# REQUISITOS DE USUÁRIOS

Principais ações que poderão ser executadas durante a execução de Consultar Cadastro de Condomínio:

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir um novo município no sistema
Poderá visualizar os municípios já cadastrados
Poderá aplicar filtros específicos e refinar a lista de municípios exibida.
Poderá editar municípios já cadastrados
Poderá excluir municípios 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
Unidade Federativa (UF) 1º -
Municípios 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>

← Tipo de Logradouros →