Acquia Search: Index Attachments API

Goal

Index file attachments such as PDFs and Word documents in Acquia Search using the Search API Attachments module.

Prerequisites

• Drupal 10 or later

• Acquia Search installed and configured

• Acquia Connector module installed and active

Step 1: Install and enable the Search API Attachments module

1. Confirm the Acquia Search and Acquia Connector modules are installed and working as expected.

2. Add the Search API Attachments module to your codebase.

3. Sign in with administrator credentials.

4. Navigate to Manage > Extend.

5. Select the Search API Attachments checkbox.

6. Click Install.

Step 2: Configure Search API Attachments to use Acquia Search

1. Navigate to Manage > Configuration > Search and metadata > Search API attachments.

2. Select Solr Extractor from the Extraction method dropdown.

3. From the Solr server dropdown, select the server with an Acquia Search configuration. The name is Acquia Search API Solr server, or similar.

4. Click Submit and test extraction.

5. Verify that the system displays a success message such as "Congratulations! The extraction seems working! Yay!"

Step 3: Reconfigure the search index

1. Navigate to Manage > Configuration > Search and metadata > Search API.

2. In the Index row, click Edit.

3. Select the Processors tab.

4. Select the File attachments processor checkbox to enable it.

   

5. Configure the attachment processor to exclude specific file types or apply size limits as needed.

   

6. Click Save.

7. Select the Fields tab, then click Add fields.

   

8. Select the relevant attachment fields to index. Configure indexing options such as boosting factors.

Step 4: Update the search view

1. Navigate to Manage > Structure > Views.

2. Find and edit the Search view.

3. In the Filter Criteria section, add the newly indexed attachment fields to the search.

4. Use Ctrl (Command on macOS) to multi-select: add to the existing fields rather than replacing them.

5. Save the view.

6. Clear the site caches and reindex to ensure that the updates appear in search results.