Drupal is a registered trademark of Dries Buytaert
Protected Pages 3.0.0 Major update available for module protected_pages (3.0.0). Commerce Core 3.3.8 Minor update available for module commerce (3.3.8). Search API HTML Element Filter 1.0.7 Minor update available for module search_api_html_element_filter (1.0.7). Layout Builder Reorder 2.0.1 Minor update available for module layout_builder_reorder (2.0.1). Ban 1.1.0 Minor update available for module ban (1.1.0). Field Formatter Range 2.0.0 Major update available for module field_formatter_range (2.0.0). Field Formatter Range 8.x-1.8 Minor update available for module field_formatter_range (8.x-1.8). Varbase Media Header 9.2.1 Minor update available for module varbase_media_header (9.2.1). Search API Solr 4.3.11 Module search_api_solr updated after 14 months of inactivity (4.3.11). Provus Mega Menu Module provus_mega_menu crossed 1,000 active installs.

This module allows you to use a specific field on a content entity as the unique identifier for tracking items in a search index. This is useful when you need to synchronize with external systems that use custom identifiers instead of Drupal's internal entity IDs.

This module provides a Search API datasource that allows you to key your tracking IDs by a field on a content entity.

Some use cases include

  • Limited ability to query the indexing backend and the indexing key needs to match the remote key.
  • Custom keying where remote keying needs to match a remote source. For example, an enterprise identifier.

Features

Here, answer the following questions: What is the basic functionality? What unique features does enabling this project add? When and why would someone use this module? What use cases are there?

Post-Installation

Create a search index as you normally would and choose one of the "Field keyed" entity sources. Then set the field key value and the tracking keys will use the value of the field instead of the entity id.

Additional Requirements

PHP 8.3 and Search API

Activity

Total releases
3
First release
Apr 2025
Latest release
11 months ago
Releases (12 mo)
1 ▼ from 2
Maintenance
Slowing

Release Timeline

Releases

Version Type Release date
1.0.0-beta2 Pre-release Jul 22, 2025
1.0.0-beta1 Pre-release Jul 1, 2025
1.0.x-dev Dev Apr 23, 2025