Documentação

# Regional

# Versão 1

# DESCRIÇÃO

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

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

  • Visualização: Consulte os detalhes das regionais cadastradas.

  • Cadastro: Adicione novas regionais ao sistema.

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

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

# FUNCIONALIDADES

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

# Lista de Regionais

# Sem Resultados

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

# Com Resultados

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

Para localizar uma regional 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 regionais

# Novo – Cadastro de Regional

  • Ao clicar no botão “Novo” na tela de "Lista de Regionais", será exibido uma janela de formulário de cadastro para adicionar uma nova Regional ao sistema. Este formulário contém os seguintes campos:

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

  • Código Regional: Preencha o código da regional. O limite máximo de caracteres de 0 – 4 e aceita números e letras.

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

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

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

# Ações - Regional

# Editar

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

  • Regional: 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 da regional selecionada 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 regional, já com a regional editada na lista.

# Excluir

  • Selecione a Regional 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 regional 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 regional já com a regional 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 regional no sistema.

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão da regional 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 regionais. 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 Regional do sistema SOMUS.

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir uma nova regional no sistema.
Poderá visualizar as regionais já cadastradas
Poderá aplicar filtros específicos e refinar a lista de regionais exibida.
Poderá editar regionais já cadastradas
Poderá excluir regionais 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º -

# CONTATOS

Fale com a gente e tire suas dúvidas!

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

←