You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: src/live-search/indexing.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ When Live Search is configured and synchronized during onboarding, it can take u
33
33
34
34
The following events trigger a full sync and index build:
35
35
36
-
- Onboarding [catalog data sync]({{ site.baseurl }}/live-search/config-connect.html#catalog-data-sync)
36
+
- Onboarding [catalog data sync]({{ site.baseurl }}/live-search/install.html#catalog-data-sync)
37
37
- Changes to attribute metadata
38
38
39
39
For example, changing the `Use in Search` property of the `color` attribute from `No` to `Yes` changes the attribute metadata to `searchable=true`, and triggers a full sync and reindex. The following attribute metadata trigger a full sync and reindex when changed:
@@ -45,7 +45,7 @@ For example, changing the `Use in Search` property of the `color` attribute from
45
45
46
46
### Streaming product updates
47
47
48
-
After the initial index is built during [onboarding]({{ site.baseurl }}/live-search/config-connect.html#catalog-data-sync), the following incremental product updates are continuously synced and reindexed:
48
+
After the initial index is built during [onboarding]({{ site.baseurl }}/live-search/install.html#catalog-data-sync), the following incremental product updates are continuously synced and reindexed:
Live Search is a set of standalone meta packages that replaces standard {{site.data.var.ee}} search capabilities.
9
+
Live Search is a set of standalone meta packages that replaces standard {{site.data.var.ce}} and {{site.data.var.ee}} search capabilities. This topic provides instructions to do the following:
8
10
9
-
|**Package**|**Description**|
11
+
-[Installing Live Search](#before-you-begin) (Methods 1 and 2)
12
+
-[Updating Live Search](#updating-live-search)
13
+
-[Uninstalling Live Search](#uninstalling-live-search)
14
+
15
+
|Package|Description|
10
16
|---|---|
11
17
|`module-live-search`|Allows merchants to configure their search settings for faceting, synonyms, query rules, etc., and provides access to a read-only GraphQL playground to test queries from the {{site.data.var.ee}} Admin. |
12
18
|`module-live-search-adapter`|Routes search requests from the storefront to the Live Search service and renders the results in the storefront. <br />- Category browse - Routes requests from the storefront [top navigation](https://docs.magento.com/user-guide/catalog/navigation-top.html) to the search service.<br />- Global search - Routes requests from the [quick search](https://docs.magento.com/user-guide/catalog/search-quick.html) box in the upper-right of the storefront to the Live Search service.|
@@ -18,44 +24,167 @@ Live Search is a set of standalone meta packages that replaces standard {{site.d
18
24
- PHP 7.3 / 7.4
19
25
- Composer
20
26
21
-
## Step 1: Install Live Search
27
+
## Before you begin
28
+
29
+
Do the following:
30
+
31
+
1. Confirm that [cron jobs]({{ page.baseurl }}/guides/v2.4/config-guide/cli/config-cli-subcommands-cron.html) and [indexers]({{ page.baseurl }}/guides/v2.4/config-guide/cli/config-cli-subcommands-index.html) are running.
32
+
33
+
1. Choose the onboarding method that meets your requirements, and follow the instructions.
34
+
35
+
-[Method 1](#method-1): Install without Elasticsearch
36
+
-[Method 2](#method-2): Install with Elasticsearch (No downtime)
37
+
38
+
## Method 1: Install without Elasticsearch {#method-1}
22
39
23
-
{{site.data.var.ee}} is installed first without Live Search. After the installation, use Composer to install the `live-search` package.
40
+
This onboarding method is recommended when installing Live Search to a:
41
+
42
+
- New Commerce installation
43
+
- Staging environment
44
+
45
+
In this scenario, storefront operations are interrupted while the Live Search service indexes all products in the catalog. During the installation, Live Search modules are enabled and Elasticsearch modules are disabled.
24
46
25
47
1. Install {{site.data.var.ee}} 2.4.x without Live Search.
26
48
27
-
1. To install the `live-search` package, run the following from the command line:
49
+
1. To download the `live-search` package, run the following from the command line:
28
50
29
51
```bash
30
52
composer require magento/live-search
31
53
```
32
54
33
-
### Dependencies
55
+
For more information, see the list of Live Search [dependencies](#live-search-dependencies) that are captured by Composer.
34
56
35
-
The following Live Search dependencies are captured by Composer:
57
+
1. Run the following commands to disable Elasticsearch and related modules and install Live Search:
36
58
37
-
|**Dependency**|**Description**|
38
-
|---|---|
39
-
|Export modules|The following modules collect and sync catalog data:<br />`saas-export`<br />`module-bundle-product-exporter`<br />`module-catalog-data-exporter`<br />`module-catalog-inventory-data-exporter`<br />`module-catalog-url-rewrite-data-exporter`<br />`module-configurable-product-data-exporter`<br />`module-data-exporter`<br />`module-parent-product-data-exporter`|
40
-
|`services-connector`|Required to configure your connection to Commerce Services.|
41
-
|`module-services-id`|Required to configure your connection to Commerce Services.|
While the data is indexed and synchronized, the search and category browse operations are not available in the storefront. Depending on the size of your catalog, the process can take at least an hour from the time `cron` runs to synchronize your data to Live Search services.
69
+
70
+
1. Verify that the following [indexers](https://docs.magento.com/user-guide/system/index-management.html) are set to `Update by Schedule`:
71
+
72
+
- Product Feed
73
+
- Product Variant Feed
74
+
- Catalog Attributes Feed
42
75
43
-
## Step 2: Disable Elasticsearch modules
76
+
1. Configure your [API keys](#configure-api-keys) to [synchronize](#synchronize-catalog-data) your catalog data to Live Search services.
77
+
78
+
1. To make facets available as filters in the storefront, add the [facets](https://docs.magento.com/user-guide/live-search/facets-add.html) you need, according to the [requirements](https://docs.magento.com/user-guide/live-search/facets.html).
79
+
80
+
You should be able to add facets after `cron` runs the attribute feeds and exports attribute metadata.
81
+
82
+
1. Wait at least an hour after `cron` runs to synchronize data. Then, [verify](#verify-export) that the data was exported.
83
+
84
+
1.[Test](#test-the-connection) the connection from the storefront.
85
+
86
+
## Method 2: Install with Elasticsearch {#method-2}
87
+
88
+
This onboarding method is recommended when installing Live Search to:
89
+
90
+
- An existing production Commerce installation
91
+
92
+
In this scenario, Elasticsearch manages search requests from the storefront while the Live Search service indexes all products in the background, without any interruption to normal storefront operations.
93
+
94
+
1. To download the `live-search` package, run the following from the command line:
95
+
96
+
```bash
97
+
composer require magento/live-search
98
+
```
99
+
100
+
For more information, see the list of Live Search [dependencies](#live-search-dependencies) that are captured by Composer.
101
+
102
+
1. Run the following command to temporarily disable the Live Search modules that serve storefront search results.
The modules that allow the native {{site.data.var.ee}} search and category browse pages function must be disabled for Live Search to work. Because Live Search relies on a backend search service, it is no longer necessary to host and configure Elasticsearch. The exception is if Elasticsearch is required by other extensions or customizations that have been added to your {{site.data.var.ee}} installation.
112
+
Elasticsearch continues to manage search requests from the storefront while the Live Search service synchronizes the catalog data and indexes products in the background.
46
113
47
-
1.Check your `app/etc/config.php` file and ensure that the following `ElasticSearch` modules are disabled:
114
+
1.Verify that the following [indexers](https://docs.magento.com/user-guide/system/index-management.html) are set to `Update by Schedule`:
48
115
49
-
-`Magento_ElasticSearch`
50
-
-`Magento_ElasticSearch6`
51
-
-`Magento_ElasticSearch7`
52
-
-`Magento_AdvancedSearch`
53
-
-`Magento_ElasticSearchCatalogPermissions`
54
-
-`Magento_InventoryElasticSearch`
116
+
- Product Feed
117
+
- Product Variant Feed
118
+
- Catalog Attributes Feed
55
119
56
-
This list might change as new modules are added. If you find additional `ElasticSearch` modules in your `config.php` file, disable them also.
120
+
1. Configure your [API keys](#configure-api-keys) to [synchronize](#synchronize-catalog-data)your catalog data to Live Search services.
57
121
58
-
1. In the `core_config_data` table, delete any entry with the `catalog/search/engine` path.
122
+
1. To make facets available as filters in the storefront, add the [facets](https://docs.magento.com/user-guide/live-search/facets-add.html) you need, according to the [requirements](https://docs.magento.com/user-guide/live-search/facets.html).
123
+
124
+
You should be able to add facets after `cron` runs the product and attribute feeds and exports attribute metadata to Live Search services.
125
+
126
+
1. Wait at least an hour for the data to be indexed and synchronized. Then, use the [GraphQL playground]({{ page.baseurl }}/live-search/graphql-support.html) with the default query to verify the following:
127
+
128
+
- The product count returned is close to what you expect for the store view
129
+
- Facet(s) are returned
130
+
131
+
1. Run the following commands to disable Elasticsearch modules, enable Live Search modules, and run setup.
1.[Test](#test-the-connection) the connection from the storefront.
146
+
147
+
## Configure API keys
148
+
149
+
The {{site.data.var.ee}} API key and its associated private key are required to connect Live Search to an installation of {{site.data.var.ee}}. The API key is generated and maintained in the account of the {{site.data.var.ee}} license holder, who can share it with the developer or SI. The developer can then create and manage the SaaS environments on behalf of the license-holder. For detailed instructions, see Commerce Services in the [User Guide](https://docs.magento.com/user-guide/system/saas.html) and [Configuration Reference](https://docs.magento.com/user-guide/configuration/services/saas.html).
150
+
151
+
### {{site.data.var.ee}} license holder
152
+
153
+
To generate an API key and private key, see [Commerce Services](https://docs.magento.com/user-guide/system/saas.html) in the {{site.data.var.ee}} User Guide.
154
+
155
+
### {{site.data.var.ee}} developer or SI
156
+
157
+
The developer or SI configures the SaaS environment as described in the Commerce Services section of the configuration. Commerce Services becomes available in the Admin Configuration sidebar when a SaaS module is installed.
158
+
159
+
## Synchronize catalog data
160
+
161
+
Live Search requires synchronized product data for search operations, and synchronized attribute data to configure facets. The initial synchronization between the product catalog and the catalog service begins when Live Search is first connected. Depending on the installation method and size of the catalog, it can take up to eight hours for the data to be exported and indexed by Live Search. The list of data that is synchronized and shared with the catalog service can be found in the schema, which is defined in:
To verify that the catalog data has been exported from your {{site.data.var.ee}} instance and is synchronized for Live Search, look for entries in the following tables:
168
+
169
+
-`catalog_data_exporter_products`
170
+
-`catalog_data_exporter_product_attributes`
171
+
172
+
For additional help, refer to [Live search catalog not synchronized](https://support.magento.com/hc/en-us/articles/4405637804301-Live-search-catalog-not-synchronized) in the Support Knowledge Base.
173
+
174
+
### Future product updates
175
+
After the initial synchronization, it can take up to fifteen minutes for incremental product updates to become available to storefront search. To learn more, go to [Streaming Product Updates]({{ site.baseurl }}/live-search/indexing.html#streaming-product-updates).
176
+
177
+
## Test the connection
178
+
179
+
In the storefront, verify the following:
180
+
181
+
- The _Search_ box returns results correctly
182
+
- Category browse returns results correctly
183
+
- Facet(s) are available as filters on search results pages
184
+
185
+
If everything works correctly, congratulations! Live Search is installed, connected, and ready to use.
186
+
187
+
If you encounter problems in the storefront, check the `var/log/system.log` file for API communication failures or errors on the services side.
59
188
60
189
## Updating Live Search
61
190
@@ -88,3 +217,13 @@ To update to a major version such as from 1.0 to 2.0, edit the project’s root
88
217
## Uninstalling Live Search
89
218
90
219
To uninstall Live Search, go to [Uninstall modules]({{ site.baseurl }}{{ site.gdeurl }}/install-gde/install/cli/install-cli-uninstall-mods.html).
220
+
221
+
## Live Search dependencies
222
+
223
+
The following Live Search dependencies are captured by Composer:
224
+
225
+
|Dependency|Description|
226
+
|---|---|
227
+
|Export modules|The following modules collect and sync catalog data:<br />`saas-export`<br />`module-bundle-product-exporter`<br />`module-catalog-data-exporter`<br />`module-catalog-inventory-data-exporter`<br />`module-catalog-url-rewrite-data-exporter`<br />`module-configurable-product-data-exporter`<br />`module-data-exporter`<br />`module-parent-product-data-exporter`|
228
+
|`services-connector`|Required to configure your connection to Commerce Services.|
229
+
|`module-services-id`|Required to configure your connection to Commerce Services.|
Copy file name to clipboardExpand all lines: src/live-search/storefront-popover.md
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,7 @@ The following attributes are always searchable:
14
14
-`categories`
15
15
16
16
Review the set of product attributes that are [searchable](https://docs.magento.com/user-guide/stores/attributes-product.html#storefront-properties) (`searchable=true`) to produce highly targeted results. Some attributes that are search-enabled by default, such as `description`, can have the opposite effect and reduce the precision of search results. For example, if a person searches for "shorts" and there are shirts in the catalog with a description that includes "short sleeves", the shirts are also returned. To improve the relevancy of the results, make attributes searchable that contain content that has a clear and concise meaning. Avoid using attributes that contain less precise, lengthy text.
0 commit comments