ArqSystem

Aparência

Configuração ​

Este guia detalha as configurações disponíveis no ArqSystem e como personalizá-las.

Acesso às Configurações ​

Apenas usuários com permissões de ADMIN ou SUPER podem acessar as configurações do sistema.

Para acessar:

  1. Faça login como administrador
  2. Navegue para /settings
  3. Selecione a aba desejada

Abas de Configuração ​

Painel (Dashboard) ​

Controle os widgets exibidos na tela inicial do sistema.

Widgets Disponíveis ​

Total de Documentos

  • Exibe o número total de documentos cadastrados
  • Toggle: Mostrar/Ocultar
  • Ícone: Documento (azul)

Recentes (7 dias)

  • Exibe documentos cadastrados nos últimos 7 dias
  • Toggle: Mostrar/Ocultar
  • Ícone: Relógio (verde)

Documentos Públicos

  • Controla exibição de documentos públicos na listagem
  • Toggle: Mostrar/Ocultar

Documentos Restritos

  • Controla exibição de documentos restritos na listagem
  • Toggle: Mostrar/Ocultar

Como Configurar ​

typescript
// Exemplo de configuração via interface
1. Acesse /settings?tab=painel
2. Localize o widget desejado
3. Clique no toggle para ativar/desativar
4. As mudanças são salvas automaticamente
5. Visualize o resultado na dashboard

Campos Globais ​

Configure os campos do formulário de documentos.

Campos do Sistema ​

Campos obrigatórios que não podem ser removidos:

  • id: Número do Documento (auto-incremento)
  • digitalId: ID Digital (UUID)
  • title: Título do Documento
  • documentType: Tipo de Documento
  • accessLevel: Nível de Acesso

Campos Dinâmicos ​

Você pode criar campos personalizados:

Tipos de Campo Disponíveis:

  • TEXT: Texto curto
  • TEXTAREA: Texto longo
  • NUMBER: Números
  • DATE: Data
  • SELECT: Lista de opções
  • BOOLEAN: Sim/Não

Propriedades de Campo:

  • Nome: Identificador interno
  • Label: Rótulo exibido
  • Tipo: Tipo de dado
  • Seção: Agrupamento visual
  • Obrigatório: Sim/Não
  • Visível: Sim/Não
  • Ordem: Posição no formulário

Adicionar Novo Campo ​

  1. Acesse /settings?tab=campos
  2. Clique em "Adicionar Campo"
  3. Preencha as propriedades:
typescript
{
  fieldName: "numeroProcesso",
  label: "Número do Processo",
  fieldType: "TEXT",
  section: "IDENTIFICATION",
  required: true,
  visible: true,
  sortOrder: 10
}

  1. Configure validações (se necessário):

    • Tamanho mínimo/máximo (TEXT/TEXTAREA)
    • Valor mínimo/máximo (NUMBER)
    • Padrão regex (TEXT)
    • Opções (SELECT)

  2. Salve o campo

O campo aparecerá automaticamente em todos os formulários de documentos.

Editar Campo Existente ​

  1. Localize o campo na lista
  2. Clique no ícone de editar (lápis)
  3. Modifique as propriedades
  4. Salve as alterações

Restrições:

  • Campos do sistema não podem ser editados
  • Campos em uso não podem ter o tipo alterado
  • Campos vinculados a documentos não podem ser removidos

Remover Campo ​

  1. Localize o campo na lista
  2. Clique no ícone de excluir (lixeira)
  3. Confirme a exclusão

O sistema verifica se o campo está em uso antes de permitir a exclusão.

Parâmetros ​

Configure tipos de documentos e órgãos vinculados.

Tipos Documentais ​

Gerencie os tipos de documento disponíveis no sistema.

Tipos Padrão (criados automaticamente):

  • Ofício
  • Memorando
  • Relatório
  • Ata
  • Portaria
  • Decreto
  • Circular
  • Edital
  • Contrato
  • Fotografia

Adicionar Novo Tipo:

  1. Acesse /settings?tab=parametros
  2. Seção "Tipos de Documento"
  3. Digite o nome no campo
  4. Clique em "Adicionar Tipo"
typescript
// Exemplo
Nome: "Parecer Técnico"
Resultado: Novo tipo disponível nos formulários

Editar Tipo Existente:

  1. Clique no ícone de editar (lápis)
  2. Modifique o nome
  3. Pressione Enter ou clique em salvar (✓)
  4. Pressione Esc ou clique em cancelar (✗) para desfazer

Remover Tipo:

  1. Clique no ícone de excluir (lixeira)
  2. Confirme a exclusão

Nota: Tipos vinculados a documentos não podem ser removidos. O sistema exibe a quantidade de documentos vinculados.

Níveis de Órgãos Vinculados ​

Configure a hierarquia de órgãos governamentais.

Níveis Padrão:

  • Federal
  • Estadual
  • Municipal

Adicionar Novo Nível:

  1. Seção "Níveis de Órgãos"
  2. Digite o nome do nível
  3. Clique em "Adicionar Nível"

Exemplo:

typescript
Nome: "Regional"
Uso: Órgãos regionais específicos

Órgãos Vinculados ​

Gerencie órgãos governamentais e institucionais.

Órgãos Padrão por Nível:

Federal:

  • Presidência da República
  • Ministério da Casa Civil
  • Arquivo Nacional
  • Câmara dos Deputados
  • Senado Federal

Estadual:

  • Governo do Estado
  • Secretaria de Educação
  • Secretaria de Saúde

Municipal:

  • Prefeitura Municipal
  • Câmara Municipal
  • Secretaria Municipal de Saúde

Adicionar Novo Órgão:

  1. Seção "Órgãos Vinculados"
  2. Digite o nome do órgão
  3. Selecione o nível (Federal, Estadual, Municipal)
  4. Clique em "Adicionar Órgão"
typescript
// Exemplo
Nome: "Secretaria de Tecnologia"
Nível: Municipal
Resultado: Órgão disponível para vinculação em documentos

Editar Órgão:

  1. Clique no ícone de editar (lápis)
  2. Modifique nome e/ou nível
  3. Salve ou cancele

Restrições:

  • Órgãos vinculados a documentos não podem ser editados
  • Órgãos vinculados a documentos não podem ser removidos

Configurações de Busca ​

Configure o sistema de busca full-text com Sonic.

Sobre o Sonic ​

O ArqSystem utiliza o Sonic como motor de busca:

  • Busca rápida e eficiente (sub-milissegundo)
  • Suporte a busca fuzzy (tolerância a erros)
  • Busca em todos os campos de texto
  • Resultados ordenados por relevância

Reindexação Manual ​

Quando necessário, você pode reindexar todos os documentos:

  1. Acesse /settings?tab=parametros
  2. Seção "Configurações de Busca"
  3. Clique em "Reindexar Documentos"
  4. Confirme a ação
  5. Aguarde a conclusão (pode levar alguns minutos)

Quando Reindexar:

  • Após importação em massa de documentos
  • Se a busca não retornar resultados esperados
  • Após alterações em campos indexados
  • Após atualização do sistema
bash
# Reindexação via API
POST /api/trpc/document.reindexSearch
Authorization: Bearer {token}

Usuários e Permissões ​

Gerencie usuários e níveis de acesso ao sistema.

Níveis de Permissão ​

Visitante (Não Autenticado):

  • Acesso apenas a documentos públicos
  • Visualização somente leitura
  • Sem acesso a upload ou cadastro

Usuário Autenticado:

  • Acesso a documentos conforme permissões
  • Pode criar e editar documentos
  • Pode fazer upload de PDFs
  • Visualiza documentos restritos autorizados

ADMIN:

  • Acesso a todas as funcionalidades
  • Gerencia configurações do sistema
  • Gerencia tipos de documento e órgãos
  • Configura campos e parâmetros
  • Não pode deletar arquivos do storage

SUPER:

  • Acesso total ao sistema
  • Todas as permissões de ADMIN
  • Pode deletar arquivos do storage
  • Acesso a todos os documentos (incluindo secretos)
  • Gerencia outros administradores

Adicionar Usuário ​

  1. Acesse /settings?tab=usuarios
  2. Clique em "Novo Usuário"
  3. Preencha os dados:
    • Nome completo
    • Email
    • Senha inicial
    • Nível de permissão
  4. Salve o usuário

Editar Usuário ​

  1. Localize o usuário na lista
  2. Clique em "Editar"
  3. Modifique as informações
  4. Salve as alterações

Desativar Usuário ​

  1. Localize o usuário
  2. Clique em "Desativar"
  3. Confirme a ação

Usuários desativados não podem fazer login, mas seus documentos permanecem no sistema.

Variáveis de Ambiente ​

Banco de Dados ​

env
DATABASE_URL="postgresql://user:password@localhost:5432/arqsystem"

Sonic (Busca) ​

env
SONIC_HOST=localhost
SONIC_PORT=1491
SONIC_PASSWORD=SecretPassword

Cloudflare R2 (Storage) ​

env
R2_ACCOUNT_ID=your-account-id
R2_ACCESS_KEY_ID=your-access-key
R2_SECRET_ACCESS_KEY=your-secret-key
R2_BUCKET_NAME=arqsystem-storage

Autenticação ​

env
NEXTAUTH_SECRET=your-secret-key-here
NEXTAUTH_URL=http://localhost:3000

Redis (Jobs) ​

env
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=

Backup e Restauração ​

Backup do Banco de Dados ​

bash
# PostgreSQL dump
pg_dump -U arquser -d arqsystem -F c -f backup_$(date +%Y%m%d).dump

# Restauração
pg_restore -U arquser -d arqsystem -c backup_20260114.dump

Backup do Storage ​

Configure sincronização automática com rclone:

bash
# Instale rclone
curl https://rclone.org/install.sh | sudo bash

# Configure o remote do R2
rclone config

# Sincronize
rclone sync r2:arqsystem-storage /backup/storage --progress

Backup do Índice Sonic ​

bash
# Backup do diretório de dados do Sonic
tar -czf sonic_backup_$(date +%Y%m%d).tar.gz /var/lib/sonic/store

Próxima Etapa ​

Continue para Gestão de Documentos para aprender a usar o sistema.

Sistema de Gestão de Arquivos Digitais

Copyright © 2024-presente ArqSystem