Skip to content

Commit

Permalink
Merge pull request #559 from AdobeDocs/em_MSRCH-4572
Browse files Browse the repository at this point in the history
Fixing MSRCH-4572
  • Loading branch information
erikmarr authored and GitHub Enterprise committed Jun 13, 2024
2 parents 8423891 + 1c46da0 commit 47e34f2
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 67 deletions.
1 change: 0 additions & 1 deletion help/live-search/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ feature: Services, Search
- [Indexing](indexing.md)
- [GraphQL](graphql.md)
- [Settings](settings.md)
- [Commerce Configuration Settings](configuration.md)
- [Events](events.md)
- GraphQL queries {#graphql}
- [attributeMetadata](https://developer.adobe.com/commerce/services/graphql/live-search/attribute-metadata/)
Expand Down
Binary file added help/live-search/assets/attribute-searchable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion help/live-search/boundaries-limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ When it comes to site search, Adobe Commerce gives you options. Review the follo

## Query

- [!DNL Live Search] does not have access to the full taxonomy of the category tree, which makes some layered navigation search scenarios beyond its reach.
- [!DNL Live Search] uses a unique [GraphQL endpoint](https://developer.adobe.com/commerce/services/graphql/live-search/) for queries to support features such as dynamic faceting and search-as-you-type. Although similar to the [GraphQL API](https://developer.adobe.com/commerce/webapi/graphql/), there are a few differences and some fields may not be fully compatible.
- The maximum number of results that can be returned in a search query is 10,000.
- It is not possible to filter results using a date type attribute.
Expand Down Expand Up @@ -68,3 +67,4 @@ When it comes to site search, Adobe Commerce gives you options. Review the follo
- The "Not Logged in" customer group must be given "Allow" browsing permissions.
- To restrict products to the "Not Logged In" customer group, go to each category and set permission for each customer group.
- Support for B2B with Live Search for PWA Studio is not supported at this time.
- Category facets in [!DNL Live Search] might display categories that are not displayable to a specific customer group.
38 changes: 0 additions & 38 deletions help/live-search/configuration.md

This file was deleted.

16 changes: 5 additions & 11 deletions help/live-search/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ For additional help, see [[!DNL Live Search] catalog not synchronized](https://e
## 5. Configure the data
Getting your product data configured correctly ensures good search results for your customers. In this section, you enable the product listing widgets and assign categories and attributes.
Getting your product data configured correctly ensures good search results for your customers. In this section, you enable the product listing widgets and assign categories.
### Enable Product Listing Widgets
Expand Down Expand Up @@ -192,16 +192,6 @@ When you change this configuration, the message `Page cache is invalidated` appe
Products returned in [!DNL Live Search] must be assigned to a [category](https://experienceleague.adobe.com/en/docs/commerce-admin/catalog/categories/categories). In Luma, for example, products are put into categories such as "Men", "Women", and "Gear". Subcategories are also set up for "Tops", "Bottoms", and "Watches". This allows for better granularity when filtering.
### Searchable and filterable fields
Products are assigned [attributes](https://experienceleague.adobe.com/en/docs/commerce-admin/catalog/product-attributes/product-attributes) that can be used for searching and filtering. Attributes are things such as "Color", "Size", "Material Type". With these attributes, users can look for "green tops". Each product may have many attributes defined in the [!DNL Commerce] Admin.
Each of these attributes can be defined as ["searchable"](https://experienceleague.adobe.com/en/docs/commerce-admin/catalog/catalog/search/search) in the Admin. When set as "searchable", those attributes are available to be searched by [!DNL Live Search].
[Facets](facets.md) are product attributes that are defined in [!DNL Live Search] to be filterable. Any filterable attribute may be set as a facet in [!DNL Live Search] but there are limits to how many facets can be searched at one time.
[Synonyms](synonyms.md) are terms that you can define to help guide users to the correct product. Users looking for pants might type in "trousers" or "slacks". You can set synonyms so that these search terms will get users to the "pants" results.
## 6. Test the connection {#test-connection}
With your catalog data now in SaaS, test to make sure product data is returned in the following scenarios:
Expand Down Expand Up @@ -427,6 +417,10 @@ This module adds additional contexts to GraphQL queries:
- `dataServicesMagentoExtensionContext`
- `dataServicesStoreConfigurationContext`

### B2B support

[!DNL Live Search] supports [B2B functionality](https://experienceleague.adobe.com/en/docs/commerce-admin/b2b/guide-overview) with additional [limitations](boundaries-limits.md#b2b-and-category-permissions).

### PWA support

[!DNL Live Search] works with PWA Studio but users might see slight differences compared to other Commerce implementations. Basic functionality such as search and product listing page work in Venia but some permutations of Graphql might not work correctly. There might also be performance differences.
Expand Down
13 changes: 0 additions & 13 deletions help/live-search/storefront-popover.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,6 @@ By default, [!DNL Live Search] supports [search term redirects](https://experien

![[!DNL Live Search popover]](assets/storefront-search-as-you-type.png)

## Searchable attributes

To produce highly-targeted results, review the set of [searchable](https://experienceleague.adobe.com/docs/commerce-admin/catalog/product-attributes/product-attributes.html) (`searchable=true`) product attributes. To ensure relevancy, make attributes searchable only if they contain content that has a clear and concise meaning. Avoid using attributes that contain less precise, lengthy text such as `description`, which although search-enabled by default, can reduce the precision of search results.
For example, if a person searches for "shorts" and there are shirts with a description that includes the term "short sleeves", then the shirts will be included in the search results.

[!DNL Live Search] also respects the [weight](https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/search/search-results.html#weighted-search) of a product attribute, as set within Adobe Commerce. Attributes with a higher weight will appear higher within the search results.

The following attributes are always searchable:

* `sku`
* `name`
* `categories`

## [!DNL Popover] page size

The page size of the [!DNL popover] determines how many lines of autocompleted products can be returned. Previously, the page size was hardcoded as six lines. However, the `page_size` value is now a setting that can be configured from the *Admin*. During the Live Search installation, the `page_size` value changes to the current value of the [Catalog Search](https://experienceleague.adobe.com/docs/commerce-admin/config/catalog/catalog.html) - `Autocomplete Limit` setting.
Expand Down
61 changes: 58 additions & 3 deletions help/live-search/workspace.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'Workspace'
title: 'Setting up Live Search'
description: The [!DNL Live Search] workspace is used to configure, manage, and monitor search performance.
exl-id: fb85974a-a5f9-4e6c-bd03-451e6457f2d2
---
# Workspace
# Setting up Live Search

The workspace is where you configure, manage, and monitor the performance of [!DNL Live Search]. The menu across the top provides access to the tools in each functional area. The available features reflect the current menu selection.
The workspace is where you configure, manage, and monitor the performance of [!DNL Live Search]. The menu across the top provides access to the tools in each functional area. The available features reflect the current menu selection.

![Workspace](assets/workspace.png)

Expand All @@ -24,3 +24,58 @@ Initially the [scope](https://experienceleague.adobe.com/docs/commerce-admin/sta
| [Category Merchandising](category-merch.md) | Apply rules and Intelligent Merchandising on the Category level. |
| [GraphQL](graphql.md) | Developers who are logged into the Admin of your store can compose and test queries with actual catalog data. To learn more, go to [GraphQL Overview](https://developer.adobe.com/commerce/webapi/graphql/) in the [!DNL Live Search] developer documentation. |
| [Settings](settings.md) | Determine how price facet values are grouped by price range in the storefront and set the indexing language. |

## Set attributes as searchable

To produce highly-targeted results, review the set of [searchable](https://experienceleague.adobe.com/docs/commerce-admin/catalog/product-attributes/product-attributes.html) (`searchable=true`) product attributes. To ensure relevancy, make attributes searchable only if they contain content that has a clear and concise meaning. Avoid using attributes that contain less precise, lengthy text such as `description`, which although search-enabled by default, can reduce the precision of search results. For example, if a person searches for "shorts" and there are shirts with a description that includes the term "short sleeves", then the shirts will be included in the search results.

To allow attributes to be searchable, complete the following steps:

1. In the Admin, go to **Stores** > *Attribute* > **Product**.
1. Select the attribute you want to be searchable, such as `color`.
1. Select **Storefront Properties** and set **Use in Search** to `yes`.

![Workspace](assets/attribute-searchable.png)

[!DNL Live Search] also respects the [weight](https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/search/search-results.html#weighted-search) of a product attribute, as set within Adobe Commerce. Attributes with a higher weight will appear higher within the search results.

The following attributes are always searchable:

* `sku`
* `name`
* `categories`

[Facets](facets.md) are product attributes that are defined in [!DNL Live Search] to be filterable. You can set any filterable attribute as a facet in [!DNL Live Search], but there are [limits](boundaries-limits.md) to how many facets you can search for at one time.

[Synonyms](synonyms.md) are terms that you can define to help guide users to the correct product. Users looking for pants might type in "trousers" or "slacks". You can set synonyms so that these search terms will get users to the "pants" results.

## Commerce Configuration Settings

The following section describes the supported and unsupported Commerce configuration settings for [!DNL Live Search].

### Supported configuration values

|Commerce Configuration Setting|Description|Supported by Popover|Supported by Adapter|
|---|---|---|---|
|Stores > Configuration > Catalog > Catalog > Catalog Search > Allow All Products per Page|If set to `Yes`, includes the `ALL` option in the "Show per Page" control.| Yes. Max 500 products|Yes. Max 500 products|
|Stores > Configuration > Catalog > Catalog > Catalog Search > Minimal Query Length|The minimum number of characters allowed in a catalog search.|Yes|Yes|
|Stores > Configuration > Catalog > Catalog > Catalog Search > Products per Page on Grid Allowed Values|Determines the number of products displayed in Grid View.|Yes|Yes|
|Stores > Configuration > Catalog > Catalog > Catalog Search > Products per Page on Grid Default Value|Determines the number of products displayed per page by default in grid view.|Yes. Max 500 products|Yes. Max 500 products|
|Stores > Configuration > Catalog > Inventory > Display Out of Stock Products|Displays products that are out of stock.|Yes w/ v2.0.4+|Yes w/ v2.0.4+|
|Stores > Configuration > Currency > Default Display Currency|The primary currency used to display prices.|Yes w/3.1.0+|Yes w/3.1.0+|
|Stores > Configuration > General > Currency Setup > Currency Options > Base Currency|The primary currency used for all online payment transactions.|Yes|Yes|

Prices in the Widget Product Listing Page and Popover are converted to the Default Display Currency using the configured Currency Rates.

### Unsupported configuration values

|Commerce Configuration Setting|Description|Notes|
|---|---|---|
|Stores > Configuration > Catalog > Storefront > List Mode|Determines the format of the search results list.|Renders correctly, but events are not sent for some page interactions|
|Stores > Configuration > Catalog > Catalog > Catalog Search > Maximum Query Length|The maximum number of characters allowed in a catalog search.|Not implemented; Search Services accepts up to 255 characters|
|Configuration > Sales > Tax > Price Display Settings > Display Product Prices In Catalog|Determines if product prices published in the catalog include or exclude tax, or show two versions of the price; one with, and the other without tax||
|Stores > Configuration > Catalog > Storefront > Product Listing Sort By|Determines the sort order of the search results list.|Does not apply to the [!DNL Live Search] [Product Listing Page Widget](plp-styling.md)|

### Search terms

[!DNL Live Search] supports [search term redirects](https://experienceleague.adobe.com/docs/commerce-admin/catalog/catalog/search/search-terms.html) on implementations where Adobe Commerce handles the routing, such as on Luma and other php-based themes.
1 change: 1 addition & 0 deletions help/product-recommendations/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ These notes describe updates that were published outside of a versioned release
[!BADGE Supported]{type=Informative tooltip="Supported"} Adobe Commerce versions 2.4.4 and newer

![Fix](../assets/fix.svg) Fixed an issue where clicking the **[!DNL Add to Cart]** button on a simple product inside a Product Recommendations unit redirected the shopper to the home page rather than staying on the current page.
![Bug](../assets/bug.svg) There is a validation error caused by the `referenceBlock` element in the `ProductRecommendations Layout` XML file.

### Previous versions

Expand Down

0 comments on commit 47e34f2

Please sign in to comment.