Processo de Documento
Processo Documento — Gestão de Documentos (Portal Easypac)
A tela de Processo Documento, no módulo de Gestão de Documentos, é onde o usuário cadastra e mantém a lista de processos de documento da empresa — um cadastro de apoio simples, com apenas Descrição e Situação, usado para classificar documentos ao longo do ciclo de gestão da qualidade.
Visão Geral
A tela de Processo Documento, no módulo de Gestão de Documentos, é onde o usuário cadastra e mantém a lista de processos de documento da empresa — um cadastro de apoio simples, com apenas Descrição e Situação, usado para classificar documentos ao longo do ciclo de gestão da qualidade. Junto com Tipo de Documento e Setor, ela faz parte do grupo de telas de parametrização que precisam existir antes de o ciclo de vida do documento (criação, revisão, aprovação, vigência e arquivamento) poder classificar cada documento corretamente. A tela só permite cadastrar e editar um processo de documento — não existe exclusão.
Pré-requisitos
Não há cadastro obrigatório anterior para criar um processo de documento: Descrição e Situação são informadas livremente pelo próprio usuário no formulário, sem vínculo com empresa, local, turno ou qualquer outro cadastro. O único pré-requisito é de permissão: o usuário precisa ter o perfil de acesso adequado (ver `## Permissões e Perfis de Acesso`) para abrir a listagem, cadastrar ou editar um processo de documento.
Permissões e Perfis de Acesso
A tela de Processo Documento é controlada por permissões de papel, uma para cada operação: abrir a listagem exige o perfil de permissão de visualizar processo de documento; abrir o formulário de novo cadastro e gravá-lo exige o perfil de permissão de cadastrar processo de documento; abrir o formulário de edição de um processo existente e gravar a alteração exige o perfil de permissão de editar processo de documento. As três permissões são exigidas tanto para abrir a tela quanto para concluir a operação correspondente — não há acesso à listagem, ao cadastro ou à edição sem a permissão específica de cada operação.
A listagem não é filtrada por empresa, local ou grupo: todos os processos de documento cadastrados no sistema aparecem para qualquer usuário com permissão de visualizar, independentemente da empresa à qual o usuário está vinculado.
Perfil fiscal: não tem acesso à tela, ou seja, não pode adicionar novo, editar e nem excluir.
Fluxo Operacional
- O usuário acessa Gestão de Documentos > Processo Documento no menu do portal e abre a listagem de processos de documento.
- Opcionalmente, ajusta o filtro de Situação (por padrão, já vem com “Ativo” marcado) e confirma no botão Filtrar, ou digita um termo na busca textual da grid.
- Para cadastrar, clica em Novo; para editar, seleciona um registro na grid e clica em Editar, ou dá duplo clique diretamente na linha.
- No formulário, preenche ou altera Descrição e Situação e clica em Salvar — ou clica em Cancelar para desistir sem gravar.
- Ao salvar com sucesso, o usuário fecha a confirmação exibida e o portal retorna para a listagem de processos de documento com o filtro de Situação anterior preservado.
Interface e Comportamentos da Tela
Grid de listagem de processos de documento
A grid de processos de documento é paginada, com 30 registros por página, e vem ordenada inicialmente pela coluna Id em ordem decrescente. As colunas exibidas são Id, Descrição e Situação; a coluna Situação mostra o texto “Ativo” quando o registro está ativo, e “Inativo” em qualquer outro caso.
O botão Novo da listagem leva direto para o formulário de cadastro de um novo processo de documento. O botão Editar exige que ao menos um registro esteja selecionado na grid. Um duplo clique em qualquer linha da grid abre diretamente o formulário de edição daquele registro.
Filtro de Situação na listagem de processos de documento
O painel de filtros da listagem tem apenas o campo Situação, de múltipla escolha entre Ativo e Inativo; ao abrir a tela, a opção “Ativo” já vem pré-selecionada. O filtro começa recolhido e só é aplicado na grid quando o usuário confirma no botão Filtrar.
Os valores de filtro aplicados ficam guardados por sessão, associados a esta tela, e são restaurados automaticamente quando o usuário volta à listagem — por exemplo, ao retornar da tela de edição.
Busca textual na listagem de processos de documento
A caixa de busca por texto da grid, padrão de toda listagem deste portal, só dispara a pesquisa automaticamente a partir de 3 caracteres digitados; com menos que isso, a busca só ocorre se o campo for esvaziado ou se o usuário pressionar Enter.
Formulário de cadastro e edição de processo de documento
O formulário exige o preenchimento de Descrição (até 100 caracteres) e Situação. A validação ocorre antes de salvar — se algum campo obrigatório estiver inválido, o salvamento é interrompido sem gravar nada.
Quando é um cadastro novo, o campo Situação já vem marcado como Ativo; quando é edição, o campo vem com a situação atualmente gravada do registro.
Ao salvar, o portal decide automaticamente entre cadastrar (novo) ou atualizar (edição) o processo de documento (ver `## Regras de Negócio`).
Ao salvar com sucesso, é exibida a mensagem “Operação efetuada com sucesso.” e, somente depois que o usuário fecha essa confirmação, a tela volta para a listagem. Se o salvamento falhar, é exibido em diálogo de erro o texto de detalhe devolvido pelo servidor, e a tela permanece no formulário — não volta para a listagem. O botão Cancelar volta para a listagem imediatamente, sem confirmar e sem gravar nada, preservando os filtros aplicados anteriormente na grid.
Assim como em toda tela deste portal, as mensagens de confirmação e erro usam um diálogo modal padrão (ícone, título, texto e botão “Ok”), não uma notificação passageira.
Feedbacks ao Usuário
| Situação | Feedback | Texto exato |
|---|---|---|
| Clique em Editar sem nenhum registro selecionado na grid | Aviso inline | “Selecione um registro para editar.” |
| Salvamento de processo de documento (cadastro ou edição) concluído com sucesso | Diálogo modal de confirmação | “Operação efetuada com sucesso.” |
| Falha ao salvar processo de documento (cadastro ou edição) | Diálogo modal de erro | texto de detalhe devolvido pelo servidor para a falha ocorrida — varia conforme a causa da rejeição |
| Processo de documento solicitado para edição não existe mais no momento da consulta | Resposta de erro do servidor | “não encontrado” |
| Erro inesperado ao montar a listagem | Erro genérico de servidor | Nenhum texto de negócio — o portal recebe um erro genérico de servidor, sem detalhe da causa |
Regras de Negócio
Situação do processo de documento (enumeração)
A situação de um processo de documento tem apenas dois valores possíveis: Ativo e Inativo.
Determinação entre cadastro e atualização ao salvar um processo de documento
Enquanto o processo de documento ainda não foi salvo nenhuma vez, o botão Salvar grava um cadastro novo. Depois de salvo pela primeira vez, o mesmo botão Salvar passa a gravar uma atualização do registro existente. As duas operações usam o mesmo botão e o mesmo destino no formulário.
Ausência de exclusão de processo de documento
Não existe operação de exclusão de processo de documento nesta tela: só é possível cadastrar e editar. Um processo de documento cadastrado nunca é removido do sistema por esta tela — para deixar de utilizá-lo, o usuário precisa editar sua Situação para Inativo.
Normalização da Descrição ao gravar um processo de documento
Tanto no cadastro quanto na edição de um processo de documento, a Descrição é gravada sem espaços nas extremidades, mesmo que o usuário digite com espaços a mais.
Auditoria do cadastro e da edição de processo de documento
O cadastro de um novo processo de documento gera automaticamente um registro de auditoria com o usuário responsável. A edição de um processo de documento já cadastrado não gera esse mesmo registro: a alteração não fica registrada na auditoria, apenas o cadastro original.
Busca textual na listagem de processos de documento
Na busca textual da listagem de processos de documento, o texto digitado é comparado, sem diferenciar maiúsculas de minúsculas, contra a Descrição e a Situação (Ativo/Inativo) do processo. Se o texto digitado for um número, ele também é comparado contra o Id do processo de documento.
Filtro por situação na listagem de processos de documento
Quando o filtro de Situação é aplicado, a listagem retorna somente os processos de documento cuja Situação esteja entre os valores selecionados. Sem esse filtro, todos os processos aparecem, tanto Ativos quanto Inativos.
Ordenação e paginação da listagem de processos de documento
A listagem pode ser ordenada por Id, Descrição ou Situação, em ordem crescente ou decrescente, ao clicar no cabeçalho de cada coluna. Ao abrir a tela, a grid já vem ordenada por Id em ordem decrescente.
Troubleshooting
A opção Processo Documento não aparece no menu de Gestão de Documentos
Cenário: o usuário procura o item Processo Documento no menu do módulo Gestão de Documentos e não o encontra.
Mensagem exibida: Nenhuma — o item simplesmente não é exibido no menu.
O que fazer: verificar se o usuário possui o perfil de permissão de visualizar processo de documento; sem essa permissão, o item de menu não é apresentado.
Não é possível cadastrar ou editar um processo de documento mesmo estando na listagem
Cenário: o usuário consegue abrir a listagem de processos de documento, mas não consegue concluir o cadastro ou a edição.
Mensagem exibida: Nenhuma — o acesso ao formulário correspondente é negado.
O que fazer: verificar se o usuário possui o perfil de permissão de cadastrar processo de documento (para novos registros) ou de editar processo de documento (para registros existentes); cada operação exige sua própria permissão.
O botão Editar não faz nada ao clicar na listagem de processos de documento
Cenário: o usuário clica em Editar sem selecionar nenhum registro na grid.
Mensagem exibida: “Selecione um registro para editar.”
O que fazer: selecionar uma linha da grid antes de clicar em Editar, ou dar duplo clique diretamente na linha desejada.
Processo de documento não encontrado ao abrir a edição
Cenário: o usuário tenta abrir o formulário de edição de um processo de documento que foi excluído ou tornado indisponível por outro processo entre a listagem e o clique em Editar.
Mensagem exibida: “não encontrado”
O que fazer: voltar para a listagem e atualizá-la; o processo de documento não está mais disponível para edição.
Erro ao salvar um processo de documento: mensagem de falha exibida no formulário
Cenário: o usuário preenche o formulário de processo de documento e clica em Salvar, mas a operação é rejeitada.
Mensagem exibida: texto de detalhe devolvido pelo servidor no momento da falha (variável conforme a causa).
O que fazer: ler a mensagem exibida no diálogo de erro — ela traz o motivo específico da rejeição — e corrigir os dados do formulário antes de tentar salvar novamente. O portal permanece no formulário, sem perder os dados digitados.
A listagem de processos de documento não abre, com erro genérico
Cenário: ocorre uma falha inesperada ao montar a listagem de processos de documento.
Mensagem exibida: Nenhuma mensagem de negócio — o portal recebe um erro genérico de servidor, sem detalhe da causa.
O que fazer: informar ao responsável técnico, registrando o horário da ocorrência e os filtros usados na tentativa, para investigação.
Não existe botão para excluir um processo de documento
Cenário: o usuário procura uma opção para remover definitivamente um processo de documento da listagem.
Mensagem exibida: Nenhuma — não há botão nem operação de exclusão nesta tela.
O que fazer: editar o processo de documento e alterar sua Situação para Inativo; não há forma de excluir o registro por esta tela.
Alteração de um processo de documento não aparece na auditoria
Cenário: o usuário ou o suporte verifica o histórico de auditoria de um processo de documento após uma edição e não encontra o registro da alteração.
Mensagem exibida: Nenhuma — a edição é salva normalmente, apenas o registro de auditoria da alteração não é gerado.
O que fazer: informar ao responsável técnico; atualmente somente o cadastro original de um processo de documento fica registrado na auditoria, não suas edições.
Casos de Uso
Caso 1 — Cadastro de um novo processo de documento “Auditoria Interna”
O usuário com permissão de cadastrar processo de documento acessa Gestão de Documentos > Processo Documento, clica em Novo, preenche Descrição “Auditoria Interna”, deixa a Situação como Ativo (valor padrão de um cadastro novo) e clica em Salvar. O portal exibe “Operação efetuada com sucesso.” e, após o usuário fechar a confirmação, retorna para a listagem, que volta a mostrar o filtro de Situação “Ativo” aplicado anteriormente, agora incluindo o novo processo.
Caso 2 — Edição de um processo de documento para inativá-lo
O usuário seleciona o processo “Revisão de Fornecedor” na grid (situação Ativo) e clica em Editar. No formulário, altera o campo Situação para Inativo e clica em Salvar. O portal exibe “Operação efetuada com sucesso.” e retorna para a listagem; como o filtro de Situação padrão só traz “Ativo”, o processo “Revisão de Fornecedor” deixa de aparecer na grid até que o usuário inclua “Inativo” no filtro. A alteração de situação, por ter sido feita por edição, não gera registro de auditoria.
Caso 3 — Tentativa de edição sem permissão adequada
Um usuário com permissão de visualizar processo de documento, mas sem a permissão de editar, abre a listagem, seleciona um registro e tenta acessar o formulário de edição. O acesso ao formulário é negado porque a permissão de editar processo de documento é exigida separadamente da permissão de visualizar a listagem.
Caso 4 — Busca por um processo de documento pelo Id
O usuário digita “42” na caixa de busca da listagem. Como o texto digitado é numérico, a busca compara o valor tanto contra o Id quanto contra a Descrição e a Situação dos registros, retornando o processo de documento de Id 42, se existir, além de qualquer outro cujo texto contenha “42”.