Documentação

# Localidade

# Versão 1

# DESCRIÇÃO

A documentação da aplicação Localidade 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 localidades no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

o Visualização: Consulte os detalhes das localidades cadastradas.

o Cadastro: Adicione novas localidades e associe áreas de atendimento.

o Edição: Modifique as informações das localidades e áreas de atendimento existentes conforme necessário.

o Exclusão: Remova localidades 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 lógica> Localidade.

# FUNCIONALIDADES

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

# Lista de Localidades

# Sem Resultados

Caso nenhuma localidade seja encontrada, o sistema exibirá a mensagem: "Nenhuma localidade disponível para exibição." Isso indica que não há localidades cadastradas. Para iniciar o processo, clique no botão "Novo" para acessar a tela de cadastro de localidade.

# Com Resultados

Ao clicar em "Localidade", será exibida a tela com a lista de localidades cadastradas, apresentando os seguintes dados de visualização: código, sigla, nome da localidade, regional, empresa, data/hora inclusão, usuário inclusão, data/hora alteração e usuário alteração.

Para localizar uma localidade específica, 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 localidades

# Novo – Cadastro de Localidade

Ao clicar no botão “Novo” na tela de "Lista de Localidades", será exibida a tela de formulário de cadastro para adicionar uma nova localidade e suas respectivas áreas de atendimento. Este formulário contém as seguintes seções e campos:

# Dados da Localidade

Aqui, você irá preencher as informações básicas da localidade que deseja cadastrar. Os campos disponíveis são:

  • Empresa: Selecione na lista de valores exibida após clicar no campo a empresa que deseja associar.

  • Regional: Selecione na lista de valores exibida após clicar no campo a regional que deseja associar.

  • Código: Preencha o código da empresa. O limite máximo de caracteres de 0 – 4.

  • Sigla: Preencha a sigla da localidade. O limite máximo de caracteres de 0 – 7.

  • Nome da Localidade: Preencha o nome completo da localidade a cadastrar. O limite máximo de caracteres de 0 – 50.

Nota: Você pode optar por cadastrar apenas os dados da localidade neste momento e salvar, deixando a adição das áreas de atendimento para um momento posterior. Caso prefira, também é possível já adicionar as áreas de atendimento durante o cadastro inicial. Se optar por salvar apenas a localidade agora, você poderá editar o cadastro posteriormente para incluir as áreas de atendimento quando for necessário. Dados da Localidade

# Área de Atendimento

Nesta seção, você pode definir as áreas de atendimento que fazem parte da localidade cadastrada. Para isso informe:

  • CEP: Preencha o CEP. O limite máximo de caracteres de 0 – 10.

  • UF: Selecione na lista de valores exibida após clicar no campo a UF que deseja associar. O campo é de preenchimento obrigatório.

  • Município: Selecione na lista de valores exibida após clicar no campo o município que deseja associar. O campo é de preenchimento obrigatório.

  • Bairro: Selecione na lista de valores exibida após clicar no campo o bairro que deseja associar.

  • Logradouro: Selecione na lista de valores exibida após clicar no campo o logradouro que deseja associar.

  • Adicionar: Para habilitar o botão de Adicionar preencha os campos obrigatórios e clique em “Adicionar” para incluir a área de atendimento à lista. Botão adicionar ativo

# Itens - Área de Atendimento

Caso nenhuma área de atendimento for adicionada, a mensagem "Nenhum logradouro adicionado à área de atendimento" será exibido. Para iniciar o processo, preencha os campos e clique em adicionar. Dessa forma, os itens adicionados serão exibidos na tabela contendo os seguintes campos para visualização: Código CEP, Tipo/Logradouro, Bairro, Face, Número Inicial, Número Final, Localidade, Município, UF.

Para localizar uma área de atendimento específica, 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. Área de atendimento

# Ações - Excluir Itens da Área de Atendimento

Cada item referente à área de atendimento pode ser excluído da seguinte forma:

  • Selecione o Item: Marque a caixa de seleção correspondente ao item desejado 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 da área de atendimento relacionada.

  • Após a confirmação, uma nova caixa de diálogo aparecerá, informando "Cadastro excluído com sucesso!".

  • Retorno à tela cadastro de localidade: Ao clicar no botão "Fechar" na caixa de diálogo de sucesso, o sistema retornará à tela de cadastro de localidade, já com o item excluído da lista.

# Concluir Cadastro

  • 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 localidade já com a localidade cadastrada na lista.

# Ações - Localidade
# Editar

  • Selecione a Localidade 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.

  • Localidade: Após clicar em "Editar", será exibida a tela de formulário do cadastro em modo de edição, contendo as opções "Cancelar" e "Salvar". Nesta tela, os dados da localidade selecionada já estarão preenchidos, permitindo que você altere as informações conforme necessário, além de adicionar ou excluir áreas de atendimento.

  • 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 localidades, já com a localidade editada na lista. Editar cadastro de localidade

# Excluir

  • Selecione a Localidade 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 da localidade 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 localidade, já com a localidade excluída da lista. Confirmar exclusão

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

# Botão Novo: Botão de ação para incluir uma nova localidade no sistema.

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão da localidade selecionada.

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 lista de localidades. 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 na tela de Localidade do sistema SOMUS.

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir uma nova localidade no sistema.
Poderá adicionar áreas de atendimento a localidade
Poderá excluir áreas de atendimento da localidade
Poderá visualizar as localidades já cadastradas
Poderá aplicar filtros específicos e refinar a lista de localidades exibida.
Poderá editar localidades já cadastradas
Poderá excluir localidades 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
Empresa 1º -
Regional 1º -
Localidade 1º -

# CONTATOS

Fale com a gente e tire suas dúvidas!

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

← Regional →