Separador PDF - Holerites por Empresa¶
1. Visão Geral¶
- Slug:
separador-holerites-por-empresa - Grupo: Geral
- Página (rota):
/separador-holerites-por-empresa - API base:
/api/separador-holerites-por-empresa - Permissão RBAC:
tool:separador-holerites-por-empresaoutool:*(ADMIN acessa)
Envia um PDF de holerites e gera um PDF por empresa, com um ZIP final para download.
2. Objetivo Operacional¶
- Faça o upload de um único PDF contendo holerites/folhas de várias empresas. A ferramenta identifica automaticamente o nome da empresa na primeira linha de cada página, separa as páginas por empresa e devolve um arquivo ZIP com todos os PDFs gerados.
- Uso recomendado quando há alto volume, risco de erro manual ou necessidade de padronização de entrega.
3. Arquivos Relacionados (Verificados)¶
- Página HTML:
public/separador-holerites-por-empresa.html - Script JS da ferramenta:
public/js/separador-holerites-por-empresa.js - Router Node:
src/routes/tools/separador-holerites-por-empresa.routes.js - Service Node: não identificado
- Arquivos Python relacionados:
api/holerites_core.py
4. Rotas e Endpoints¶
- Rota de página:
/separador-holerites-por-empresa; - Base de API esperada:
/api/separador-holerites-por-empresa; - Endpoints no router:
POST /
5. Fluxo Técnico (Página -> Node -> Python/Serviço)¶
- Front-end coleta parâmetros/arquivos e chama APIs internas (preferência por
AuthClient.authFetch). - Router valida entrada, aplica segurança (CSRF em mutações quando aplicável) e orquestra o processamento.
- Service concentra regra de negócio, integração com armazenamento e chamadas a serviços externos/Python.
- Retorno padronizado em JSON e/ou arquivo para download.
6. Segurança e Governança¶
- Exige autenticação ativa no portal.
- RBAC por ferramenta (
tool:<slug>,tool:*, ADMIN). - Em mutações, usar token CSRF via header
x-csrf-token(exceto login). auditLogdeve registrar evento sem interromper a requisição em falhas de auditoria.
7. Entradas e Saídas Esperadas¶
- Entradas: parâmetros de formulário e/ou upload conforme UI da ferramenta.
- Saídas: resposta em tela e, quando aplicável, artefatos (ZIP/PDF/XLSX/CSV/JSON).
- Observação: validar encoding, formato e tamanho dos arquivos para evitar erro 400/422.
8. Troubleshooting Rápido¶
- 401/403: conferir sessão do usuário e permissão RBAC.
- 404 em endpoint: validar rota no
routere base URL consumida no JS. - 422/400: revisar campos obrigatórios e estrutura do arquivo enviado.
- 500: inspecionar logs do Node e, quando existir, logs do processamento Python.
9. Observações de Manutenção¶
- Ao alterar nomes de arquivo/rota, manter compatibilidade (alias/redirect) para não quebrar links legados.
- Se incluir nova API/fluxo, atualizar este documento e
src/core/tool-catalog.json.