O cadastro de Tipo de Documento parametriza as categorias de documento do módulo de Gestão de Documentos (por exemplo, Procedimento Operacional Padrão, Instrução de Trabalho) e define, para cada categoria, quem participa do ciclo de vida do documento — quem pode criar, revisar, aprovar, publicar e visualizar um documento daquele tipo — além do padrão de numeração automática que os documentos daquele tipo vão receber e o prazo padrão em dias para a revisão periódica. É uma tela de parametrização: os documentos em si (criação, revisão, aprovação, publicação) são tratados nas demais telas do ciclo de vida do módulo, que consultam o Tipo de Documento para saber quem é responsável por cada etapa e qual numeração aplicar.

Para que um Tipo de Documento cumpra sua função no fluxo de aprovação, cada uma das cinco etapas (Criado por, Revisado por, Aprovado por, Publicado por, Visualizado por) precisa ter ao menos um responsável configurado — o formulário bloqueia a gravação enquanto algum desses campos estiver vazio (ver Interface e Comportamentos da Tela).

Para vincular um responsável, os usuários ou grupos precisam já existir nos cadastros de Usuários ou de Grupos do portal — o campo de busca de responsável consulta esses cadastros para oferecer as opções de seleção.

O acesso à tela de Tipo de Documento é controlado por permissões específicas, uma por operação: consultar a listagem dos tipos cadastrados exige a permissão de visualização de Tipo de Documento; consultar um registro específico e os responsáveis por cada etapa ou até mesmo editar alguma informação exigem a permissão de edição de Tipo de Documento; criar um novo Tipo de Documento exige a permissão de inclusão de Tipo de Documento.

O Tipo de Documento não tem campo de empresa nem de local: ao contrário da maioria dos cadastros do portal, é único para o cliente inteiro — não existe recorte multiempresa na consulta nem nas gravações relacionadas a este cadastro. A única exceção é a busca de responsável por Grupo dentro do popup de seleção: essa busca específica é recortada pelo contexto de acesso do usuário logado no momento da chamada, mas isso afeta apenas a origem de onde os grupos pesquisáveis vêm — o registro do Tipo de Documento continua sem vínculo de empresa.

Perfil fiscal: não tem acesso à tela, ou seja, não pode adicionar novo ou editar.

1. O usuário acessa Gestão de Documentos e escolhe Tipo de Documento.
2. A listagem abre com os tipos de documento já cadastrados, filtrada pelo filtro de Situação pré-selecionado em “Ativo”.
3. Para criar, o usuário aciona o botão Novo, preenche Descrição, Dias para Revisão, Sigla, monta o padrão de numeração automática e define, para cada uma das cinco etapas do ciclo de vida, a origem (Usuário ou Grupo) e ao menos um responsável; em seguida grava.
4. Para alterar, o usuário seleciona uma linha e aciona Editar, ou dá duplo clique na linha. O formulário abre preenchido com os dados gerais, a máscara de numeração e os responsáveis já configurados de cada etapa.
5. Após gravar com sucesso (criação ou edição), o sistema exibe a confirmação e, ao ser confirmada pelo usuário, redireciona para a tela de edição do próprio registro salvo — não retorna à listagem.
6. Para desistir sem gravar, o usuário aciona Cancelar, que sempre volta para a listagem descartando qualquer alteração feita, sem pedir confirmação.

Listagem de tipos de documento

A grade de Tipo de Documento exibe 30 registros por página e ordena por padrão pela coluna Id em ordem decrescente. As colunas exibidas são Id, Descrição, Dias para Revisão e Situação, sempre com o texto Inativo ou Ativo. O usuário pode ordenar a grade clicando nas colunas Id, Descrição, Dias para Revisão ou Situação; em qualquer situação não reconhecida, a grade ordena por Id.

O botão Editar da grade só age se houver uma linha selecionada. O botão Novo navega para o formulário de cadastro; o botão Editar e o duplo clique numa linha navegam para o formulário de edição do registro selecionado ou clicado.

A busca livre da grade segue o comportamento genérico de toda listagem do portal: só dispara a consulta a partir de 3 caracteres digitados, ao esvaziar o campo, ou ao pressionar Enter (que ignora o mínimo de caracteres); a consulta é adiada 500ms após o usuário parar de digitar. Se o texto digitado for numérico, a busca filtra por Id exato ou por Dias para Revisão igual a esse número; se não for numérico, filtra por Descrição contendo o texto, sem diferenciar maiúsculas de minúsculas.

Painel de filtros da listagem

O painel de filtros tem apenas o campo Situação, em multisseleção, e inicia recolhido. Ao abrir a tela, o filtro já vem com a opção “Ativo” pré-selecionada; a cada consulta da grade, o valor do filtro de Situação é aplicado junto. Os valores de filtro aplicados ficam salvos localmente, mas só são recuperados automaticamente quando a tela é reaberta a partir de um link que carrega esse estado; abrindo a tela normalmente, o filtro sempre reinicia com “Ativo” selecionado, mesmo que o usuário tenha aplicado outro filtro na visita anterior. Ao clicar em Filtrar, o painel verifica a validade do formulário de filtros; se algum campo for inválido, a submissão é interrompida e o painel permanece aberto destacando o campo inválido.

Formulário — dados gerais e numeração automática

Em um novo cadastro, o campo “Próxima Sequência” vem com valor padrão 1 e permite alteração. Quando o cadastro já existe, o campo fica desabilitado, é utilizado somente para leitura, não pode ser alterado na edição. O padrão de numeração automática do documento é montado clicando em elementos que viram blocos coloridos dentro do campo: {SEQ} (sequencial, ex. 1), {TIPO} (sigla do tipo em maiúsculas, ex. POP), {SETOR} (sigla do setor, sempre exibida como “QUAL”, de “qualidade”, no exemplo de pré-visualização), {ANO} (ano com 4 dígitos) e {ANO2} (ano com 2 dígitos); uma prévia de como o número final vai ficar é recalculada a cada alteração e mostrada abaixo do campo. O padrão aceita no máximo 50 caracteres: ao tentar inserir um elemento que ultrapasse o limite, o elemento não é adicionado e é exibido o aviso “O padrão de numeração excede o limite de 50 caracteres.”; digitar texto livre além do limite é bloqueado silenciosamente, sem aviso — o campo apenas para de aceitar novos caracteres. O campo Sigla é convertido automaticamente para maiúsculas e tem os espaços das pontas removidos ao salvar; se, depois dessa limpeza, o campo ficar vazio, o Tipo de Documento é salvo sem sigla.

Formulário — responsáveis pelas etapas do ciclo de vida

Para cada uma das cinco etapas (Criado por, Revisado por, Aprovado por, Publicado por, Visualizado por), um combo define a origem do responsável — Usuário ou Grupo — e controla o campo de busca ao lado. Ao trocar entre Usuário e Grupo, o campo de busca daquela etapa é limpo, reabilitado e passa a pesquisar na origem escolhida. Enquanto nenhuma origem estiver selecionada, o campo de busca correspondente fica desabilitado. Os combos oferecem apenas as opções “Grupo” e “Usuários”; a opção “Função”, usada em buscas de responsável de outras telas do portal, não está disponível aqui.

O componente de busca de responsável é multisseleção: pode ficar com vários usuários (ou grupos) escolhidos ao mesmo tempo. Ao alternar a origem (Usuário/Grupo) de uma etapa, a seleção feita anteriormente só é preservada se já tiver terminado de carregar; caso a troca ocorra antes disso, a seleção anterior se perde e o campo reinicia vazio. Num cadastro novo, os cinco campos de responsável sempre começam vazios, pois não há ainda um Tipo de Documento existente para consultar. Na edição, cada campo recupera automaticamente os responsáveis já configurados para aquela etapa.

Feedbacks — validação do formulário

Feedbacks — retorno do servidor

Numeração automática do documento

O padrão de numeração é uma máscara de texto livre combinada com elementos de substituição: {SEQ} (sequencial), {TIPO} (sigla do tipo de documento em maiúsculas), {SETOR} (sigla do setor do documento), {ANO} (ano com 4 dígitos) e {ANO2} (ano com 2 dígitos). A máscara tem no máximo 50 caracteres.

Próxima Sequência mínima

Tanto na criação quanto na edição, se o valor de Próxima Sequência recebido for menor que 1, o valor gravado é forçado para 1, sem aviso ao usuário. Na tela, esse campo só é editável durante a criação; depois de existir o registro, fica somente leitura.

Etapas do ciclo de vida e seus responsáveis

As cinco etapas do ciclo de vida de um Tipo de Documento são: Criar, Revisar, Aprovar, Publicar e Visualizar. Para cada etapa, a origem do responsável é Usuário ou Grupo — não existe combinação das duas origens na mesma etapa. Cada campo do formulário corresponde a uma dessas etapas: “Criado por” → Criar, “Revisado por” → Revisar, “Aprovado por” → Aprovar, “Publicado por” → Publicar, “Visualizado por” → Visualizar.

Situação (Ativo/Inativo)

A Situação de um Tipo de Documento é Ativo ou Inativo. A listagem sempre exibe o texto correspondente; o valor interno nunca aparece na tela.

Substituição de responsáveis por etapa na edição

Ao editar, cada etapa tem seus vínculos de responsável recalculados por diferença: os identificadores que deixaram de ser enviados são removidos e somente os identificadores novos são criados; identificadores que continuam presentes nos dois lados não são recriados. Trocar a origem de uma etapa (Usuário para Grupo, ou o inverso) equivale a substituir inteiramente a lista de responsáveis daquela etapa, porque a comparação passa a ser feita sob a nova origem.

O Tipo de Documento não integra diretamente com o APP: ele parametriza dados consumidos pelas demais telas do ciclo de vida de Gestão de Documentos dentro do próprio portal (Documentos em Criação, Revisão, Aprovação, Vigentes e Arquivados), que consultam os responsáveis de cada etapa e o padrão de numeração configurados aqui.

T-01 — A opção Tipo de Documento não aparece no menu de Gestão de Documentos

Mensagem exibida: Nenhuma — a opção simplesmente não é listada.
O que fazer: verificar se o perfil do usuário tem a permissão de visualização de Tipo de Documento.

T-02 — O botão de novo registro está desabilitado ou a tela de inclusão não abre

Mensagem exibida: Nenhuma — a ação simplesmente não fica disponível.
O que fazer: verificar se o usuário tem a permissão de inclusão de Tipo de Documento.

T-03 — A edição de um Tipo de Documento não abre

Mensagem exibida: Nenhuma — a ação simplesmente não fica disponível.
O que fazer: verificar se o usuário tem a permissão de edição de Tipo de Documento; sem ela, tanto a visualização detalhada do registro quanto a gravação da edição são recusadas.

T-04 — Não é possível salvar: falta a descrição

Mensagem exibida: “Informe a descrição.”
O que fazer: preencher o campo Descrição antes de salvar.

T-05 — Não é possível salvar: dias para revisão inválido

Mensagem exibida: “Informe os dias para revisão.”
O que fazer: informar um valor numérico maior ou igual a 1 no campo Dias para Revisão.

T-06 — Não é possível salvar: falta a sigla

Mensagem exibida: “Informe a Sigla.”
O que fazer: preencher o campo Sigla; ele é convertido para maiúsculas automaticamente ao salvar.

T-07 — Não é possível salvar: falta responsável em uma das etapas

Cenário: o usuário deixou uma das etapas (Criado por, Revisado por, Aprovado por, Publicado por, Visualizado por) sem nenhum usuário ou grupo selecionado.
Mensagem exibida: “Informe ao menos um responsável para \”{rótulo do campo}\”.”
O que fazer: selecionar ao menos um usuário ou grupo para a etapa indicada na mensagem.

T-08 — O padrão de numeração não aceita mais elementos ou caracteres

Mensagem exibida: “O padrão de numeração excede o limite de 50 caracteres.” (ao tentar inserir um elemento) — ou nenhuma mensagem, com o campo simplesmente parando de aceitar digitação (ao digitar texto livre além do limite).
O que fazer: reduzir o padrão de numeração para caber no limite de 50 caracteres antes de acrescentar novos elementos ou texto.

T-09 — Erro genérico ao consultar quem é responsável por uma etapa

Cenário: uma chamada interna enviou um nome de campo que não corresponde a nenhuma das cinco etapas reconhecidas (Criar, Revisar, Aprovar, Publicar, Visualizar).
Mensagem exibida: “Campo ‘{campo}’ inválido. Valores aceitos: Criar, Revisar, Aprovar, Publicar, Visualizar.”
O que fazer: reportar ao responsável técnico — esse erro não deveria ocorrer a partir do formulário padrão da tela, que só envia os cinco nomes de campo reconhecidos.

T-10 — A busca de responsável no popup retorna erro sem explicação

Cenário: a consulta de usuários ou grupos feita pelo popup de busca de responsável falhou no servidor.
Mensagem exibida: mensagem genérica da falha, sem texto de negócio específico.
O que fazer: repetir a busca; se persistir, reportar ao responsável técnico com a origem selecionada (Usuário ou Grupo) no momento da falha.

T-11 — Um campo de responsável aparece vazio ao abrir a edição de um Tipo de Documento já existente

Cenário: o Tipo de Documento consultado não existe mais, ou nenhum usuário ou grupo continua vinculado àquela etapa.
Mensagem exibida: Nenhuma — o campo de busca daquela etapa aparece sem nenhum usuário ou grupo selecionado, mesmo o registro já existindo.
O que fazer: conferir se os usuários ou grupos originalmente vinculados àquela etapa ainda existem nos cadastros de Usuários ou de Grupos do portal; se necessário, selecionar novamente ao menos um responsável e salvar.

Caso 1 — Criação de um Tipo de Documento para Procedimento Operacional Padrão

A equipe da qualidade cria o tipo “Procedimento Operacional Padrão”, com Sigla “POP”, Dias para Revisão igual a 365, e monta o padrão de numeração como {TIPO}-{SETOR}-{SEQ}/{ANO}. Para cada uma das cinco etapas, seleciona “Usuário” como origem e escolhe um responsável específico. Ao salvar, o sistema confirma “Operação efetuada com sucesso.” e redireciona para a edição do próprio registro criado.

Caso 2 — Configuração de um grupo como responsável pela aprovação

Ao editar o tipo “Instrução de Trabalho”, o usuário troca a origem do campo Aprovado por de “Usuário” para “Grupo” e seleciona o grupo “Coordenação da Qualidade”. Ao salvar, o servidor remove os vínculos de usuário anteriormente configurados para a etapa de aprovação e cria vínculos apenas para o grupo selecionado.

Caso 3 — Tentativa de gravação sem preencher um responsável

Um usuário cria um novo Tipo de Documento, preenche Descrição, Dias para Revisão e Sigla, mas esquece de selecionar um responsável para a etapa Visualizado por. Ao clicar em salvar, o sistema exibe “Informe ao menos um responsável para \”Visualizado por\”.” e mantém o formulário aberto com os dados já preenchidos.

Caso 4 — Consulta de responsáveis ao reabrir um Tipo de Documento existente

Ao abrir a edição do tipo “Instrução de Trabalho” (identificador 12), o sistema busca os responsáveis já configurados de cada uma das cinco etapas e preenche os campos de busca correspondentes antes de exibir o formulário — diferente do cadastro novo, em que os cinco campos sempre iniciam vazios.