# Tipos de custos
# Versão 1
# DESCRIÇÃO
A documentação da aplicação tipos de custos 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 custos que estarão disponíveis no sistema.
# FINALIDADE
Nesta funcionalidade devemos realizar as seguintes ações:
Visualização: Consulte os tipos de custos cadastrados no sistema.
Cadastro: Adicione novos tipos de custos no sistema para uso nas funcionalidades.
Edição: Modifique as informações dos tipos de custos existentes conforme necessário.
Exclusão: Remova tipos de custos 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 custos.
# FUNCIONALIDADES
Ao acessar o item "Tipos de custo" no menu do workspace de Enterprise, você visualizará a tela de Tipos de custos, que apresenta as seguintes estruturas e ações:
# Lista de tipos de custo
# Sem Resultados
Caso nenhum tipo de custo seja encontrado, o sistema exibirá a mensagem: "Nenhum tipo de custo cadastrado. Comece adicionando um novo tipo para visualizar os dados". Para iniciar o processo, clique no botão "Novo" para acessar a tela de Tipo de custo.
# Com Resultados
Ao clicar em "Tipos de custo”, será exibida a tela com a lista de tipos de custos cadastrados, apresentando os seguintes dados de visualização: sigla, descrição, conta gerencial, data/hora inclusão, usuário inclusão, data/hora alteração e usuário alteração.
Para localizar um tipo de custo 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.
# Novo – Cadastro de Tipo de custo
Ao clicar no botão “Novo” na tela de "Lista de tipos de custos" (Canto esquerdo superior), será exibida uma janela de formulário de cadastro para adicionar um novo tipo de custo. Este formulário contém os seguintes campos:
Sigla: Preencha a sigla do tipo de custo que está sendo cadastrado. O campo permite o limite de 0 – 10 caracteres.
Descrição: Preencha a descrição desse tipo de custo. O campo permite o limite de 0 – 40 caracteres.
Conta gerencial: Preencha o número da conta gerencial desse custo. O campo permite o limite de 0 – 15 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 Tipos de custos já com o tipo de custo cadastrado na lista.
# Ações - Tipos de custo
# Editar
Selecione o tipo de custo 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 custo: 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 custo 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 custos, já com o novo tipo de custo editado na lista.
# Excluir
Selecione o tipo de custo 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 tipo de custo.
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 custos, já com o novo tipo de custo excluído da lista.
# PROCEDIMENTOS BÁSICOS – SÍMBOLOS E CONVENÇÕES
# Botão Novo: Botão de ação para incluir um novo tipo de custo.
# Botão Ações: Botão de ação que permite a edição e exclusão do tipo de custo.
# 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 custos. Ao ser clicado, ele abre uma janela com opções de filtros disponíveis.
# 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.
# Navegação Tabela: Localizado no rodapé da tabela, o usuário pode selecionar o número de linhas a serem exibidas por página e navegar entre as páginas.
# Botão Fechar: Ao clicar no botão 'Fechar', o usuário será redirecionado para a tela/caminho anterior.
# 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 custos. |
| Poderá visualizar os tipos de custos já cadastrados. | |
| Poderá aplicar filtros específicos e refinar a lista de tipos de custos exibida. | |
| Poderá editar tipos de custos já cadastrados. | |
| Poderá excluir tipos de custos 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 custo | 1º | - |
# CONTATOS
Fale com a gente e tire suas dúvidas!
Email: <Variáveis parametrizáveis a serem definidas>