Instellen voor succes met Live Search
Adobe Commerce Live Search en Catalog Service werken samen om een krachtige, relevante en intuïtieve zoekoplossing te bieden, zodat uw klanten snel precies kunnen vinden wat ze nodig hebben. Catalog Service bevat met name de catalogusgegevens die u wilt gebruiken voor SaaS-services, zoals Live Search .
Dit artikel bevat stapsgewijze instructies voor het implementeren van Live Search met Catalog Service .
Publiek
Dit artikel is bedoeld voor de ontwikkelaar of systeemintegrator in uw team die verantwoordelijk is voor de installatie en configuratie van uw Adobe Commerce-exemplaar.
Vereisten
- Adobe Commerce 2.4.4+
- PHP 8.1, 8.2 of 8.3
- Composer
- Snijtaken en indexeerders uitvoeren
Belangrijke updates
- Vanaf Live Search 3.0.2 wordt de extensie Catalog Service gebundeld met de installatie.
Ondersteunde platforms
- Adobe Commerce on Cloud (ECE) : 2.4.4+
- Adobe Commerce on-prem (EE) : 2.4.4+
Workflowoverzicht
Op een hoog niveau is het vereist dat u: Live Search
- installeer de Live Search uitbreiding
- vorm de API sleutels
- Synchroniseer uw catalogusgegevens
- verifieer dat de catalogusgegevens werden uitgevoerd
- vorm de gegevens
- Test de verbinding
- bevestigt dat de gebeurtenissen gegevens vangen
- pas uw storefront aan
1. Installeer de extensie Live Search
Live Search is geïnstalleerd als uitbreiding van Adobe Marketplace door Composer . Nadat u Live Search hebt geïnstalleerd en geconfigureerd, begint Adobe Commerce met het delen van zoek- en catalogusgegevens met SaaS-services. Op dit punt, Admin kunnen de gebruikers opstelling, aanpassen, en onderzoeksfacetten, synoniemen, en handelswijzigingsregels beheren.
Volg deze instructies als u Live Search op een nieuw Commerce-exemplaar installeert.
-
Bevestig dat gewassenbanen en indexeerders lopen.
-
Gebruik Composer om de module Live zoeken toe te voegen aan uw project:
code language-bash composer require magento/live-search --no-update
-
Afhankelijkheden bijwerken en de extensie installeren:
code language-bash composer update magento/live-search --with-dependencies
-
Schakel OpenSearch en verwante modules uit en installeer Live Search . OpenSearch en Live Search kunnen niet beide op dezelfde Commerce-instantie worden ingeschakeld.
code language-bash bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch8 Magento_Elasticsearch7 Magento_OpenSearch Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
Elasticsearch blijft zoekverzoeken van de winkel beheren terwijl de Live Search -service catalogusgegevens en indexproducten op de achtergrond synchroniseert.
-
Installeer de updates.
code language-bash bin/magento setup:upgrade
-
Verifieer dat de volgende indexeerders aan "Update door Programma"worden geplaatst:
- Productfeed
- Diervoeders voor productvarianten
- Feed voor cataloguskenmerken
- Diervoeders productprijzen
- Websitegegevensfeed
- Scopes Klantengroepen Gegevensfeed
- Diervoeders voor categorieën
- Diervoeders voor categorierechten
Na het verifiëren van de indexen, is de volgende stap de API sleutels te vormen .
Volg deze instructies als u Live Search op een bestaande Commerce-instantie installeert.
-
Bevestig dat gewassenbanen en indexeerders lopen.
-
Gebruik Composer om de module Live zoeken toe te voegen aan uw project:
code language-bash composer require magento/live-search --no-update
-
Afhankelijkheden bijwerken en de extensie installeren:
code language-bash composer update magento/live-search --with-dependencies
-
Schakel de Live Search -modules uit die de zoekresultaten van de winkel dienen.
code language-bash bin/magento module:disable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
Elasticsearch blijft zoekverzoeken van de winkel beheren terwijl de Live Search -service catalogusgegevens en indexproducten op de achtergrond synchroniseert.
-
Installeer de updates.
code language-bash bin/magento setup:upgrade
-
Verifieer dat de volgende indexeerders aan "Update door Programma"worden geplaatst:
- Productfeed
- Diervoeders voor productvarianten
- Feed voor cataloguskenmerken
- Diervoeders productprijzen
- Websitegegevensfeed
- Scopes Klantengroepen Gegevensfeed
- Diervoeders voor categorieën
- Diervoeders voor categorierechten
-
Schakel de extensie Live Search in en schakel OpenSearch uit (de modules Magento Elasticsearch en OpenSearch).
code language-bash bin/magento module:enable Magento_LiveSearchAdapter Magento_LiveSearchStorefrontPopover Magento_LiveSearchProductListing
code language-none bin/magento module:disable Magento_Elasticsearch Magento_Elasticsearch6 Magento_Elasticsearch7 Magento_Elasticsearch8 Magento_OpenSearch Magento_ElasticsearchCatalogPermissions Magento_InventoryElasticsearch Magento_ElasticsearchCatalogPermissionsGraphQl
note note NOTE De opdracht Uitschakelen bevat een lijst met Commerce-modules die OpenSearch ondersteunen. Als er geen module is geïnstalleerd op uw Commerce-instantie, wordt een module does not exist
-fout weergegeven. -
Installeer de updates.
code language-bash bin/magento setup:upgrade
Na het verifiëren van de indexen, is de volgende stap de API sleutels te vormen .
2. API-sleutels configureren
De Adobe Commerce API-sleutel en de bijbehorende persoonlijke sleutel zijn vereist om Live Search te verbinden met een installatie van Adobe Commerce. De API-sleutel wordt gegenereerd en onderhouden in de account van de Commerce -licentienemer, die deze kan delen met de ontwikkelaar of de systeemintegrator. De ontwikkelaar kan vervolgens de SaaS-gegevensruimten maken en beheren namens de licentiehouder. Als u al een set API-sleutels hebt, hoeft u deze niet opnieuw te genereren.
Leer hoe te om uw API sleutels in het 1} artikel van de Schakelaar van de Diensten van Commerce te vormen.
3. Synchroniseer uw catalogusgegevens
Live Search verplaatst catalogusgegevens naar de Adobe-SaaS-infrastructuur. De gegevens worden geïndexeerd en de zoekresultaten worden vanuit deze index rechtstreeks aan de winkel geleverd. Afhankelijk van de grootte en complexiteit kan het indexeren 30 minuten tot een paar uur duren.
Voer de volgende opdrachten in deze volgorde uit om te beginnen met de eerste synchronisatie van uw catalogusgegevens naar SaaS-services:
bin/magento saas:resync --feed productattributes
bin/magento saas:resync --feed products
bin/magento saas:resync --feed scopesCustomerGroup
bin/magento saas:resync --feed scopesWebsite
bin/magento saas:resync --feed prices
bin/magento saas:resync --feed productoverrides
bin/magento saas:resync --feed variants
bin/magento saas:resync --feed categories
bin/magento saas:resync --feed categoryPermissions
Wanneer u deze opdrachten uitvoert, begint de eerste synchronisatie van de catalogusgegevens met de SaaS-services.
Synchronisatievoortgang controleren
Gebruik het dashboard van het Beheer van Gegevens om synchronisatievooruitgang te controleren. Dit dashboard biedt waardevolle inzichten in de beschikbaarheid van productgegevens in uw winkel, zodat deze direct aan klanten kunnen worden weergegeven.
U kunt synchronisatiebevelen ook in werking stellen en het synchronisatieproces problemen oplossen gebruikend Commerce CLI en de logboeken van de gegevensuitvoer.
Updates voor toekomstige producten
Na de eerste synchronisatie kan het tot 15 minuten duren voordat de incrementele productupdates beschikbaar komen voor het zoeken naar een winkel. Om meer te leren, zie {de Updates van het Product van 0} Streaming in de Indexerende documentatie.
4. Controleer of de gegevens zijn geëxporteerd
Als u wilt controleren of uw catalogusgegevens uit Adobe Commerce zijn geëxporteerd en met Live Search zijn gesynchroniseerd, hebt u een aantal opties:
-
Zoek naar ingangen in de volgende lijsten:
cde_products_feed
cde_product_attributes_feed
note note NOTE Als u een table does not exist
-fout krijgt, zoekt u naar items in de tabellencatalog_data_exporter_products
encatalog_data_exporter_product_attributes
. Deze tabelnamen worden gebruikt in eerdere Live Search versies dan 4.2.1. -
Gebruik playground van GraphQL met de standaardvraag (zie verwijzing van GraphQL voor meer details) om het volgende te verifiëren:
- Het aantal geretourneerde producten ligt dicht bij wat u voor de winkelweergave verwacht.
- Facetten worden geretourneerd.
Voor extra hulp, zie Live Search niet gesynchroniseerde catalogus in de Kennisbank van de Steun.
5. Vorm de gegevens
Als u uw productgegevens correct configureert, bent u verzekerd van goede zoekresultaten voor uw klanten. In deze sectie schakelt u de widgets voor productlijsten in en wijst u categorieën toe.
Widgets voor productaanbiedingen inschakelen
Wanneer u Live Search 4.0.0+ installeert, zijn de widgets voor productlijsten standaard ingeschakeld. Wanneer widgets zijn ingeschakeld, wordt een andere UI-component gebruikt voor de zoekresultaten en bladeren in categorieën door pagina's met productlijsten. Deze component UI doet directe vraag aan de Dienst API van de Catalogus , die in snellere reactietijden resulteert.
Als u een Live Search -versie hebt die ouder is dan 4.0.0+, moet u de widget Productaanbieding handmatig inschakelen.
-
Van Admin, ga Stores > Settings>Configuration.
-
Selecteer onder Live Search de optie Storefront Features .
-
Stel Enable Product Listing Widgets in op
Yes
.
Wanneer u deze configuratie wijzigt, verschijnt het bericht Page cache is invalidated
. U moet de Magento Cache leegmaken om de wijziging op te slaan.
-
Heb toegang tot de pagina van het Beheer van het Geheime voorgeheugen door één van het volgende te doen:
- Klik op de koppeling Cache Management in het bericht boven de werkruimte.
- Voor Admin sidebar, ga System > Tools>Cache Management.
-
Selecteer de Configuratie Cache Type en klik Flush Magento Cache.
Wijzigingen in de winkel worden direct na het leegmaken van de cache aangebracht.
Categorieën toewijzen
De producten die in Live Search zijn teruggekeerd moeten aan a worden toegewezen categorie . In Luma worden producten bijvoorbeeld ingedeeld in categorieën zoals "Mannen", "Vrouwen" en "Luma". Subcategorieën worden ook ingesteld voor Tops, Bottoms en Watches. Deze categorietoewijzingen verbeteren de granulariteit bij het filteren.
6. Test de verbinding
Met uw catalogusgegevens nu in SaaS, test om ervoor te zorgen de productgegevens in de volgende scenario's zijn teruggekeerd:
- Het vak Search retourneert de juiste resultaten
- Met bladeren door categorie worden de resultaten correct geretourneerd
- Factoren zijn als filters beschikbaar op pagina's met zoekresultaten
Als alles correct werkt, wordt Live Search geïnstalleerd, aangesloten en klaar te gebruiken.
Als u problemen tegenkomt in de winkel, controleert u het bestand var/log/system.log
op API-communicatiefouten of -fouten aan de kant van de service.
Als u Live Search wilt toestaan via een firewall, voegt u commerce.adobe.io
toe aan de lijst van gewenste personen.
7. Controleer of gebeurtenissen gegevens vastleggen
Zorg ervoor dat de storefront-gebeurtenissen die op uw site zijn geïmplementeerd, werken. Deze controle is vooral belangrijk voor implementatie zonder kop.
- Herzie de gebeurtenissen die voor Live Search worden vereist.
- Zorg ervoor dat het Levende dashboard van het Onderzoek gegevens van uw niet-productiemilieu(s) toont.
- verifieer gebeurtenisinzameling .
8. Aanpassen voor je winkel
U hebt de extensie Live Search geïnstalleerd, gesynchroniseerd, gevalideerd en geconfigureerd. De volgende stap is ervoor te zorgen dat de Live Search widgets in overeenstemming zijn met het uiterlijk van uw winkel.
U kunt de popover- en PLP-widgets opmaken door desgewenst aangepaste CSS-regels te definiëren. Zie het Stijlen Popover Elementen en product die pagina widget van de lijst voorzien.
Als u de functionaliteit van de widgets wilt uitbreiden, is de broncode voor elke widget beschikbaar in een openbare reactie.
In dit scenario, kunt u JavaScript voor uw eigen behoeften aanpassen en dan uw douanecode ontvangen op uw CDN. Dit aangepaste script communiceert met de service Live Search en retourneert de resultaten zoals normaal, zodat u de functionaliteit van de widget kunt beheren.
Live Search bijwerken
Controleer voordat u Live Search bijwerkt de versie van Live Search die met Composer is geïnstalleerd.
composer show magento/module-live-search | grep version
Voer de volgende handelingen uit vanaf de opdrachtregel om Live Search bij te werken:
composer update magento/live-search --with-dependencies
Als u een update wilt uitvoeren naar een belangrijke versie zoals 3.1.1 en 4.0.0, bewerkt u het hoofdbestand Composer .json
van het project als volgt:
-
Als de momenteel geïnstalleerde
magento/live-search
versie3.1.1
of lager is en u een upgrade uitvoert naar versie4.0.0
of hoger, voert u de volgende opdracht uit vóór de upgrade:code language-bash bin/magento module:enable Magento_AdvancedSearch
Voer de volgende opdracht uit voor informatie over de momenteel geïnstalleerde versie van
magento/live-search
:code language-bash composer show magento/live-search
-
Open het hoofdbestand
composer.json
en zoek naarmagento/live-search
. -
Werk in de sectie
require
het versienummer als volgt bij:code language-json "require": { ... "magento/live-search": "^4.0", ... }
-
Opslaan
composer.json
. Voer vervolgens de volgende handelingen uit vanaf de opdrachtregel:code language-bash composer update magento/live-search --with-dependencies
Live Search verwijderen
Om Live Search te desinstalleren, verwijs naar modules van de Desinstallatie .
Live Search pakketten
De extensie Live Search bestaat uit de volgende pakketten:
module-live-search
module-live-search-adapter
- de doorblader van de Categorie - Routes verzoekt van de storefront hoogste navigatie aan de onderzoeksdienst.
- Globale onderzoek - Routes verzoekt van het snelle onderzoek gebied aan de Live Search dienst. Het snelzoekveld bevindt zich in de rechterbovenhoek van de winkelpagina.
module-live-search-storefront-popover
Live Search afhankelijkheden
Het Composer -pakket voor het installeren van de extensie Live Search bevat de volgende moduleafhankelijkheden.
magento/module-saas-catalog
magento/module-saas-category
magento/module-saas-category-permissions
magento/module-saas-product-override
magento/module-saas-product-variant
magento/module-saas-price
magento/module-saas-scopes
magento/module-bundle-product-data-exporter
magento/module-catalog-inventory-data-exporter
magento/module-catalog-url-rewrite-data-exporter
magento/module-configurable-product-data-exporter
magento/module-parent-product-data-exporter
magento/module-gift-card-product-data-exporter
magento/module-bundle-product-override-data-exporter
data-services
services-id
Geavanceerde concepten
De volgende secties bieden geavanceerdere onderwerpen wanneer u Live Search en Catalog Service gebruikt.
Endpoint
Live Search communiceert via het eindpunt op https://catalog-service.adobe.io/graphql
.
Aangezien Live Search geen toegang heeft tot de volledige productdatabase, hebben de Live Search GraphQL en Commerce core GraphQL API's geen volledige pariteit.
Adobe raadt aan de SaaS APIs rechtstreeks aan te roepen — met name het eindpunt van de Catalogusservice.
- Verhoog de prestaties en verlaag de processorbelasting door het Commerce-database/Graphql-proces te omzeilen
- Haal voordeel uit de Catalog Service -federatie om Live Search , Catalog Service en Product Recommendations vanaf één eindpunt aan te roepen.
In sommige gevallen is het beter om Catalog Service op te roepen voor productdetails en vergelijkbare gevallen. Zie refineProduct voor meer informatie.
Als u een aangepaste implementatie zonder kop hebt, checkt u de Live Search referentie-implementaties uit:
Automatische verzameling van gegevens over gebruikersinteractie werkt niet standaard als u de standaardcomponenten niet gebruikt, zoals Zoekadapter, Luminagewidgets of AEM CIF-widgets. Adobe Sensei gebruikt deze verzamelde gegevens voor intelligent winkelen en het volgen van prestaties. Om deze kwestie op te lossen, moet u een douaneoplossing ontwikkelen om deze gegevensinzameling op een krantenloze manier uit te voeren.
De meest recente versie van Live Search gebruikt Catalog Service al.
Taalondersteuning
Live Search -widgets ondersteunen de volgende talen:
Als de widget detecteert dat de taalinstelling voor Commerce Admin overeenkomt met een ondersteunde taal, wordt deze taal standaard gebruikt. Anders is de widget standaard ingesteld op Engels. In de beheerfunctie wordt de taalinstelling geconfigureerd door te navigeren naar Stores> Settings >Configuration > General> Country Options .
Admins kan de taal van de onderzoeksindex ook plaatsen, helpen betere onderzoeksresultaten verzekeren.
Widget-codeopslagplaats
De code voor de productpagina widget en de Live Search veld widget is beschikbaar voor downloaden via GitHub.
Ontwikkelaars die toegang hebben tot de code, kunnen de werking en het uiterlijk van de code volledig aanpassen. Ze hosten de code op hun eigen servers, maar gebruiken toch de Live Search -service.
Extensie Gegevens
Nadat Live Search is ingeschakeld, synchroniseert de extensie Gegevens exporteren Commerce-gegevens tussen de Commerce-toepassing en Live Search . Dit proces zorgt ervoor dat de meest recente Commerce-gegevens beschikbaar zijn in de winkel. In Admin, kunt u synchronisatiestatus controleren gebruikend het dashboard van het Beheer van Gegevens. U kunt het gegevensexportproces beheren en problemen oplossen met de Commerce CLI en de logboeken. Voor details, zie de Gids van de Uitvoer van Gegevens .
Inventory management
Live Search steunt Inventory management mogelijkheden in Commerce (weet vroeger als Voorraad Multi-Source, of MSI). Om volledige steun toe te laten, moet u de gebiedsdeelmodule aan versie 102.2.0+ bijwerken.commerce-data-export
Live Search retourneert een Booleaanse waarde die aangeeft of een product beschikbaar is in Inventory management, maar die geen informatie bevat over de bron die de voorraad heeft.
Prijsindexering
Live Search klanten kunnen SaaS prijsindexeerder gebruiken, die snellere de updates van de prijsverandering en synchronisatietijd verstrekt.
Prijsondersteuning
Live Search -widgets ondersteunen de meeste, maar niet alle, door Adobe Commerce ondersteunde prijstypen.
Momenteel worden de basisprijzen ondersteund. Geavanceerde prijzen die niet worden ondersteund zijn:
- Kosten
- Minimale geadverteerde prijs
Kijk naar API Net voor complexere prijsberekeningen.
Het prijsformaat steunt de scèneconfiguratie die binnen de instantie van Commerce plaatst: Slaat > Montages > Configuratie > Algemeen > Algemene > Lokale Opties > Scène op.
Ondersteuning voor headless Storefront
U kunt desgewenst de module module-data-services-graphql
installeren die de bestaande GraphQL-dekking van de toepassing uitbreidt, zodat deze velden bevat die vereist zijn voor het verzamelen van gedragsgegevens van de winkel.
composer require magento/module-data-services-graphql
Deze module voegt extra contexten aan de vragen van GraphQL toe:
dataServicesStorefrontInstanceContext
dataServicesMagentoExtensionContext
dataServicesStoreConfigurationContext
B2B-ondersteuning
Live Search steunt functionaliteit B2B met extra beperkingen .
PWA-ondersteuning
Live Search werkt met PWA Studio, maar gebruikers zien mogelijk kleine verschillen ten opzichte van andere Commerce-implementaties. De basisfunctionaliteit zoals zoeken en pagina met productlijsten werkt in Venia, maar sommige permutaties van Graphql werken mogelijk niet correct. Er kunnen ook prestatieverschillen zijn.
- De huidige PWA-implementatie van Live Search vereist meer verwerkingstijd om zoekresultaten te retourneren dan Live Search met de native Commerce-winkel.
- Live Search in PWA steunt gebeurtenis behandeling niet. Het resultaat is dat zoekrapporten en intelligente koopwaar niet werken op PWA-winkelpagina's.
- Wanneer het gebruiken van PWA Studio , steunt GraphQL niet direct het filtreren op
description
,name
,short_description
, maar deze gebieden kunnen met een meer algemene filter zijn teruggekeerd.
Als u Live Search wilt gebruiken met PWA Studio, moeten integrators ook:
-
Installeer livessearch-storefront-utils .
-
Stel de waarde
environmentId
in hetstoreDetails
-object in.code language-javascript const storeDetails: StoreDetailsProps = { environmentId: <Storefront_ID>, websiteCode: "base", storeCode: "main_website_store", storeViewCode: "default", searchUnitId: searchUnitId, config: { minQueryLength: 5, pageSize: 8, currencySymbol: "$", }, };
Cookies
Live Search verzamelt gegevens over gebruikersinteractie om de zoekfunctionaliteit te verbeteren en slaat deze informatie op in browsercookies. Voor deze gegevensverzameling is toestemming van de gebruiker vereist wanneer cookie-beperkingen zijn ingeschakeld. Live Search en Product Recommendations delen hetzelfde gegevensverzamelingsmechanisme en dezelfde cookie-afhandeling. Voor meer informatie over koekjesbeperkingen en privacynaleving, zie {de Beperkingen van het Koekje van 0} Handle .