Documentação

# Tipos de anexos

# Versão 1

# DESCRIÇÃO

A documentação da aplicação Tipos de anexos 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 dos tipos de anexos disponíveis no sistema.

# FINALIDADE

Nesta funcionalidade devemos realizar as seguintes ações:

  • Visualização: Consulte os tipos de anexos cadastrados no sistema.

  • Cadastro: Adicione novos tipos de anexos ao sistema.

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

  • Exclusão: Remova tipos de anexos 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 anexos.

# FUNCIONALIDADES

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

# Lista de tipos de anexos

# Sem Resultados

Caso nenhum tipo de anexo seja encontrado, o sistema exibirá a mensagem: "Nenhum tipo de anexo cadastrado. Comece adicionando um novo tipo para visualizar os dados". Para iniciar o processo, clique no botão "Novo" para acessar a tela de Tipos de anexos.

# Com Resultados

Ao clicar em "Tipos de anexos”, será exibida a tela com a lista de tipos de anexos cadastrados, apresentando os seguintes dados de visualização: sigla, descrição, situação, data/hora inclusão, usuário inclusão, data/hora alteração e usuário alteração.

Para localizar um tipo de anexo 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 anexos

# Novo – Cadastro de Tipo de anexo

Ao clicar no botão “Novo” na tela de "Lista de tipos de anexos" (Canto esquerdo superior), será exibida uma janela de formulário de cadastro para adicionar um novo tipo. Este formulário contém os seguintes campos:

  • Sigla: Preencha a sigla do tipo de anexo que está sendo cadastrado. O campo permite o limite de 0 – 10 caracteres.

  • Descrição: Preencha a descrição desse tipo de anexo. O campo permite o limite de 0 – 30 caracteres.

  • Situação: Permite que você defina se o tipo de anexo está ativo no sistema. Para alterar a situação, 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.

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

Cadastro de tipo de anexo

# Ações - Tipos de anexos

# Editar

  • Selecione o tipo de anexo 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.

  • Tipo de anexo: 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 tipo de anexo 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 anexos, já com o tipo de anexo editado na lista. Editar tipo de anexo

# Excluir

Selecione o tipo de anexo 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 defeito.

  • 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 anexos, já com o tipo de anexo 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 anexo.

Botão Novo

# Botão Ações: Botão de ação que permite a edição e exclusão do tipo de anexo.

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 tipos de anexos. 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 novos tipos de anexos.
Poderá visualizar os tipos de anexos já cadastrados.
Poderá aplicar filtros específicos e refinar a lista de tipos de anexos exibidos.
Poderá editar tipos de anexos já cadastrados.
Poderá excluir tipos de anexos da lista.
Poderá inativar o cadastro.

# 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>

← Tipos de Custo →