Documentação

# Tipos de Documento

# Versão 1

# DESCRIÇÃO

A documentação da aplicação Tipos de Documento 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 tipos de documentos no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

  • Visualização: Consulte os detalhes dos tipos de documento cadastrados.

  • Cadastro: Adicione novos tipos de documento ao sistema.

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

  • Exclusão: Remova tipos de documento 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 > Dados Gerais> Tipos de Documento.

# FUNCIONALIDADES

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

# Lista de Documentos

# Sem Resultados

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

# Com Resultados

Ao clicar em "Tipos de Documento”, será exibida a tela com a lista de documentos cadastrados, apresentando os seguintes dados de visualização: código, sigla, tipo, nome do documento, data/hora inclusão, usuário inclusão, data/hora alteração, usuário alteração e status (situação).

Para localizar um documento 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 Tipos de Documento

# Novo – Cadastro de Documento

Ao clicar no botão “Novo” na tela de "Lista de Documentos", será exibida uma janela de formulário de cadastro para adicionar um novo documento ao sistema. Este formulário contém os seguintes campos:

  • Código: Preencha o código a ser utilizado para o documento a cadastrar. O campo permite até 0- 4 caracteres.

  • Sigla: Preencha a sigla a ser utilizada para o documento a cadastrar. O campo permite até 0- 10 caracteres.

  • Nome do documento: Preencha o nome completo do documento a cadastrar. O campo permite até 0- 30 caracteres.

  • Documento Principal: Permite que você defina se o documento a cadastrar é um documento principal ou não. Para alterar, selecione a opção desejada (SIM ou NÃO).

# SIM: Indica que o documento preenchido é um documento principal.
# NÃO: Indica que o documento preenchido é um documento secundário.
  • Situação: Permite que você defina se a situação do documento está ativo no sistema. Para alterar o status, selecione a opção desejada (SIM ou NÃO).
# SIM: Indica que o cadastro está ativo e pode ser utilizado normalmente.
# NÃO: Indica que o cadastro está inativo.

  • 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 Tipos de Documento já com o tipo cadastrado na lista.

Cadastro Documentos

# Ações - Documentos

# Editar

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

  • Documento: 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 janela, os dados do documento selecionado já estarão preenchidos, permitindo que você altere as informações conforme necessário.

  • 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 de edição 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 atualizado com sucesso!".

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

Editar Documentos

# Excluir

  • Selecione o documento 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 Documento 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 Tipos de Documento, já com o documento excluído da lista.

Confirmar Exclusão

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

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

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão do tipo de documento 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 documentos. 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 Tipos de Documento do sistema SOMUS.

USUÁRIO RESPONSABILIDADES
Enterprise Poderá incluir novos tipos de documento no sistema.
Poderá visualizar os tipos de documento já cadastrados.
Poderá aplicar filtros específicos e refinar a lista de documentos exibido.
Poderá editar tipos de documento já cadastrados.
Poderá excluir tipos de documento 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
Tipos de Documento 1º -

# CONTATOS

Fale com a gente e tire suas dúvidas!

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

← Visões de Gerenciador →