Så uppgraderar du din Salesforce Commerce Cloud-kassett

Du kommer att lära dig

Läs mer om hur du uppgraderar din Klaviyo Salesforce Commerce Cloud-cartridge.

Använder du en patronversion som är äldre än 23.7.0? Vi rekommenderar att du omedelbart uppgraderar till version 23.7.0 eller senare. Äldre versioner av patronen använder Klaviyos v1- och v2-API som har dragits tillbaka 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 vissa är arkitekturändringar i hur händelser utlöses. Särskilda saker att tänka på vid uppgradering från en version under 23.70 till en version över den beskrivs nedan.

Förstå din nuvarande integration

Det är viktigt att du känner till din nuvarande SFCC-integration och vilka ändringar eller anpassningar som kan ha gjorts specifikt för din webbplats. Viktigast av allt är att du bör tänka på om de specifika händelsedata 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 sammanställer händelsedata med den tidigare versionen av Klaviyo-cartridgen, som finns på Klaviyos Github. Om din integration inte har anpassats i någon större utsträckning hittar du dina nuvarande dataassemblagefunktioner i int_klaviyo_core/cartridge/scripts/utils/klaviyo/klaviyoUtils.js och för Orderbekräftelse i int_klaviyo_core/cartridge/scripts/utils/klaviyo/emailUtils.js.

Notera eventuella anpassningar så att du kan tillämpa dem igen när den nya kassetten har installerats.

Anslut en SFCC-sandlåda till ett Klaviyo-testkonto

Om du ännu inte har skapat ett sekundärt Klaviyo-konto för testning, separat från kontot som är kopplat till din SFCC-produktionsmiljö, ska du göra det. Anslut sedan din SFCC-sandlådemiljö till det nya kontot. Vi rekommenderar att du slutför det här steget med din tidigare Klaviyo-cartridgeversion så att du kan verifiera att händelser skickas och tas emot av ditt sekundära Klaviyo-konto innan du fortsätter med att uppgradera din kodbas med den nya Klaviyo-cartridgen.

Ta bort den tidigare Klaviyo-cartridge-koden

Om din integration inte var kraftigt anpassad kan du ta bort merparten av den tidigare Klaviyo-integrationen 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 mallfiler och eventuellt JavaScript-filer.

För Site Genesis

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

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

De kommer också att lägga till följande block 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 få följande kod tillagd i pageFooter.isml:

<isinclude template="klaviyo/klaviyoFooter"/>

De kommer också att få följande kod tillagd till AddProduct-routen i Cart.js-kontrollern:

 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, efter att cartridge-mapparna och de ovan nämnda kodsnippeten har tagits bort, lämpligt att söka i kodbasen efter ordet ”Klaviyo”. Se till att du är bekant med vad eventuell Klaviyo-relaterad kod som fortfarande finns kvar i din kodbas gör innan du tar bort den, eftersom dessa block kan representera anpassningar som du behöver lägga tillbaka efter att den nya kassetten har installerats.

Ta bort tjänster

Den tidigare integrationer kommer att ha skapat en KlaviyoTrackService, KlaviyoTrackProfile och KlaviyoTrackCredentials under Administration > Operations > Service. Alla tre kan tas bort på ett säkert sätt eftersom processen för att integrera den nya Klaviyo-kassetten skapar nya tjänster med andra namn.

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

Granska webbplatsinställningar

Processen för att integrera den nya Klaviyo-kassetten behåller vissa av de tidigare webbplatsinställningarna för Klaviyo och lägger även till några nya. Ta en titt på dina webbplatsinställningar i inställningsgruppen Klaviyo under 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 anpassade kundvagnen för att lägga till dina egna inställningar vill du bevara dem. Som referens finns här de fyra webbplatsinställningar som är inbyggda i den tidigare Klaviyo-integrationen:

• Klaviyo Enabled (ID: klaviyo_enabled)
  Flagga om Klaviyo är på eller av.
• Klaviyo-konto (ID: klaviyo_account)
  Din offentliga API-nyckel i Klaviyo, eller ditt webbplats-ID.
• Klaviyo Private API-nyckel (ID: klaviyo_api_key)
  En privat API-nyckel för Klaviyo.
• Bildtyp för Klaviyo (ID: klaviyo_image_size)
  Stor, liten, miniatyrbild osv.

Innan du konfigurerar den nya kassetten rekommenderar vi att du säkerhetskopierar dina aktuella webbplatsinställningar genom att exportera dem via Administration > Site Development > Site Import & Export. Expandera Sites och sedan ditt Site Name och markera rutan Webbplatsinställningar innan du anger ett filnamn för att exportera dem. Dina nuvarande inställningar i Klaviyo bör inte påverkas negativt när du senare installerar den nya kassetten, men det är en bra idé att säkerhetskopiera dem för framtida referens.

Ta bort Klaviyo-cartridgerna från cartridge-sökvägen

Ta bort int_klaviyo_core och antingen int_klaviyo (Site Genesis) eller int_klaviyo_sfra (SFRA) från din cartridge-sökväg på Administration > Sites > Manage Sites > [Site Name] > Settings. Om du inte utför det här steget får du fel eftersom SFCC försöker hitta cartridges att läsa in som inte längre finns.

Kontrollera utvecklarkonsolen och loggen på serversidan efter fel

Nu 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 kundvagnen, påbörja och slutföra kassan. När du gör det ska du hålla 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 som är relaterade till Klaviyo finns det en stor chans att du inte har tagit bort all den tidigare Klaviyo-koden helt. Det är viktigt att spåra källan till eventuella nya fel och notera dem innan du tar bort dem.

Installera den nya Klaviyo-kassetten

Följ stegen som beskrivs i Komma igång med Salesforce Commerce Cloud för att integrera den nya cartridge-modulen i din kodbas. Det kan finnas steg som du inte behöver slutföra – till exempel kanske din SFCC-instans redan har anslutningarna etablerade för OCAPI-delen, eller kanske inte – men i allmänhet bör du följa varje steg i integrationer. Du måste definitivt ersätta båda Klaviyo-cartridge-modulerna och lägga tillbaka kodsnippet.

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

Eftersom du uppgraderar från en cartridge 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’ vara inställda på No respektive Yes. Detta kommer att fortsätta skicka händelser utan mättalsetiketten Salesforce Commerce Cloud och använda händelsetypen Add To Cart (i stället för den nya Added to Cart). Om de här två webbplatsinställningarna är felaktigt inställda leder det till att rapporteringen slutar fungera och kan även göra att befintliga flöden i Klaviyo slutar fungera.

Verifiera att alla standardhändelser fungerar

Innan du försöker lägga tillbaka några anpassningar från din tidigare integration ska du se till att verifiera att den nya installationen av Klaviyo-cartridgen fungerar korrekt. Använd frontend för att generera händelser för Searched Site, Viewed Category, Viewed Product, Added To Cart, Started Checkout och Order Confirmation och kontrollera sedan ditt Klaviyo-konto för att se till att dessa händelser spåras korrekt.

Kontrollera utvecklarkonsolen efter nya fel som kan vara relaterade till integrationen på alla sidor som genererar Klaviyo-händelser. Aktivera utförlig tjänstloggning genom att markera kryssrutan Communication Log Enabled under Administration > Operations > Services > KlaviyoEventService - Details och granska sedan loggfilerna på serversidan för att verifiera att det inte finns några fel och att händelsedata genereras korrekt för varje händelsetyp.

Jämför händelsedata med produktion

Du bör nu jämföra händelsedata i dina test- och produktionskonton i Klaviyo för att säkerställa att inget saknas och att aktuella värden matchar den förväntade typen. Det är viktigt att ta reda på om någon rapportering eller några flöden påverkas av den nya integrationen. Du kommer att se att ytterligare egenskaper nu ställs in och skickas till Klaviyo jämfört med den tidigare cartridge-versionen.

Lägg till tillbaka webbplatsspecifika anpassningar

Nu kan du börja lägga tillbaka anpassningar i din Klaviyo-kod. På grund av att det finns omfattande strukturella och arkitektoniska ändringar i den senaste Klaviyo-kassetten är det osannolikt att du bara kan kopiera och klistra in anpassad kod direkt i Klaviyo-kassetten.

Varje händelsetyp i Klaviyo-kassetten har en getData-funktion som finns i en separat skriptfil som är namngiven efter varje händelsetyp. De här filerna finns i mappen int_klaviyo_core/cartridge/scripts/klaviyo/eventData och är den mest sannolika platsen du kommer att ändra på för att lägga till eller uppdatera dataobjekten 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 kontrollanter på serversidan (dvs. direkt i SiteGen eller via server.append i SFRA) som anropar en getData-funktion från en skriptfil som är dedikerad till 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-cartridge för Salesforce Commerce Cloud.

Ytterligare resurser