body:The internal ID to use for this field. Can safely be ignored by inexperienced users in most cases. Changing a field's machine name requires reindexing of the index.
body:The internal relationship linking the indexed item to the field, with links being separated by colons (:). This can be useful information for advanced users, but can otherwise be ignored.
body:The data type to use when indexing the field. Determines how a field can be used in searches. For information on the available types, see the <a href="#search-api-data-types-table">"Data types" box</a> at the bottom of the page.
body:Only applicable for fulltext fields. Determines how "important" the field is compared to other fulltext fields, to influence scoring of fulltext searches.
body:This saves all changes made to the fields for this index. Until this button is pressed, all added, changed or removed fields will only be stored temporarily and not effect the actual index used in the rest of the site.
weight:10
attributes:
data-id:edit-actions-submit
selector:'#edit-actions-submit'
search-api-index-fields-cancel:
id:search-api-index-fields-cancel
plugin:text
label:Cancel changes
body:If you have made changes to the index's fields but not yet saved them, the "Cancel" link lets you discard those changes.
Changes for config/optional/tour.tour.search-api-index-form.yml: 6 added lines, 12 removed lines.
Original line number
Diff line number
Diff line
@@ -21,45 +21,39 @@ tips:
label:Index name
body:Enter a name to identify this index. For example, "Content index". This will only be displayed in the admin user interface.
weight:2
attributes:
data-id:edit-name
selector:'#edit-name'
search-api-index-form-datasources:
id:search-api-index-form-datasources
plugin:text
label:Datasources
body:Datasources define the types of items that will be indexed in this index. By default, all content entities (like content, comments and taxonomy terms) will be available here, but modules can also add their own.
weight:3
attributes:
data-id:edit-datasources
selector:'#edit-datasources'
search-api-index-form-tracker:
id:search-api-index-form-tracker
plugin:text
label:Tracker
body:An index's tracker is the system that keeps track of which items there are available for the index, and which of them still need to be indexed. Changing the tracker of an existing index will lead to reindexing of all items.
weight:4
attributes:
data-id:edit-tracker
selector:'#edit-tracker'
search-api-index-form-server:
id:search-api-index-form-server
plugin:text
label:Server
body:The search server that the index should use for indexing and searching. If no server is selected here, the index cannot be enabled. An index can only have one server, but a server can have any number of indexes.
weight:5
attributes:
data-id:edit-server
selector:'#edit-server'
search-api-index-form-description:
id:search-api-index-form-description
plugin:text
label:Index description
body:Optionally, enter a description to explain the function of the index in more detail. This will only be displayed in the admin user interface.
weight:6
attributes:
data-id:edit-description
selector:'#edit-description'
search-api-index-form-options:
id:search-api-index-form-options
plugin:text
label:Advanced options
body:These options allow more detailed configuration of index behavior, but can usually safely be ignored by inexperienced users.
body:This shows you which enabled processors will be active in the different parts of the indexing/searching workflow, and lets you re-arrange them. This should usually not be necessary, and only be used by advanced users as some processors will lead to unexpected results when used in the wrong order.
weight:3
attributes:
data-id:edit-weights
selector:'#edit-weights'
search-api-index-processors-settings:
id:search-api-index-processors-settings
plugin:text
label:Processor settings
body:Some processors have additional configuration available, which you are able to change here.
Changes for config/optional/tour.tour.search-api-index.yml: 11 added lines, 22 removed lines.
Original line number
Diff line number
Diff line
@@ -20,85 +20,74 @@ tips:
label:Index status
body:This gives a summary about how many items are known for this index, and how many have been indexed in their latest version. Items that are not indexed yet cannot be found by searches.
weight:2
attributes:
data-class:search-api-index-status
selector:'.search-api-index-status'
search-api-index-status:
id:search-api-index-status
plugin:text
label:Status
body:Shows whether the index is currently enabled or disabled.
weight:3
attributes:
data-class:search-api-index-summary--status
selector:'.search-api-index-summary--status'
search-api-index-datasources:
id:search-api-index-datasources
plugin:text
label:Datasources
body:Lists all datasources that are enabled for this index.
weight:4
attributes:
data-class:search-api-index-summary--datasource
selector:'.search-api-index-summary--datasource'
search-api-index-tracker:
id:search-api-index-tracker
plugin:text
label:Tracker
body:The tracker used by the index. Only one ("Default") is available by default.
weight:5
attributes:
data-class:search-api-index-summary--tracker
selector:'.search-api-index-summary--tracker'
search-api-index-server:
id:search-api-index-server
plugin:text
label:Server
body:If the index is attached to a server, this server is listed here.
weight:6
attributes:
data-class:search-api-index-summary--server
selector:'.search-api-index-summary--server'
search-api-index-server-index-status:
id:search-api-index-server-index-status
plugin:text
label:Server index status
body:For enabled indexes, the number of items that can actually be retrieved from the server is listed here. For reasons why this number might differ from the number under "Index status", <a href="https://www.drupal.org/docs/8/modules/search-api/getting-started/frequently-asked-questions#server-index-status">see the module's documentation</a>.
body:The "Start indexing now" form allows indexing items manually right away, with a batch process. Otherwise, items are only indexed during cron runs. The form might be disabled if indexing is currently not possible for some reason, or not necessary.
weight:9
attributes:
data-id:edit-index
selector:'#edit-index'
search-api-index-tracking:
id:search-api-index-tracking
plugin:text
label:Track items for index
body:In certain situations, the index's tracker doesn't have the latest state of the items available for indexing. This will be automatically rectified during cron runs, but can also be manually triggered here, with the "Track now" button.
weight:10
attributes:
data-id:edit-tracking
selector:'#edit-tracking'
search-api-index-reindex:
id:search-api-index-reindex
plugin:text
label:Queue all items for reindexing
body:This will queue all items on this index for reindexing. Previously indexed data will remain on the search server, so searches on this index will continue to yield results.
weight:11
attributes:
data-id:edit-reindex
selector:'.edit-reindex'
search-api-index-clear:
id:search-api-index-clear
plugin:text
label:Clear all indexed data
body:This will remove all indexed content for this index from the search server and queue it for reindexing. Searches on this index will not return any results until items are reindexed.
