Intro, Install, & Configure

This module provides additional properties for Search API indexes. These can be enabled on the "Filters" tab of the Search API index configuration.

Properties

• Site Name: Add the name of the site or the Domain Access Domain to each indexed item.
• Federated Field: A field that can be customized per bundle using free text or tokens.
• Re-map Field Names: Directly map a field or property (across all bundles) to a new field name in the index.

After enabling this plugin under the "Data Alterations" section, the indexed values can be customized in the "Callback settings" section of the configuration form.

Mapping Strategies

Each field being sent to the index should be processed using only one or the other of these two methods. If a field has definitions in both of the following methods, the processing order will determine which data gets sent, and the last definition will override any preceding.

1. For fields that need to be customized per-bundle...

   • Enable the Federated Field data alteration as described above.
   • In the callback settings: add a new field, name it according to the schema, and then add values/tokens for each bundle. Bundles left empty will not send any data to the index for this field.
   • Example: This may often be used for the federated_type field when sites have content types that don't match up with those in the schema, so the "News" and "Article" content type can both be mapped to the "News" type in the index.

   

2. For fields that are being mapped directly across all bundles...

   • Enable the Re-map Field Names data alteration as described above.
   • In the callback settings: select the source field from the dropdown of the field being mapped.
   • Example: If the "Title" field of all content types should be mapped directly to the index, select "Title" from the "Federated Title" dropdown.

   

Using the "Federated terms" field

1. Visit the data alterations list for your index at Admin > Configuration > Search API > [your index] > Filters (path /admin/config/search/search-api/index/YOUR_INDEX/workflow)
2. Check "Federated Term" and Save the Configuration: 
3. Visit the fields list for your index at Admin > Configuration > Search API > [your index] > Fields (path /admin/config/search/search-api/index/YOUR_INDEX/fields)
4. Check "Federated Term" (make sure the field's type is "string") and save the Configuration: 
5. Configuration for federated terms happens within the taxonomy term entity edit UI itself. Browse to a taxonomy vocabulary on your site and add an instance of the "Federated terms" field type (If you plan on sharing this field among your vocabularies, use something like "Federated terms" for the field label). 
6. Edit any terms in the vocabularies to which you've just added a "Federated terms" field instance. On the term edit form, you should now see a "Federated terms" field instance where you can add one or many "federated" terms. 
7. Repeat for each term in each vocabulary which should have a federated term value.
8. Once content which references these terms is indexed, all of their corresponding "federated terms" will appear in the federated_terms index property field.