Gestão de Documentos

Este guia detalha como criar, visualizar, editar e gerenciar documentos no ArqSystem.

Visão Geral

O ArqSystem oferece gestão completa de documentos arquivísticos seguindo as normas do CONARQ (Conselho Nacional de Arquivos).

Funcionalidades Principais

Cadastro de documentos com campos dinâmicos
Vinculação de arquivos PDF e imagens
Controle de acesso baseado em níveis CONARQ
Busca full-text em todos os campos
Auditoria completa de alterações
Relacionamento entre documentos

Dashboard

A dashboard é a página inicial do sistema, acessível em /dashboard.

Acesso Público vs Autenticado

Visitantes (não autenticados):

Visualizam apenas documentos públicos
Acesso aos cards de métricas (se habilitados)
Sem acesso a botões de ação

Usuários autenticados:

Visualizam documentos conforme permissões
Acesso completo aos cards
Ações de criar, editar e excluir

Cards de Métricas

A dashboard exibe cards configuráveis no topo:

Total de Documentos:

Quantidade total de documentos cadastrados
Ícone de documento (azul)
Configurável em /settings?tab=painel

Recentes (7 dias):

Documentos cadastrados nos últimos 7 dias
Ícone de relógio (verde)
Configurável em /settings?tab=painel

Listagem de Documentos Recentes

Tabela com os últimos 10 documentos cadastrados:

Coluna	Descrição
Nº	Número sequencial
ID Digital	UUID único
Título	Nome do documento
Data Inserção	Data e hora de cadastro
Acesso	Botão "Ver" para visualização

Link "Ver todos" no canto superior direito leva para /documents.

Card Conformidade CONARQ

Informações sobre validação automática:

Campos Obrigatórios (indicador azul):

Sistema valida automaticamente os campos exigidos pelo CONARQ

Classificação (indicador preto):

Certifique-se de preencher o Nível de Acesso para conformidade legal

Botão "Novo Registro" para iniciar cadastro.

Listagem de Documentos

Página completa de gestão de documentos, acessível em /documents.

Controle de Acesso

Visitantes:

Apenas documentos públicos
Sem botões de ação

Usuários autenticados:

Botão "+ Novo Documento" visível
Ações completas: Ver, Editar, Excluir
Acesso baseado em permissões

Sistema de Busca

Campo de busca global no topo da página.

Placeholder: "Buscar por título, número ou palavras-chave..."

Campos pesquisáveis:

Título do documento
ID Digital
Número do documento
Autor
Palavras-chave
Descrição
Tipo de documento
Órgão vinculado

Tecnologia: Busca powered by Sonic

Tolerância a erros de digitação
Busca fuzzy
Resultados ordenados por relevância

typescript

// Exemplo de busca
GET /documents?search=relatorio anual 2024

// Resultados incluem variações:
- "Relatório Anual 2024"
- "Relatório anual de atividades 2024"
- "Relatório Geral 2024"

Filtros

Filtros Disponíveis

1. Tipo Documental

Dropdown com tipos cadastrados
Fonte: /settings?tab=parametros
Exemplo: "Ofício", "Memorando", "Ata"

2. Nível de Acesso

Dropdown com níveis CONARQ
Opções:
- Todos os níveis
- Público
- Restrito
- Confidencial
- Secreto

3. Data Inicial (Inserção)

Campo de data (dd/mm/aaaa)
Define início do período

4. Data Final (Inserção)

Campo de data (dd/mm/aaaa)
Define fim do período

Filtros Ativos

Tags exibidas abaixo dos campos quando filtros aplicados:

[Tipo: Ata] [x]
[Acesso: Confidencial] [x]
[Data: 06/01/2026 - 05/01/2026] [x]

Ações:

Clicar no [x] remove o filtro específico
Link "Limpar todos" remove todos os filtros

URL com Parâmetros

Filtros são refletidos na URL para compartilhamento:

/documents?insertionDate=2026-01-06,2026-01-05&accessLevel=Confidencial&documentType=uuid

Parâmetros:

insertionDate: Período separado por vírgula
accessLevel: Nível de acesso
documentType: UUID do tipo
search: Termo de busca
page: Número da página
limit: Itens por página

Tabela de Documentos

Colunas

Coluna	Descrição
Nº	Número sequencial do documento
ID DIGITAL	Identificador único (UUID)
Nº DOCUMENTO	Número oficial do documento
TÍTULO / ASSUNTO	Título ou assunto principal
TIPO	Tipo documental
DATA	Data de inserção/cadastro
ACESSO	Nível de acesso (badge colorido)
AÇÕES	Botões de ação

Ações por Documento

Ver (ícone: olho):

Rota: /documents/:id/view
Visualização completa do documento
Disponível para todos com permissão

Editar (ícone: lápis):

Rota: /documents/:id/edit
Formulário de edição
Apenas usuários autenticados
Registra auditoria de alterações

Excluir (ícone: lixeira):

Modal de confirmação
Soft delete (documento marcado como excluído)
Apenas usuários autenticados
Auditoria registrada

Fluxo de Exclusão:

1. Clique em "Excluir"
2. Modal: "Tem certeza que deseja excluir?"
3. Confirma exclusão
4. Documento soft-deleted
5. Listagem atualizada
6. Registro de auditoria criado

Paginação

Sistema de paginação funcional:

Informações exibidas:

"Mostrando X - Y de Z documentos"
Exemplo: "Mostrando 1 - 10 de 45 documentos"

Controles:

Botão "← Anterior"
Número da página atual
Botão "Próxima →"

Itens por página:

Dropdown: 10, 25, 50, 100
Padrão: 10 itens

Criar Documento

Acesso

Página /documents
Botão "+ Novo Documento" (canto superior direito)
Rota: /documents/create

Formulário de Criação

Campos Obrigatórios (Sistema)

ID e ID Digital:

Gerados automaticamente
Exibidos como disabled
Placeholder: "Gerado ao salvar"

Título:

Tipo: Text
Obrigatório: Sim
Exemplo: "Relatório Anual de Atividades 2024"

Tipo de Documento:

Tipo: Select
Obrigatório: Sim
Opções: Tipos cadastrados em /settings

Nível de Acesso:

Tipo: Select
Obrigatório: Sim (conformidade CONARQ)
Opções: Público, Restrito, Confidencial, Secreto

Campos Dinâmicos

Campos adicionais criados em /settings?tab=campos:

Exemplos:

Número do Documento Físico
Autor
Data de Publicação
Palavras-chave
Descrição
Órgão Vinculado
Observações

Cada campo pode ter:

Validações específicas (tamanho, padrão, valores)
Agrupamento em seções
Valores padrão

Seções do Formulário

Os campos são agrupados em seções:

IDENTIFICATION (Identificação):

Número do Documento
ID Digital
Título
Tipo de Documento
Número do Documento Físico

PRODUCTION (Contexto de Produção):

Autor
Data de Produção
Órgão Vinculado
Local de Produção

CONTENT (Conteúdo e Estrutura):

Descrição
Palavras-chave
Idioma

DIGITIZATION (Dados de Digitalização):

Data de Digitalização
Local de Digitalização
Responsável

ACCESS (Acesso e Conformidade):

Nível de Acesso
Prazo de Guarda
Destinação Final

OTHER (Outros):

Observações
Notas Internas

ATTACHMENTS (Anexos e Multimídia):

Seleção de arquivos anexos

Vinculação de Arquivos

Seleção de Anexos

Botão "Selecionar Arquivos" abre modal com árvore hierárquica:

Estrutura da Árvore:

📅 2026
  📅 01 (Janeiro)
    📅 14
      📁 relatorio-anual (3 arquivos)
        📄 relatorio-anual.pdf
        🖼️ relatorio-anual-pg-1.webp
        🖼️ relatorio-anual-pg-2.webp

Seleção por Pasta:

Radio button na pasta
Seleciona PDF + todas as imagens
Apenas 1 pasta por vez

Status de Processamento:

Badge "Processando" com progresso
Exemplo: "5/10 páginas"
Pastas em processamento podem ser selecionadas

Alerta Informativo:

Ao selecionar uma pasta, tanto o PDF quanto todas as suas imagens
(páginas) serão vinculados automaticamente.

Pastas com PDFs em processamento podem ser selecionadas —
as imagens aparecerão conforme forem geradas.

Arquivo Selecionado

Card com informações do arquivo anexado:

Ícone do tipo (PDF ou Imagem)
Nome do arquivo
Botão X para remover

Salvar Documento

Preencha os campos obrigatórios
Adicione anexos (opcional)
Clique em "Salvar Documento"
Sistema valida os dados
Documento criado com sucesso
Redirecionamento para visualização
Registro de auditoria criado

Validações:

Campos obrigatórios preenchidos
Formatos de dados corretos
Valores dentro dos limites definidos
Seleções válidas (select, data, etc.)

Visualizar Documento

Acesso

Rota: /documents/:id/view

Layout de Visualização

Cabeçalho:

Título do documento
Botões de ação (se autenticado):
- Editar
- Excluir
- Voltar

Conteúdo: Campos agrupados por seção em cards:

┌─ Identificação ────────────────┐
│ ID: 42                         │
│ ID Digital: uuid-here          │
│ Título: Relatório Anual 2024   │
│ Tipo: Relatório                │
└────────────────────────────────┘

┌─ Acesso e Conformidade ────────┐
│ Nível de Acesso: 🟢 Público    │
│ Prazo de Guarda: 5 anos        │
└────────────────────────────────┘

┌─ Anexos ───────────────────────┐
│ 📄 relatorio-anual.pdf         │
│ 🖼️ relatorio-anual-pg-1.webp   │
│ 🖼️ relatorio-anual-pg-2.webp   │
└────────────────────────────────┘

Badges de Nível de Acesso:

🟢 Público (verde)
🟡 Restrito (amarelo)
🟠 Confidencial (laranja)
🔴 Secreto (vermelho)

Arquivos Anexados

Lista de arquivos vinculados com:

Ícone do tipo
Nome do arquivo
Link para download (presigned URL, 1 hora de validade)

Editar Documento

Acesso

Rota: /documents/:id/edit

Formulário de Edição

Idêntico ao formulário de criação, mas:

Campos pré-preenchidos com dados existentes
ID e ID Digital permanecem disabled
Anexos previamente selecionados são exibidos
Possível alterar anexo (remove atual + adiciona novo)

Processo de Edição

Dados carregados automaticamente
Modifique os campos desejados
Altere anexos (se necessário)
Clique em "Salvar Alterações"
Sistema compara valores antigos vs novos
Atualiza apenas campos modificados
Cria registro de auditoria com mudanças

Auditoria de Alterações:

json

{
  "entityType": "DOCUMENT",
  "entityId": "42",
  "action": "UPDATE",
  "userId": "user-uuid",
  "changes": {
    "title": {
      "old": "Relatório 2023",
      "new": "Relatório Anual 2023"
    },
    "accessLevel": {
      "old": "Restrito",
      "new": "Público"
    }
  }
}

Níveis de Acesso

O sistema implementa os 4 níveis de acesso do CONARQ.

1. Público

Características:

Visível para todos (incluindo visitantes)
Sem restrições de acesso
Badge verde

Uso:

Documentos de domínio público
Atas de reuniões públicas
Relatórios gerenciais públicos
Informativos institucionais

Permissões:

✅ Visitantes: Visualização
✅ Autenticados: Visualização + Edição (se autorizado)
✅ ADMIN/SUPER: Acesso total

2. Restrito

Características:

Visível apenas para usuários autenticados
Acesso baseado em permissões
Badge amarelo

Uso:

Documentos internos
Informações corporativas
Comunicações internas
Relatórios gerenciais

Permissões:

❌ Visitantes: Negado
✅ Autenticados: Conforme permissões do grupo
✅ ADMIN/SUPER: Acesso total

3. Confidencial

Características:

Acesso apenas com autorização específica
Documentos sensíveis
Badge laranja

Uso:

Documentos estratégicos
Informações jurídicas
Contratos sensíveis
Dados pessoais protegidos

Permissões:

❌ Visitantes: Negado
⚠️ Autenticados: Apenas com autorização específica
✅ ADMIN/SUPER: Acesso total

Exemplo: "Anais da Câmara dos Deputados" marcados como confidenciais.

4. Secreto

Características:

Máximo nível de restrição
Auditoria de todos os acessos
Badge vermelho

Uso:

Documentos de segurança nacional
Informações altamente sensíveis
Dados críticos protegidos

Permissões:

❌ Visitantes: Negado
❌ Autenticados: Negado
⚠️ ADMIN: Acesso com auditoria
✅ SUPER: Acesso total com auditoria

Conformidade:

Registro de auditoria obrigatório
Certificação de nível de acesso
Prazo de sigilo conforme legislação

Tipos de Documento

Os tipos de documento são cadastrados em /settings?tab=parametros.

Tipos Padrão

Criados automaticamente no sistema:

Ofício: Comunicação oficial
Memorando: Comunicação interna
Relatório: Documento de prestação de contas
Ata: Registro de reuniões
Portaria: Ato administrativo
Decreto: Ato normativo
Circular: Comunicação geral
Edital: Convocação pública
Contrato: Acordo formal
Fotografia: Registro visual

Criar Novo Tipo

Acesse /settings?tab=parametros
Seção "Tipos de Documento"
Digite o nome
Clique em "Adicionar Tipo"

O novo tipo aparece automaticamente nos formulários de documentos.

Documentos Relacionados

É possível vincular documentos relacionados entre si.

Adicionar Documento Relacionado

No formulário de criação/edição:

Seção "Outros"
Campo "Documentos Relacionados"
Busque pelo número ou título
Selecione o documento
Documento adicionado à lista

Visualização

Na página de visualização:

Seção "Documentos Relacionados"
Lista de links para documentos vinculados
Clique para abrir documento relacionado

Próxima Etapa

Continue para Upload de PDFs para aprender sobre o sistema de upload.

Gestão de Documentos ​

Visão Geral ​

Funcionalidades Principais ​

Dashboard ​

Acesso Público vs Autenticado ​

Cards de Métricas ​

Listagem de Documentos Recentes ​

Card Conformidade CONARQ ​

Listagem de Documentos ​

Controle de Acesso ​

Sistema de Busca ​

Filtros ​

Filtros Disponíveis ​

Filtros Ativos ​

URL com Parâmetros ​

Tabela de Documentos ​

Colunas ​

Ações por Documento ​

Paginação ​

Criar Documento ​

Acesso ​

Formulário de Criação ​

Campos Obrigatórios (Sistema) ​

Campos Dinâmicos ​

Seções do Formulário ​

Vinculação de Arquivos ​

Seleção de Anexos ​

Arquivo Selecionado ​

Salvar Documento ​

Visualizar Documento ​

Acesso ​

Layout de Visualização ​

Arquivos Anexados ​

Editar Documento ​

Acesso ​

Formulário de Edição ​

Processo de Edição ​

Níveis de Acesso ​

1. Público ​

2. Restrito ​

3. Confidencial ​

4. Secreto ​

Tipos de Documento ​

Tipos Padrão ​

Criar Novo Tipo ​

Documentos Relacionados ​

Adicionar Documento Relacionado ​

Visualização ​

Próxima Etapa ​

Gestão de Documentos

Visão Geral

Funcionalidades Principais

Dashboard

Acesso Público vs Autenticado

Cards de Métricas

Listagem de Documentos Recentes

Card Conformidade CONARQ

Listagem de Documentos

Controle de Acesso

Sistema de Busca

Filtros

Filtros Disponíveis

Filtros Ativos

URL com Parâmetros

Tabela de Documentos

Colunas

Ações por Documento

Paginação

Criar Documento

Acesso

Formulário de Criação

Campos Obrigatórios (Sistema)

Campos Dinâmicos

Seções do Formulário

Vinculação de Arquivos

Seleção de Anexos

Arquivo Selecionado

Salvar Documento

Visualizar Documento

Acesso

Layout de Visualização

Arquivos Anexados

Editar Documento

Acesso

Formulário de Edição

Processo de Edição

Níveis de Acesso

1. Público

2. Restrito

3. Confidencial

4. Secreto

Tipos de Documento

Tipos Padrão

Criar Novo Tipo

Documentos Relacionados

Adicionar Documento Relacionado

Visualização

Próxima Etapa