Regras de negócio da guarda
Esta página reúne, em um só lugar, as regras que governam o comportamento da guarda documental: quem define a temporalidade, quando ela é ou não gravada, o que trava um documento, quem pode mexer e como o sistema se comporta nos casos de borda. Cada regra é detalhada na página do assunto, indicada ao final de cada seção.
Estados de um documento
| Estado | Significado |
|---|---|
| Em guarda | O documento tem temporalidade definida: destinação, prazo, data-base e expiração. |
| Classificado | O documento está ligado a uma classe-folha do plano de classificação. |
| Em conferência / conferido | O documento está na fila de conferência de legibilidade (pendente) ou já foi aprovado. |
| Em bloqueio (hold) | O documento está congelado por litígio ou valor histórico. |
| Com termo de eliminação | Existe o registro legal imutável do descarte. |
| Sigiloso | O documento tem nível e/ou marcas que restringem quem pode enxergá-lo. |
| Membro de dossiê | O documento pertence a um dossiê de guarda. |
Os estados são independentes entre si. Um documento pode estar, ao mesmo tempo, em guarda, sigiloso e em bloqueio.
Disponibilidade dos recursos
- A guarda nasce desligada. Existe um interruptor geral, Guarda documental (master), e um interruptor por área (conferência, bloqueio, classificação, dossiê, preservação e outros).
- Um recurso só está ativo quando o interruptor geral e o da área estão ligados.
- As proteções são fail-closed: se o estado de uma proteção não puder ser lido na inicialização do sistema, ela é tratada como ligada. Uma proteção sem configuração registrada é tratada como desligada.
- A configuração é lida em tempo de execução. Alterar um interruptor não exige reiniciar o sistema.
Ver Configuração da guarda e Licenciamento.
Temporalidade
A temporalidade é gravada por um único mecanismo, seja qual for o caminho de origem: classificação, reaplicação de classe, migração do legado, dossiê, ingestão na captura ou edição manual. As regras abaixo valem para todos eles.
- Sem regra, sem guarda. Se a classe ou o perfil não define destinação nem prazo, o documento não entra em guarda. Nunca existe documento em guarda sem vencimento.
- Guarda existente não é sobrescrita em silêncio. Ao classificar ou migrar, um documento que já está em guarda mantém a temporalidade que tem. Trocar a temporalidade é um ato explícito: reaplicar a classe ou o ajuste feito pelo dossiê.
- O dossiê é a autoridade. Um documento membro de dossiê nunca tem a retenção escrita pela classe nem pela migração. Ele recebe apenas tipo documental e conferência. Destinação e prazo vêm do perfil do dossiê.
- A data-base só avança. Quando a data-base é recalculada, ela nunca encurta: vale a mais recente entre a atual e a nova. A saída de um membro do grupo não antecipa o vencimento dos demais.
- Expiração é data-base mais prazo. A data-base vem do modo da regra: hoje (data da classificação), propriedade (uma data do próprio documento) ou evento (fica em branco, e o documento aguarda um corte por evento).
- Datas são sempre em UTC. O dia de vencimento é o mesmo em todas as telas e rotinas, independentemente do fuso do servidor.
Ver Temporalidade e retenção e Três idades e transferência.
Classificação
- Só uma classe-folha ativa pode classificar documentos. Classificar um documento que já está classificado é recusado, porque a regra da classe é congelada no documento no momento da classificação.
- O sistema recusa a classificação quando o recurso está desligado, o item não é um documento, a classe não existe, está inativa ou não é folha, ou o documento está protegido por termo ou bloqueio.
- Ao classificar, o sistema grava a classe (com quem classificou e quando), o tipo documental da classe e a temporalidade, respeitando as regras de temporalidade acima. Se a classe exige conferência e o recurso Conferência está ligado, o documento vai para a fila de conferência.
- Editar uma classe não altera os documentos já classificados. Para propagar a regra, usa-se Reaplicar classe.
- Reaplicar classe pula documentos protegidos, vencidos e sem conteúdo (informando o motivo), preserva a data-base já existente, só passa a exigir conferência (nunca dispensa uma já pedida), só reescreve o tipo documental quando ele de fato muda e não reescreve a retenção de documentos de dossiê.
- Uma classe-folha que já tem acervo não pode ganhar filhos, para não deixar documentos órfãos nos seletores.
- Excluir ou dissolver uma classe remove o vínculo de classe e preserva a temporalidade. Documentos protegidos são pulados e a tela informa quantos ficaram.
Ver Classificação.
Migração do legado
Cada documento recebe um plano antes de qualquer gravação (na simulação, nada é escrito):
| Plano | Quando | O que faz |
|---|---|---|
| Copiar | O legado já tem uma expiração válida. | Copia a expiração, respeitando a guarda vigente. |
| Calcular | Há data-base e prazo. | Calcula a expiração. |
| Evento | Há prazo, mas não há data-base. | Entra em guarda aguardando o corte por evento. |
| Revisar | Falta o prazo ou a destinação não está mapeada. | Fica para revisão manual, sem gravar valores errados. |
| Já em guarda | O documento já está em guarda. | Não altera a temporalidade. A guarda vigente prevalece sobre a migração. |
| Classificar | O perfil manda classificar. | Delega à classificação. |
| Só metadados | Há apenas metadados a portar. | Grava somente os metadados. |
- A destinação é traduzida por um de-para. Valores canônicos passam direto, e o que não for reconhecido vai para revisão, nunca para uma destinação errada.
- Ao classificar por valor, o casamento ignora maiúsculas, espaços e acentos. Em campos com vários valores, cada valor é tentado. Valor sem correspondência vai para revisão.
- A simulação valida a classe de destino pela mesma regra da aplicação, de modo que a estimativa não promete o que a aplicação recusaria.
Ver Migração do legado.
Proteção do documento
O que é um documento protegido
- Sempre protegidos, pela simples presença da marca: documento com termo de eliminação e documento em bloqueio (hold). Nem o administrador altera. Só a conta de serviço do sistema atua, para criar e assinar.
- Protegidos conforme a configuração: documento em guarda e documento conferido. Só travam quando a opção correspondente (Proteger documentos em guarda e Proteger documentos conferidos) está ligada.
Binário absoluto
Com a proteção ligada, o conteúdo do documento deixa de ser trocável por qualquer usuário, inclusive administradores. Isso inclui subir nova versão, editar online ou offline, reverter para outra versão e as transformações de PDF (rotacionar, mesclar, marca d'água, numeração, PDF/A, criptografia, entre outras). Passam apenas a assinatura por usuário e as contas de serviço (captura, preservação e descarte).
- O mesmo vale para o documento digitalizado quando Binário do digitalizado imutável está ligado.
- O check-out e qualquer reversão de versão são recusados antes de qualquer mudança. Isso inclui a reversão para uma versão anterior à conferência.
- Excluir uma versão individual do histórico também é recusado.
- Quando o documento está em mais de um estado, vale o mais restritivo.
- Uma regra de pasta que transforma PDF (por exemplo, PDF/A ou marca d'água) passa a falhar para esses documentos quando roda com um usuário real. Quando falha em cinco documentos, o alerta de falha sistêmica de regra de pasta é disparado.
- Excluir uma pasta que contenha, em qualquer nível, documento protegido é recusado para o usuário.
Quem pode mexer em um documento em guarda
| Operação | Quem pode |
|---|---|
| Alterar propriedades e mover | Quem tem a capacidade DocRetentionEdit, ou o serviço |
| Trocar o conteúdo | Ninguém, com a proteção ligada. Passam apenas a assinatura por usuário e o serviço |
| Editar offline ou reverter versão | Ninguém, com a proteção ligada |
| Excluir | Ninguém por edição. Somente pelo fluxo de descarte |
| Remover a marca de guarda | Somente o descarte |
- Termo e bloqueio são incondicionais. Congelam alteração e exclusão sem exceção de capacidade. Só saem pelo fluxo próprio: a liberação do bloqueio, e o termo nunca sai.
- O cartão Proteções do documento mostra as travas ativas e, para cada uma, se o usuário pode editar.
- O sigilo não é uma proteção de alteração. Ele controla quem enxerga o documento, mas não congela edição nem exclusão.
- As capacidades da guarda valem para todo o repositório. Quem as recebe age no acervo inteiro, atravessando sites. A fronteira de autorização é a capacidade, e não a permissão por documento. Conceda a capacidade apenas a quem deve agir no acervo todo.
Ver Capacidades e papéis e Matriz de ações do documento.
Cartões de metadados: o que é editável
Os campos da guarda são gravados pelos fluxos do sistema, não digitados à mão.
| Campos | No cartão de metadados |
|---|---|
| Algoritmo, valor do hash e hash de conteúdo | Somente leitura. O algoritmo é único para toda a instalação. |
| Digitalização (quem digitalizou, data) | Somente leitura |
| Conferência (resultado, quem conferiu, quando, observações) | Somente leitura |
| Bloqueio (tipo, motivo, quem bloqueou, quando) | Somente leitura |
| Cifragem (quem cifrou, quando) | Somente leitura |
| Identificador único do documento | Oculto |
| Conformidade com o Decreto, sigilo, dossiê e termo de eliminação | Ocultos nos campos, exibidos pelos cartões próprios |
| Vínculo entre o documento e o seu resumo de propriedades | Somente leitura |
| Temporalidade (destinação, prazo em meses, data-base) | Editável por quem tem DocRetentionEdit. A data de expiração é sempre calculada |
A trava real da temporalidade é feita no servidor: mesmo que o cartão mostre o campo, só aceita a gravação quem tem a capacidade e com a proteção ligada.
Hash e identidade
- O identificador único é gravado uma vez e nunca muda.
- O hash-base e o hash por página são derivados do conteúdo e recompostos pelo sistema toda vez que o conteúdo muda. O usuário nunca os edita.
- Recompor o hash não cria versão e não altera a data de modificação do documento, de modo que o histórico não é poluído e a preservação diária não redescobre o documento à toa.
- As ações de transformação de PDF incorporam os metadados e o hash corretos ao arquivo antes de fechar a operação e criam a sua própria versão em seguida. A versão gravada já sai coerente.
Ver Decreto 10.278 e Verificador de versões.
Descarte controlado
Quem está elegível
Um documento está elegível ao descarte quando está em guarda, tem destino final eliminação, está na fase final do ciclo e a expiração é igual ou anterior a hoje.
- O bloqueio congela o descarte. Mesmo vencido, um documento em hold não é descartado.
- Guarda permanente nunca é destruída por vencimento.
- Um documento em fase intermediária não é descartado por vencimento. Ele transita para a próxima fase.
Fluxos
- Vencidos: são listados em Controle de descarte. Quem tem a capacidade DocDispose descarta.
- Descarte prematuro: é pedido por quem tem DocDisposeRequest e aprovado por quem tem DocDisposeApprove. Vale somente para destino final eliminação. Documento de guarda permanente não oferece descarte prematuro.
- Destruir uma guarda permanente exige reavaliação. O caminho é reclassificar o destino final para eliminação de forma explícita, com a capacidade DocReclassify, o que é auditado e pode exigir aprovação conforme a política, e só então descartar. A trilha registra que alguém assumiu que o documento não é mais permanente, nunca em silêncio. A mesma regra serve para antecipar a eliminação de qualquer documento: reclassificar o destino e usar o descarte prematuro.
- Liberação de bloqueio: é feita por requerimento e aprovação.
Garantias do descarte
- Registro antes de apagar: localização, nome, pasta, vencimento e hash são registrados antes da exclusão, na tela Removidos pela guarda.
- Termo de eliminação: cada operação de descarte gera um PDF assinado, registro legal imutável, guardado em pasta própria.
- Trava final: se um documento protegido chegar ao ponto da exclusão por qualquer falha de fila ou filtro, a operação é abortada. Nunca se destrói um documento protegido. Os protegidos são pulados, com o motivo, antes disso, para não abortar o lote.
- Aviso diário: um resumo dos vencidos é enviado por e-mail a quem tem DocDispose.
Ver Descarte controlado e Bloqueio (hold).
Dossiês de guarda
Um dossiê agrupa documentos que compartilham temporalidade, como os de um mesmo processo.
- A temporalidade do grupo manda sobre a de cada membro.
- O dossiê pode encurtar a expiração própria. A data-base só avança, mas o prazo é substituído: um membro que entra com prazo próprio maior passa a vencer em data-base efetiva mais prazo do perfil, o que pode ser antes da expiração que ele tinha. O encurtamento não é bloqueado, é sinalizado na simulação, na prévia do perfil, no histórico da execução, na auditoria por documento e em um aviso no formulário do perfil. Use retenção por dossiê para documentos sem temporalidade própria. Para documentos que já têm, use o perfil só agrupamento.
- Dissolver o dossiê não restaura a temporalidade anterior. O documento fica com a destinação, o prazo, a data-base e a expiração que o dossiê deixou, e a temporalidade de antes do dossiê não é guardada.
- A temporalidade da classe volta por reaplicação. Depois de dissolver, com o perfil desativado (senão o vínculo é recriado), Reaplicar classe devolve destinação e prazo da classe e preserva a data-base, que passa a ser a do dossiê. A expiração resultante é igual ou posterior à original, nunca anterior. Não voltam: documento sem classe, documento já vencido e documento protegido.
- A data-base é do mapeamento, não do perfil. Cada mapeamento define de onde os seus documentos tiram a data-base: agora, aguardar evento ou um campo de data do próprio tipo ou aspecto. Campo vazio no documento significa aguardar evento. Prazo e destinação seguem no perfil.
- A data-base do grupo é a mais recente entre os membros que rolam, qualquer que seja o mapeamento de origem, e a expiração de cada membro é essa base mais o prazo. A saída de um membro não antecipa o grupo.
- Só são membros os documentos aprovados na conferência ou que não passam por conferência. Documentos pendentes, reprovados ou em refação não contam, não rolam e não são carimbados. Aparecem como pulados, com o motivo, na reconciliação e como candidatos na tela, para decidir incluí-los em um descarte do tipo Todos.
- Mínimo de membros: cada perfil tem um mínimo, com padrão 2. Um único documento é avulso, não dossiê. Abaixo do mínimo o vínculo não é criado. Se o grupo encolhe abaixo do mínimo, o vínculo é desfeito e a retenção é preservada.
- Um documento pertence a um só dossiê. Havendo mais de um candidato, vale a prioridade da definição.
- O descarte do dossiê escolhe o escopo, congelado no pedido: Membros (padrão), Só aprovados ou Todos.
- A reconciliação mantém tudo em sincronia, roda como serviço, não gera versões à toa e respeita o modo de manutenção.
Ver Dossiê.
Preservação e assinatura
- A preservação gera um resumo de propriedades por pasta ou site, com o hash de cada documento, e o assina. Um carimbo do tempo cobre vários documentos.
- Não reassina o que já está adequado. Se o documento já tem assinatura do mesmo certificado com política igual ou maior, não reassina, evitando gasto de carimbo. A opção de forçar a assinatura ignora essa verificação.
- A ordem das políticas de assinatura é: sem assinatura, AD-RB, AD-RT, AD-RA. O número de carimbos por assinatura é 2 para AD-RA, 1 para AD-RT e 0 para AD-RB ou sem política. É a base da estimativa de custo, que conta os carimbos sem assinar.
- A preservação pula documentos protegidos por termo ou bloqueio e, quando exigido, processa apenas documentos que passaram pela conferência.
- A reassinatura renova periodicamente a fé de longo prazo dos resumos.
Ver Preservação de longo prazo.
Auditoria
- Uma ação sobre um documento é auditada contra o próprio documento. Uma mudança de configuração ou de regra é auditada sem documento, e a identidade vai no valor registrado.
- No descarte, o evento é gravado depois que o documento foi apagado. Por isso nome, caminho completo, tipo, função do operador e proteções ativas são capturados antes da exclusão. O botão passa a ser Ver auditoria, porque a trilha sobrevive à exclusão.
- A trilha é imutável e sempre ligada. Não é possível pará-la nem apagá-la, nem pelo administrador e nem pelas APIs do Alfresco; a tentativa é recusada e registrada no log do servidor.
- O ator registrado é o usuário real, mesmo quando a operação roda com a conta de serviço. Operações de sistema e de segundo plano são registradas com a conta de serviço.
- Durante a janela de manutenção (backup), o repositório fica somente leitura e as escritas ficam bloqueadas. Cada visualização ou download feito na janela é guardado de forma durável e enviado à auditoria quando o repositório volta a aceitar escrita, preservando a hora e o usuário reais. O login e o logout feitos durante a janela não são auditados.
Ver Auditoria.
Sigilo
O sigilo define quem enxerga o documento. É independente da temporalidade (quanto tempo guardar) e do bloqueio (congelar). É opcional e nasce desligado. Tem dois eixos que coexistem:
- Nível: grau hierárquico, como Ostensivo, Reservado, Secreto e Ultrassecreto. Quem tem o nível do documento ou superior enxerga. A escada de níveis é configurável, podendo ter um único nível ou a escada completa.
- Marcas: compartimentos de need-to-know, sem hierarquia, como RH, Financeiro e Jurídico. Para enxergar, é preciso ter todas as marcas do documento.
Um documento pode ter só nível, só marcas, os dois ou nenhum.
| Ação | O que faz |
|---|---|
| Definir sigilo | Aplica nível e marcas e restringe o acesso na hora. O documento some da busca e da listagem de quem não tem a credencial. É auditado. |
| Reclassificar | Troca nível e marcas, e o acesso é recalculado na hora. É auditado. |
| Desclassificar | Remove o rótulo e devolve o documento ao acesso normal. É auditado. |
As três operações usam a mesma ação Definir sigilo, controlada pelas capacidades DocConfidentialityClassify, DocConfidentialityReclassify e DocConfidentialityDeclassify, com o recurso ligado.
- O acesso é realmente restrito, e não apenas escondido na tela: quem não pode não recebe o documento em busca, listagem nem link.
- Leitores e escritores: cada credencial tem dois grupos. A leitura permite ver. A escrita permite editar, e quem escreve sempre lê. O sigilo nunca concede exclusão. Para apagar um documento sigiloso que não está em guarda, desclassifica-se e apaga-se. Em guarda, a exclusão é somente pelo fluxo de descarte.
- A conta de serviço da guarda enxerga tudo, inclusive documentos sigilosos, e por isso as rotinas automáticas continuam atuando sobre eles.
- Trava de permissão manual (padrão ligada): em um documento sigiloso, a alteração manual de permissões é barrada, inclusive para o dono. O acesso é controlado somente pela credencial.
- Sigilo, guarda e bloqueio são independentes. Qualquer combinação, em qualquer ordem, é válida: definir sigilo em um documento em guarda ou em bloqueio, colocar em guarda ou em bloqueio um documento sigiloso, ou ter os três ao mesmo tempo. Cada eixo age no seu domínio.
- Marcas: são um vocabulário controlado, gerido na tela de Sigilo (criar, renomear, excluir), com contadores de quem tem cada credencial. Excluir uma marca em uso é bloqueado: é preciso reclassificar os documentos antes.
- Prazo de sigilo: o diálogo Definir sigilo tem um campo de prazo. Uma rotina diária desclassifica automaticamente os documentos cujo prazo venceu, e a ação é auditada. Exige o recurso Sigilo ligado e a opção de desclassificação automática (padrão ligada). Prazo em branco significa sem desclassificação automática.