Guia do implantador
Guia de quem monta o projeto de guarda de um cliente (arquivista ou implantador): o que o módulo entrega, os conceitos de desenho, o que se define por cliente e como aplicar no sistema.
O projeto de guarda depende do módulo GCVD licenciado e do interruptor Guarda documental (master) ligado. Ver Configuração da guarda.
Exemplos de ponta a ponta: Caso legado e Caso operação.
A data-base (de onde o prazo conta) pode ser uma data ou um evento. Se for evento, ela nasce vazia e é preenchida depois pelo corte por evento (cutoff). Isso precisa estar decidido por tipo documental no levantamento (item 5.3 abaixo), pois muda como a captura preenche os dados e quando o documento entra no corte.
1. Glossário
| Termo | Significado |
|---|---|
| Tipo documental | Propriedade que classifica o documento (por exemplo, "Contrato"). Não é o tipo técnico do documento; a temporalidade pode ser ligada a ele |
| Conferência de legibilidade | Atestação humana de que a imagem está legível e completa (controle de qualidade da PR 1013) |
| Resumo de propriedades | Documento por pasta que lista cada documento com seu hash; assinado, prova a integridade do conjunto |
| Resumo diário | Documento por dia com o que foi processado, assinado em AD-RA; um único carimbo cobre muitos documentos |
| Hash | Impressão digital do arquivo; muda se um bit mudar, o que prova a integridade |
| AD-RB, AD-RT, AD-RA | Políticas ICP-Brasil: RB básica (sem carimbo do tempo), RT com carimbo, RA com carimbo e dados para longo prazo |
| Carimbo do tempo (TSA) | Prova de quando algo foi assinado. AD-RA usa 2, AD-RT usa 1 e AD-RB usa 0 |
| Re-carimbo (LTV) | Manter a assinatura verificável por décadas, re-carimbando antes de o carimbo envelhecer |
| Temporalidade (prazo) | Por quanto tempo o documento é guardado |
| Data-base | A partir de quando o prazo conta: data do documento, da captura ou um evento |
| Corte por evento (cutoff) | Preenche a data-base quando um evento externo ocorre (por exemplo, fim de contrato) |
| Destinação | No vencimento: eliminação (DESTROY), transferência (TRANSFER) ou guarda permanente (PERMANENT) |
| Dossiê | Conjunto de documentos que compartilham o mesmo valor de um identificador (por exemplo, número do prontuário ou CPF), com prazo próprio (rolante). Documentos de tipos diferentes com o mesmo valor caem no mesmo dossiê |
| Perfil de dossiê | Lista de mapeamentos. Cada mapeamento aponta um tipo ou aspecto do modelo, a propriedade identificadora e um filtro opcional (propriedade = valor; vazio inclui todos). Tem prioridade: se dois perfis casam o mesmo documento, vale o de maior prioridade (empate pelo menor identificador). Um documento pertence a um só dossiê de guarda |
| Reconciliação | Rotina que percorre os mapeamentos, une os membros pelo valor do identificador, registra o vínculo com o dossiê e a retenção rolante em cada membro e mantém o consolidado. Cobre nato-digital, upload e migração |
| Retenção rolante | Prazo do dossiê contado a partir da última atividade: documento novo empurra o prazo de todos |
| Bloqueio (hold) | Congelamento que impede descarte e transferência (litígio ou valor histórico), mesmo com o prazo vencido |
| Termo de eliminação | Documento assinado que registra o que foi descartado (defensabilidade e LGPD) |
| Capacidade | Permissão granular atribuída a uma função, independente de a pessoa ser administradora do Alfresco |
| Sigilo | Controle de acesso (quem pode ver o documento), separado de temporalidade e bloqueio; opt-in |
| Nível de sigilo | Eixo hierárquico: quem tem nível maior vê os menores. A escada é configurável por cliente: um nível só ("privado") ou a escada da LAI (Ostensivo, Reservado, Secreto, Ultrassecreto) |
| Marca (need-to-know) | Rótulo não hierárquico de compartimentação, com E lógico: para ver o documento é preciso ter todas as marcas dele |
| Credencial | O que um usuário possui (nível e marcas), comparado com o nível e as marcas do documento |
2. Conceitos de desenho
- A guarda se aplica ao documento, não ao tipo. O documento continua do seu tipo normal e recebe as características da guarda, o que a torna independente da captura e aplicável a um acervo existente.
- Dois controles independentes: Conferência (entrada e qualidade) e Destinação (saída e controle).
- Data-base resolvida na entrada. A data de vencimento é calculada uma única vez (data-base mais prazo). Um documento sem data-base (aguardando evento) nunca entra no corte.
- Dossiê por metadado. O conjunto é definido pelo valor de uma propriedade identificadora, e não pela pasta, funcionando onde quer que os documentos estejam. A reconciliação registra o vínculo e a retenção rolante em cada membro.
3. Capacidades por função
As capacidades são atribuídas a funções na tela Funções do console. O catálogo completo, com as funções prontas por persona, está em Capacidades e funções. As capacidades principais para o levantamento:
| Capacidade | Rótulo no Share | Para que serve |
|---|---|---|
DocReview | Conferir documentos digitalizados (conferência de legibilidade) | Conferir (vê a própria fila) |
DocReviewAdmin | Administrar a conferência (filas de re-digitalização, reatribuir) | Administrar a conferência (todas as filas, reatribuir) |
DocReviewedEdit | Metadados, mover e excluir documento conferido protegido (não troca o binário) | Exceção para editar metadados, mover e excluir documento conferido protegido |
DocRetentionEdit | Metadados e mover documento em guarda (temporalidade; não troca o binário) | Exceção para editar metadados e mover documento em guarda |
DocDispose | Descartar documentos vencidos (temporalidade) | Descartar documentos vencidos |
DocDisposeRequest | Solicitar descarte prematuro (em guarda, não vencido) | Pedir descarte prematuro |
DocDisposeApprove | Aprovar/rejeitar descarte prematuro | Aprovar ou rejeitar pedidos de descarte |
DocReclassify | Reclassificar a destinação de documento em guarda | Reclassificar a destinação (auditado) |
DocHold | Colocar bloqueio + pedir a liberação (litígio / valor histórico) | Bloquear e pedir liberação |
DocHoldRelease | Aprovar/rejeitar pedidos de liberação de bloqueio | Aprovar ou rejeitar liberação |
RetentionAdmin | Gerenciar a tabela de temporalidade | Tabela de temporalidade, corte por evento, perfis de dossiê, reconciliação e migração do legado |
DossierView | Ver o inventário/relatórios de dossiês | Ver inventário e relatórios de dossiês (leitura) |
PreservationAdmin | Executar o batch de preservação (propriedades/resumo/assinatura) | Preservação (lote, diária, reassinatura, estimativa de custo) |
ConfidentialityAdmin | Gerenciar sigilo (níveis, marcas, credenciais) | Administrar o sigilo |
DocConfidentialityClassify | Classificar documento/pasta (definir sigilo) | Definir o sigilo de um documento |
DocConfidentialityReclassify | Reclassificar sigilo (mudar nível/marcas) | Reclassificar o sigilo |
DocConfidentialityDeclassify | Desclassificar documento/pasta | Remover o sigilo |
Administradores recebem tudo automaticamente. Para funções segregadas, crie funções específicas. As ações por dossiê reaproveitam as capacidades de guarda; a única capacidade própria de dossiê é DossierView.
4. O que se define por cliente (modelo de levantamento)
O sistema entrega as etapas e as capacidades prontas; o cliente define o conteúdo e quem. Preencha as tabelas abaixo no levantamento.
4.1 Papéis
| Etapa | Capacidade | Quem no cliente [preencher] |
|---|---|---|
| Conferir | DocReview | |
| Administrar conferência | DocReviewAdmin | |
| Gestor de retenção (temporalidade, corte, dossiê, migração) | RetentionAdmin | |
| Descartar vencidos | DocDispose | |
| Pedir descarte | DocDisposeRequest | |
| Aprovar descarte | DocDisposeApprove | |
| Reclassificar, bloquear e aprovar liberação | DocReclassify / DocHold / DocHoldRelease | |
| Ver inventário de dossiês | DossierView | |
| Preservação | PreservationAdmin | |
| Administrar sigilo (níveis, marcas, credenciais) | ConfidentialityAdmin | |
| Classificar, reclassificar e desclassificar sigilo | DocConfidentialityClassify / DocConfidentialityReclassify / DocConfidentialityDeclassify |
O sigilo é opt-in. Só entra no plano se o cliente precisa de controle de acesso por documento, além de temporalidade e bloqueio. Decida a escada de níveis (um nível só ou a escada da LAI) e o catálogo de marcas; depois atribua as credenciais (nível e marcas) a cada usuário. O sigilo é definido documento a documento; não há rótulo único herdado por um dossiê.
4.2 Estrutura de pastas e nomenclatura
O módulo não impõe estrutura de pastas. Recomenda-se uma hierarquia por unidade de arquivamento e nomes de arquivo compostos por metadados estáveis (identificador, data e tipo). O repositório já dá um identificador único a cada documento, sem necessidade de numeração paralela. [preencher: árvore do cliente]
4.3 Tipos documentais
| Código | Tipo documental | Origem (interna/externa) | Cor | Resolução | Duplex | OCR | Compressão | Observações |
|---|---|---|---|---|---|---|---|---|
4.4 Metadados do Anexo II (de-para)
Preencha apenas a coluna da fonte no cliente.
| Metadado | Como o sistema preenche | Fonte no cliente [preencher] |
|---|---|---|
| Assunto | Tabela do tipo ou manual | |
| Tipo documental | Lista ou manual na captura | |
| Data de digitalização | Automático | |
| Responsável pela digitalização | Automático (usuário logado) | |
| Local / pessoa jurídica | Fixo (parâmetro) | |
| Revisão (quem e quando) | Automático (conferência) | |
| Prazo e destinação | Tabela de temporalidade ou perfil de dossiê | |
| Hash | Automático |
4.5 Temporalidade
| Tipo documental | Prazo (meses) | Data-base | Destinação | Fundamento |
|---|---|---|---|---|
| data do documento, captura ou evento | DESTROY, TRANSFER ou PERMANENT |
Data-base por evento: deixe vazia no plano; o corte por evento a preenche quando o evento ocorre. O prazo do dossiê (rolante) não entra nesta tabela; vai no perfil de dossiê.
4.6 Política de assinatura (recomendada)
Documento em AD-RB (sem carimbo, custo zero por documento). Resumo diário em AD-RA (uma assinatura carimba o lote). Resumo de propriedades em AD-RB ou AD-RA conforme a exigência. [preencher: templates de certificado]
5. Como aplicar
Pré-requisito: sistema no ar e usuário administrador.
5.1 Funções e capacidades
No Console, tela Funções (capacidade RolesAdmin), crie as funções do item 4.1 e atribua usuários e grupos. O botão Popular com roles da guarda cria as funções por persona.
5.2 Captura: tipos e metadados
No ScanDesigner, por tipo documental, defina os parâmetros de digitalização (cor, resolução, duplex, OCR e compressão) e os metadados (tipo documental, assunto, datas etc.). Para que o documento já nasça com temporalidade, envie as propriedades de retenção na captura; o sistema aplica a temporalidade sozinho. A conferência é ligada por um interruptor no inspector (por documento ou por pasta); a proteção do conferido é uma opção global na tela Configuração da guarda.
300 dpi e PDF/A são opções configuráveis por fluxo de captura, não um mínimo imposto pelo sistema.
5.3 Temporalidade
- Por tipo: preenchida na captura ou pela migração do legado (item 5.5).
- Corte por evento: a ação de corte (capacidade
RetentionAdmin) preenche a data-base quando o evento ocorre, por documento ou pasta, de forma idempotente. Antes disso o documento fica sem vencimento e fora do corte.
5.4 Dossiê: perfis, reconciliação e inventário
São três telas separadas no Console.
Retenção (perfis) (grupo Dossiê, capacidade RetentionAdmin): cadastro dos perfis, com editor em abas Mapeamentos e Retenção e coluna Documentos (contagem por perfil). Cada mapeamento tem:
- Documentos: um tipo ou aspecto do modelo, selecionável.
- Identificador: a propriedade cujo valor identifica o dossiê (por exemplo, número do prontuário ou CPF). Documentos de mapeamentos diferentes com o mesmo valor caem no mesmo dossiê.
- Filtro (opcional):
propriedade = valor; vazio inclui todos os documentos daquele tipo ou aspecto.
Na aba Retenção: prazo (meses ou anos), base (agora, atividade ou uma data de outra propriedade), destinação e prioridade do perfil.
Reconciliação de dossiês (tela própria, RetentionAdmin): agendamento, Simular (com a opção Detalhado, que lista cada documento com dossiê, chave, nome, pasta, destinação e vencimento, e exporta em CSV), Reconciliar agora e histórico com exportação (CSV, HTML e PDF). É auditada, respeita manutenção e preservação e pode ser interrompida.
Inventário de dossiês (leitura, grupo Dossiê, capacidade DossierView): lista os dossiês (vencidos, permanentes, bloqueados, sem prazo), as operações por dossiê (bloquear, reclassificar, solicitar e executar descarte, corte por evento) e a ação Dissolver, que remove o vínculo preservando a retenção dos documentos, com prévia e confirmação. Apagar um perfil também dissolve os dossiês dele antes de excluir.
5.5 Migração de metadados do legado
No Console, grupo Migração de metadados, telas Perfis (de-para) e Aplicar migração. O perfil mapeia as propriedades do cliente para a guarda: temporalidade e, opcionalmente, digitalização (incluindo o tipo documental) e conferência; o modal do perfil tem uma aba por item. Cada campo pode ser lido do legado (seletor) ou receber um valor fixo, com fallback opcional. O dry-run (com limite) precede a aplicação, que é aditiva, idempotente por propriedade e tem histórico e exportação. Exemplo completo no Caso legado.
Detalhes do destino Classe do perfil estão em Migração do legado.
5.6 Conferência
A conferência é ligada pelo interruptor do inspector (documento ou pasta). Depois de ligada, a fila fica no cabeçalho Guarda documental; a recusa (com motivo) gera nova digitalização e a aprovação libera o documento. A proteção do conferido é global, na tela Configuração da guarda.
5.7 Preservação
Console, grupo Preservação (capacidade PreservationAdmin): lote, diária (agendada), reassinatura e estimativa de custo (carimbo do tempo). A política AD-RB, AD-RT ou AD-RA é definida por projeto (item 4.6). A opção Exigir conferência na preservação fica na tela Configuração da guarda. Ver Preservação de longo prazo e Verificador de versões.
A renovação de validade das assinaturas (LTV) é feita pela reassinatura; a re-checagem periódica do hash contra o arquivo, com alerta automático de divergência, não é automática, e a verificação continua sendo responsabilidade periódica do administrador.
5.8 Compressão
Sem perda por padrão (aderente às normas); a compressão com perda controlada é opcional, por escolha do cliente.
5.9 Sigilo (opt-in)
Módulo de controle de acesso por documento, ligado somente quando o cliente precisa. Tela Sigilo no Console (capacidade ConfidentialityAdmin): define a escada de níveis, o catálogo de marcas e as credenciais dos usuários. No documento, a ação Definir sigilo (nível e marcas), o cadeado na listagem e a indicação no cartão Proteções do documento. O sigilo é independente de guarda e bloqueio: qualquer combinação é válida. A desclassificação automática ao vencer o prazo é feita por rotina diária (interruptor Desclassificação automática por prazo); a manual está sempre disponível. Detalhes em Sigilo.
6. Ciclo de vida
CAPTURA (tipo documental, metadados do Anexo II, hash, OCR, compressão)
v
CONFERÊNCIA de legibilidade --recusado--> nova digitalização
v conferido = OK
PRESERVAÇÃO: assina (AD-RB) + resumo de propriedades + PDF/A + resumo diário AD-RA
v
TEMPORALIDADE: vencimento = data-base + prazo (data-base por data ou por evento; ou rolante por dossiê)
v
GUARDA pelo prazo, com proteção (conferido e em guarda: o conteúdo ninguém troca;
metadados só com capacidade; em guarda só sai pelo descarte)
v
DESTINAÇÃO:
- DESTROY -> descarte controlado (vencido direto ou prematuro com aprovação) -> termo assinado
- TRANSFER -> três idades + guia/termo de transferência assinado, por documento e por dossiê
- PERMANENT -> nunca é descartado
(O bloqueio congela qualquer saída; a reclassificação de destinação é auditada; tudo vale também por dossiê)
A preservação e o arquivamento aguardam a conferência. Por padrão, a assinatura manual antes da conferência não é bloqueada; o interruptor Bloquear assinatura antes da conferência (ver Conferência de legibilidade) liga esse bloqueio.
7. Auditoria
Console, tela Auditoria, com filtro de eventos em menu aninhado (categoria, subgrupo, evento). A Guarda documental abre em Conferência, Temporalidade, Descarte, Bloqueio, Dossiê e Configurações; selecionar um grupo filtra por todos os filhos, ordenado por data.
Eventos da guarda incluem: documento digitalizado; aprovado ou reprovado na conferência de legibilidade; temporalidade com data-base definida; temporalidade migrada do legado; descarte prematuro solicitado, aprovado ou rejeitado; documento descartado; destinação reclassificada; colocado em bloqueio e liberação de bloqueio; reconciliação de dossiês executada (por execução) e carimbado pela reconciliação (por documento); e configuração da guarda alterada (com valor anterior e novo no detalhe). As rotinas de preservação e reconciliação têm histórico próprio com exportação.
A trilha é imutável: nunca é interrompida nem apagada, não há botões de parar ou limpar, e o sistema a religa na inicialização se estiver desligada. A trilha grava usuário, hora e documento; a cobertura de IP e estação de origem é parcial. Ver Auditoria.
8. Checklist de montagem
- Plano preenchido (papéis, pastas, tipos, metadados, temporalidade, assinatura).
- Funções e capacidades criadas.
- Tipos e metadados no ScanDesigner.
- Temporalidade por tipo e corte por evento, se houver.
- Retenção (perfis) de dossiê e reconciliação agendada.
- Migração do legado, se houver base antiga.
- Conferência ligada, se o projeto a utiliza.
- Preservação e política de assinatura.
- Sigilo, se o projeto o utiliza (opt-in): escada de níveis, marcas e credenciais.
- Auditoria conferida.