====== Busca no Diário Oficial — Manual do Sistema ====== Este manual descreve as principais funcionalidades do DOE Search: busca (simples e avançada), filtros, pesquisa por relevância e booleana, cadastro e gerenciamento de alertas de publicação, e o funcionamento do envio de e-mails. ===== Acesso ao Sistema ===== - Endereço: informe a URL fornecida pela sua organização.\\ - Autenticação:\\ - Login com usuário e senha institucional (LDAP/Keycloak), quando configurado.\\ - Perfis:\\ - Usuário: pode realizar buscas e gerenciar seus alertas.\\ - Administrador: pode, além disso, gerenciar configurações de índices, campos, usuários, layouts e monitorar logs.\\ ===== Busca ===== === Busca Simples === - Campo único de pesquisa.\\ - Digite termos livres (ex.: “portaria”, “concurso público”, “homologação”).\\ - Dicas:\\ - Use aspas para buscar expressão exata: “concurso público”.\\ - Use filtros para refinar (veja seção Filtros).\\ === Busca Avançada === - Permite combinar múltiplos campos e condições.\\ - Recursos:\\ - Operadores booleanos (AND, OR, NOT).\\ - Agrupamento com parênteses.\\ - Filtros por data (seletor ou intervalo).\\ - Seleção de campos específicos (ex.: título, órgão, tipo de publicação).\\ - Exemplo:\\ - (portaria AND educação) OR (“concurso público” AND NOT homologação)\\ === Pesquisa Booleana === - Suportado na busca avançada e em alguns campos.\\ - Operadores:\\ - AND: exige presença de ambos os termos.\\ - OR: aceita qualquer um dos termos.\\ - NOT: exclui termos.\\ - Agrupamento:\\ - Use parênteses para controlar a prioridade: (A AND B) OR (C AND NOT D).\\ === Relevância (Ranking) === - Os resultados são ordenados por relevância quando aplicável.\\ - Fatores:\\ - Frequência dos termos.\\ - Ocorrência em campos mais importantes (ex.: título).\\ - Data e popularidade (quando configurado).\\ - Dicas:\\ - Refine termos e use filtros para melhorar o ranking.\\ ===== Filtros ===== === Tipos de Campos e Normalização === - O sistema normaliza tipos de campos para evitar inconsistências:\\ - Texto (string)\\ - Número\\ - Booleano (sim/não)\\ - Data (ver opções abaixo)\\ - Booleans:\\ - Aceita variações comuns (true/false, sim/não, 1/0) e converte internamente.\\ - Datas:\\ - Aceita formatos ISO (YYYY-MM-DD) e comuns (DD/MM/YYYY), convertendo conforme necessidade.\\ === Filtros de Data === - Para campos de data, há duas opções:\\ - Seletor de Data: escolha um dia específico.\\ - Intervalo de Datas: defina início e fim (ex.: 01/05/2024 a 31/05/2024).\\ - Recomendações:\\ - Use Intervalo de Datas para buscas amplas (ex.: mês inteiro).\\ - Use Seletor de Data para algo pontual (ex.: publicações do dia).\\ ===== Alertas ===== === O que são Alertas === - Alertas são regras de monitoramento que disparam e-mails quando novas publicações correspondem à sua busca.\\ - Cada alerta possui:\\ - Nome\\ - Critérios de busca (termos, filtros, campos)\\ - Frequência de envio (diário, semanal, etc.)\\ - Destinatários (usuário principal e/ou e-mails adicionais)\\ === Criar um Alerta === 1. Acesse: Administração → Alertas (ou menu Alertas, se disponível).\\ 2. Clique em “Novo Alerta”.\\ 3. Defina:\\ - Nome do alerta.\\ - Consulta (simples ou avançada, inclusive booleana).\\ - Filtros (datas, campos específicos, órgão, etc.).\\ - Frequência de envio.\\ - Destinatário principal (você) e e-mails adicionais, se necessário.\\ 4. Salve para ativar.\\ === Editar e Gerenciar Alertas === - Lista de Alertas:\\ - Visualize nome, filtros, data de criação, último envio, destinatários e status (ativo/pausado).\\ - Ações:\\ - Editar: ajuste termos, filtros, frequência ou destinatários.\\ - Pausar/Retomar: interrompa temporariamente ou reative o envio.\\ - Excluir: remove o alerta definitivamente.\\ - Autocomplete de Usuário (para administradores):\\ - Pesquise usuários por nome/login/e-mail.\\ - Integração LDAP, quando configurada, para localizar e vincular usuários do diretório.\\ - Também é possível informar um e-mail manualmente (customEmail) quando necessário.\\ === Testar/Simular Envio === - Em ambientes de teste, pode haver opção de simular execução do alerta:\\ - Avalia os critérios e mostra publicações que seriam enviadas.\\ - Útil para validar regras antes de ativar definitivamente.\\ ===== E-mails de Alerta ===== === Conteúdo do E-mail === - Inclui:\\ - Assunto com nome do alerta e período.\\ - Lista de novas publicações encontradas.\\ - Links diretos para visualização.\\ - Resumo (quando configurado) e campos relevantes (título, órgão, data).\\ === Frequência e Agendamento === - Envio programado:\\ - Diário (ex.: 12:00) ou conforme definido pelo administrador.\\ - Somente publicações novas desde o último envio.\\ - Evita duplicidades:\\ - O sistema registra publicações já enviadas para o alerta.\\ === Histórico de Envios === - Cada alerta mostra:\\ - Último envio e status.\\ - Quantidade de publicações enviadas.\\ - Possíveis erros (ex.: falha de entrega, destinatário inválido).\\ ===== Administração ===== === Usuários e LDAP === - Pesquisa de usuários:\\ - Busque por nome/login/e-mail.\\ - Combina resultados locais com LDAP, evitando duplicidades.\\ - Vincular usuário a um alerta:\\ - Escolha usuário existente ou informe e-mail customizado.\\ - Administradores podem atualizar o responsável/destinatário de um alerta.\\ === Configurações de Índices e Campos === - Índices:\\ - Cadastro e edição de fontes de dados (ex.: coleções do DOE).\\ - Campos:\\ - Configuração de tipos, visibilidade, ordem e comportamento nos filtros.\\ - Campos de data oferecem “Seletor de Data” e “Intervalo de Datas” de forma consistente.\\ === Layout dos Resultados === - Personalize:\\ - Ordem e exibição de campos.\\ - Layouts para impressão e e-mails (quando disponível).\\ - Editor WYSIWYG:\\ - Ajuste textos/cabeçalhos/template dos e-mails de alerta, conforme permissões.\\ === Logs de Busca === - Monitoramento:\\ - Acompanhe consultas realizadas, desempenho e erros.\\ - Útil para auditoria e otimização de relevância.\\ ===== Perguntas Frequentes (FAQ) ===== === Qual a diferença entre Busca Simples e Avançada? === - Simples: um campo, rápido, ideal para termos genéricos.\\ - Avançada: múltiplos campos, operadores booleanos, filtros detalhados.\\ === Como montar consultas booleanas eficazes? === - Use AND para exigir termos; OR para alternativas; NOT para excluir.\\ - Agrupe com parênteses para controlar a lógica: (A AND B) OR (C AND NOT D).\\ === Por que não recebi um e-mail de alerta? === - Possíveis causas:\\ - Nenhuma publicação nova atendeu aos critérios.\\ - Alerta está pausado.\\ - E-mail inválido ou caixa cheia.\\ - Verifique histórico do alerta e ajuste filtros.\\ ===== Boas Práticas ===== - Dê nomes claros aos seus alertas.\\ - Prefira Intervalo de Datas para períodos longos; Seletor de Data para dias pontuais.\\ - Teste regras antes de ativar em produção (quando o ambiente oferecer simulação).\\ - Revise seus alertas periodicamente para manter a relevância.\\ ===== Suporte ===== - Em caso de dúvidas ou problemas:\\ - Contate o administrador do sistema.\\ - Informe o nome do alerta, período e qualquer mensagem de erro exibida.\\ Se desejar, posso também atualizar o rascunho para incluir referências ao nome dos menus exatamente como aparecem na sua interface (por exemplo, “Menu → Alertas” ou “Administração → Alertas”), caso me confirme os rótulos atuais da aplicação.