Search API Attachments

Drupal
Solucionex
14
Jun 24

El módulo Search API Attachments para Drupal permite la indexación y búsqueda del contenido de archivos adjuntos como PDF, TXT y otros formatos, utilizando métodos de extracción como Apache Tika, Solr, y pdftotext. Este módulo es una extensión del Search API y facilita la inclusión del contenido de archivos en las búsquedas realizadas en un sitio Drupal, mejorando así la capacidad de búsqueda y recuperación de información.

Características del Módulo

  1. Métodos de Extracción: Utiliza varios métodos para extraer contenido de archivos:
    • Apache Tika: Una biblioteca que detecta y extrae metadatos y texto de documentos de varios tipos.
    • Solr: Un motor de búsqueda de código abierto que permite la indexación y búsqueda de grandes volúmenes de datos.
    • pdftotext: Una herramienta para extraer texto de archivos PDF.
  2. Compatibilidad: Funciona con Drupal 8 y versiones superiores, y se integra con el módulo Search API para gestionar la indexación y búsqueda de contenido.

Instalación y Configuración

  1. Instalación:
    • Descarga e instala el módulo Search API Attachments desde la página oficial de módulos de Drupal o mediante Composer.
    • Habilita el módulo en la sección de módulos de tu sitio Drupal (admin/modules).
  2. Configuración:
  • Navega a "Configuración > Búsqueda y metadatos > Search API > Search API Attachments".
  • Selecciona el método de extracción adecuado (por ejemplo, Solr).
  • Agrega el campo de adjuntos a la lista de campos para indexar:
    • Ve a "Configuración > Búsqueda y metadatos > Search API".
    • Selecciona el índice de nodos y agrega los campos relacionados con los archivos adjuntos.
  • Habilita las alteraciones de datos para incluir el contenido de los archivos adjuntos en la indexación.
  • Indexa nuevamente los nodos para incluir los nuevos datos.

Uso en un Proyecto Drupal

Una vez configurado, el módulo Search API Attachments permite que el contenido de los archivos adjuntos sea accesible a través de las búsquedas en el sitio. Esto es especialmente útil para sitios que manejan una gran cantidad de documentos y necesitan que estos sean fácilmente buscables por los usuarios. Por ejemplo, al adjuntar un archivo PDF a un nodo, el contenido del PDF será indexado y se podrá buscar a través de las funciones de búsqueda del sitio.

Para ver los resultados, simplemente realiza una búsqueda con términos que solo se encuentren en los archivos adjuntos. Si la configuración es correcta, los resultados incluirán nodos que tienen esos términos en sus archivos adjuntos.

Ejemplo Sencillo de Uso

Instalación del Módulo

  1. Descargar e instalar:

    • Utiliza Composer para instalar el módulo:
    composer require 'drupal/search_api_attachments:^1.0'
  • Habilita el módulo en la interfaz de administración de Drupal:

    /admin/modules                           

Configuración del Módulo

  1. Habilitar el módulo:
    • Ve a la página de módulos (admin/modules) y habilita el módulo Search API Attachments.
    • Guarda la configuración.
  2. Configurar Search API Attachments:
    • Navega a Configuración > Búsqueda y metadatos > Search API > Search API attachments.
    • Selecciona el método de extracción adecuado, por ejemplo, Solr.
    • Guarda la configuración.

Añadir Campo de Adjuntos a la Lista de Campos para Indexar

  1. Configuración de campos:
    • Ve a Configuración > Búsqueda y metadatos > Search API.
    • Selecciona el índice de nodos.
    • En el menú desplegable, selecciona "Campos" y añade los campos relacionados con archivos adjuntos:
      • Selecciona el campo de adjuntos adecuado y agrégalo.
    • Guarda los cambios.

Habilitar Alteraciones de Datos

  1. Alteraciones de datos:
    • Haz clic en "Filtros".
    • En alteraciones de datos, habilita "File attachments" para acceder al contenido de los archivos adjuntos y indexarlo.
    • Guarda la configuración.

Indexar el Contenido

  1. Indexación:
    • Haz clic en la pestaña "Ver".
    • Selecciona "Indexar ahora" para indexar el contenido de los archivos adjuntos.

Uso y Verificación

Para verificar que la configuración es correcta, puedes adjuntar un archivo de texto a un nodo y realizar una búsqueda utilizando una palabra clave contenida en ese archivo. Si la palabra clave se encuentra únicamente en el archivo adjunto y no en el contenido del nodo, y el nodo aparece en los resultados de búsqueda, entonces la configuración es correcta.

Este módulo es una poderosa herramienta para mejorar la capacidad de búsqueda de contenido en sitios Drupal, proporcionando una experiencia de usuario más rica y eficiente.

Para más detalles sobre la configuración y uso del módulo, puedes consultar las guías disponibles en Acquia y Modules Unraveled, así como el README.txt del módulo.