Så här uppgraderar du din Salesforce Commerce Cloud-kassett

Du kommer att lära dig

Lär dig hur du uppgraderar din Klaviyo Salesforce Commerce Cloud-kassett. 

Använder du en kassettversion äldre än 23.7.0? Vi rekommenderar att du uppgraderar till version 23.7.0 eller senare omedelbart. Äldre versioner av patronen använder Klaviyos API:er v1 och v2, som har utgått och inte längre fungerar som förväntat. Vi rekommenderar alltid att du uppgraderar till vår senaste version (för närvarande 25.7.0).

Innan du börjar

Version 23.7.0 innehåller ett antal meningsfulla förbättringar, varav några är arkitektoniska förändringar kring hur händelser utlöses. Särskilda överväganden för uppgradering från någon version under 23.70 till någon version över den beskrivs nedan.

Förstå din nuvarande integratör

Det är viktigt att du känner till din nuvarande SFCC-integrerare och vilka ändringar eller anpassningar som kan ha gjorts specifikt för din webbplats. Framför allt bör du överväga om den specifika händelsen data som du skickar till Klaviyo har ändrats eller utökats, och om du har lagt till några anpassade händelser.

Vi rekommenderar att du jämför din kod som sätter ihop händelsen data med den tidigare versionen av Klaviyo -kassetten, som finns på Klaviyo's Github. Förutsatt att din integrationstjänst inte har anpassats mycket, hittar du dina nuvarande monteringsfunktioner för data i int_klaviyo_core/cartridge/scripts/utils/Klaviyo/klaviyoUtils .js och för Order Confirmation i int_klaviyo_core/cartridge/scripts/utils/Klaviyo/emailUtils.js.

Notera eventuella anpassningar så att du kan återanvända dem när den nya patronen har installerats.

Anslut en SFCC-sandlåda till en Klaviyo testkonto

Om du ännu inte har skapat ett sekundärt Klaviyo Konto för testning, separat från det Konto som är kopplat till din SFCC produktionsmiljö, bör du göra det. Anslut sedan din SFCC sandboxmiljö till det nya Kontot. Vi rekommenderar att du genomför detta steg med din tidigare version av Klaviyo Cartridge så att du kan verifiera att händelser skickas till och tas emot av ditt sekundära Klaviyo Konto innan du fortsätter att uppgradera din kodbas med den nya Klaviyo Cartridge.

Ta bort den tidigare Klaviyo-patronkoden

Om din integrerare inte var kraftigt anpassad kommer du att kunna ta bort majoriteten av den tidigare Klaviyo integreraren genom att helt enkelt ta bort de två Klaviyo cartridge-mapparna: int_klaviyo_core och antingen int_klaviyo (för Site Genesis) eller int_klaviyo_sfra (för SFRA) från kodbasen. Du måste dock också ta bort all Klaviyo-specifik kod som kan ha lagts till i mall-filer och eventuellt JavaScript-filer.

För Site Genesis

Standard integrationer för Site Genesis kommer att få följande kod tillagd i footer_UI.isml:

<isinclude template="components/footer/klaviyoFooter"/.>

De kommer också att få följande block tillagt i minicart.isml, cart.isml och alla andra "cart"-isml-filer:

<isif condition="${pdict.CurrentHttpParameterMap.cartAction == 'add' || pdict.CurrentHttpParameterMap.cartAction
  == 'update'}" > 
 < isinclude url="${URLUtils.url('Klaviyo-RenderKlaviyoAddToCart')}" />
</isif>

För SFRA

Standard integrationer för SFCC kommer att ha följande kod tillagd till pageFooter.isml:

<isinclude template="klaviyo/klaviyoFooter"/>

De kommer också att ha följande kod tillagd till AddProduct-rutten i Cart.js-styrenheten:

 if(dw.system.Site.getCurrent().getCustomPreferenceValue('klaviyo_enabled')){
   var KlaviyoUtils = require('*/cartridge/scripts/utils/klaviyo/klaviyoUtils');
 KlaviyoUtils.trackAddToCart();
}

För både Site Genesis och SFRA är det lämpligt att söka efter ordet "Klaviyo" i kodbasen efter att cartridge-mapparna och det ovan nämnda kodsnippet har tagits bort. Se till att du är bekant med vad all Klaviyo-relaterad kod som finns kvar i din kodbas gör innan du tar bort den, eftersom dessa block kan representera anpassningar som du måste sätta tillbaka på plats efter att den nya kassetten har installerats.

Ta bort tjänster

Den tidigare integreraren kommer att ha skapat en KlaviyoTrackService, KlaviyoTrackProfile och KlaviyoTrackCredentials på Administration > Operations > Service. Alla tre kan säkert tas bort eftersom processen med att integrera den nya Klaviyo-kassetten kommer att skapa nya tjänster med olika namn.

Det är inte avgörande att de gamla tjänsterna tas bort, men det rekommenderas att du rensar ut dem för att undvika framtida förvirring.

Granska webbplatsens preferenser

Processen med att integrera den nya Klaviyo-kassetten kommer att behålla några av de tidigare Klaviyo-webbplatspreferenserna och kommer också att lägga till några nya. Ta en titt på dina webbplatsinställningar i inställningsgruppen Klaviyo inställningsgruppen på Merchant tools > Site Preferences > Custom Preferences > Klaviyo , och kontrollera om några anpassade inställningar har lagts till specifikt för din webbplats. Om du har anpassat patronen för att lägga till egna inställningar vill du säkert spara dem. Som referens finns här de fyra webbplatsinställningar som är inbyggda i den tidigare Klaviyo integrationer:

• Klaviyo aktiverad (ID: klaviyo_enabled)
  Flagga om Klaviyo är på eller av.
• Klaviyo Konto (ID: klaviyo_account)
  Ditt Klaviyo offentliga API-nyckel, eller webbplats-ID.
• Klaviyo Privat API-nyckel (ID: klaviyo_api_key)
  En Klaviyo privat API-nyckel.
• Bildtyp för Klaviyo (ID: klaviyo_image_size)
  Stor, liten, miniatyrbild, etc.

Innan du installerar den nya kassetten rekommenderar vi att du säkerhetskopierar dina nuvarande webbplatsinställningar genom att exportera dem på Administration > Site Development > Site importera & Export. Expandera Sites, välj sedan ditt Site Name och markera rutan Site Preferences innan du anger ett filnamn att exportera dem till. Dina nuvarande inställningar för Klaviyo bör inte påverkas negativt när du senare installerar den nya patronen, men det är en god idé att spara dem för framtida bruk.

Ta bort Klaviyo-kassetterna från kassettbanan

Ta bort int_klaviyo_core och antingen int_klaviyo (Site Genesis) eller int_klaviyo_sfra (SFRA) från patronsökvägen på Administration > Sites > Manage Sites > [Site Name] > Settings. Om du inte utför detta steg kommer du att få fel som beror på att SFCC letar efter patroner att ladda som inte längre finns.

Kontrollera om det finns några fel i utvecklarkonsolen och i loggen på serversidan

Vid denna tidpunkt bör du inte längre ha någon Klaviyo-kod i din kodbas. Vi rekommenderar att du granskar din frontend, besöker sidor som sökresultat, PLP:er och PDP:er och utför åtgärder som att lägga till produkter i varukorgen, ange och slutföra kassan. När du gör det, håll ett öga på Developer Console för att se om några nya fel genereras. Gör samma sak med Request Log. Om du ser nya fel relaterade till Klaviyo finns det en god chans att du inte helt har tagit bort all tidigare Klaviyo-kod. Det är viktigt att spåra källan till eventuella nya fel och notera dem innan de tas bort.

Installera den nya Klaviyo-patronen

Följ stegen som beskrivs i Komma igång med Salesforce Commerce Cloud för att integrera den nya kassetten i din kodbas. Det kan finnas steg som du inte behöver slutföra - till exempel har din SFCC-instans kanske inte redan upprättat anslutningarna för OCAPI-delen - men i allmänhet bör du följa varje steg i integrationen. Du kommer definitivt att behöva byta ut båda Klaviyo patronerna och lägga till tillbaka kodsnippet. 

Observera att efter import av metadata.zip, kommer du att ha fyra nya webbplatsinställningar, utöver de fyra som skapades av den tidigare versionen av kassetten. Dina tidigare inställningar bör inte ha påverkats av att du importerar de nya, men vi rekommenderar att du dubbelkollar att alla inställningar på Klaviyo är korrekta innan du fortsätter.

Eftersom du uppgraderar från en kassett före version 23.7.0 ska de nya webbplatsinställningarna Label Events as SFCC och Send Added To Cart Event as 'Add To Cart' ställas in på No respektive Yes. Detta kommer att fortsätta att skicka evenemang utan Salesforce Commerce Cloud mättal-etikett och använda händelsetypen Lägg till i kundvagn (i motsats till den nya Lägg till i kundvagn). Om dessa två inställningar är felaktigt inställda kommer det att leda till att rapporteringen bryts och eventuellt till att befintliga flöden bryts på Klaviyo.

Kontrollera att alla out-of-the-box-händelser fungerar

Innan du försöker lägga till tillbaka i eventuella anpassningar från din tidigare integrationer, se till att kontrollera att den nya installationen av Klaviyo cartridge fungerar korrekt. Använd frontend för att generera händelser för Searched Site, Viewed Category , Viewed Product, Added To Cart, Started kassa och Order Confirmation, och kontrollera sedan din Klaviyo Konto för att se till att dessa händelser spåras korrekt. 

Kontrollera utvecklarkonsolen för eventuella nya fel som kan vara relaterade till integrationsprogrammet på alla sidor som genererar Klaviyo -händelser. Aktivera utförlig tjänsteloggning genom att markera kryssrutan Kommunikationslogg aktiverad på Administration > Drift > Tjänster > KlaviyoEventService - Detaljer och granska sedan loggfilerna på serversidan för att kontrollera att det inte finns några fel och att händelsen data genereras korrekt för varje händelsetyp.

Jämför event data med produktion

Du bör nu jämföra händelsen data i din test- och produktion Klaviyo Konto för att se till att inget saknas och att aktuella värden överensstämmer med den förväntade typen. Det är viktigt att avgöra om någon rapportering eller flöde kommer att påverkas av den nya integreraren. Du kommer att upptäcka att ytterligare egenskaper nu ställs in och skickas till Klaviyo jämfört med den tidigare patronversionen. 

Lägg till tillbaka platsspecifika anpassningar

Du kan nu börja lägga till anpassningar tillbaka i din Klaviyo-kod. På grund av det faktum att det finns stora strukturella och arkitektoniska förändringar med den senaste Klaviyo-kassetten är det osannolikt att du helt enkelt kommer att kunna kopiera och klistra in anpassad kod direkt i Klaviyo-kassetten.

Varje händelsetyp i Klaviyo Cartridge har en getData-funktion som finns i en separat skriptfil som är namngiven för varje händelsetyp. Dessa filer finns i mappen int_klaviyo_core/cartridge/scripts/Klaviyo /eventData och är den mest sannolika platsen som du kommer att ändra för att lägga till eller uppdatera data -objekten som skickas för varje händelse. Om du skapar nya anpassade händelser rekommenderar vi att du följer det etablerade mönstret att lägga till kod i kontroller på serversidan (dvs. direkt i SiteGen eller via server.append i SFRA) som anropar en getData-funktion från en skriptfil som är avsedd för den nya händelsen och sedan använder trackEvent-funktionen för att skicka dessa data till Klaviyo via KlaviyoEventService.

Utfall

Du har nu uppgraderat din Klaviyo-kassett för Salesforce Commerce Cloud. 

Ytterligare resurser 

• Komma igång med Salesforce Commerce Cloud
• Salesforce Commerce Cloud data referens
• Hur ofta integrationer synkroniserar referens
• Så här kontaktar du supporten