Jak zaktualizować swój wkład Salesforce Commerce Cloud?

Czego się dowiesz

Dowiedz się, jak zaktualizować wkład Klaviyo Salesforce Commerce Cloud. 

Czy używają Państwo wersji kasety starszej niż 23.7.0? Zalecamy natychmiastową aktualizację do wersji 23.7.0 lub nowszej. Starsze wersje kasety wykorzystują interfejsy API Klaviyo v1 i v2, które zostały wycofane i nie działają już zgodnie z oczekiwaniami. Zawsze zalecamy aktualizację do najnowszej wersji (obecnie 25.7.0).

Kilka słów na początek

Wersja 23.7.0 zawiera szereg znaczących ulepszeń, z których część to zmiany architektoniczne dotyczące sposobu wyzwalania zdarzeń. Specjalne uwagi dotyczące aktualizacji z dowolnej wersji poniżej 23.70 do dowolnej wersji powyżej są wyszczególnione poniżej.

Poznaj swoje obecne integracje

Ważne jest, aby zapoznać się z aktualnymi integracjami SFCC i zmianami lub dostosowaniami, które mogły zostać wprowadzone specjalnie dla Twojej witryny. Co najważniejsze, powinieneś rozważyć, czy konkretne dane zdarzeń, które wysyłasz do Klaviyo, zostały zmienione lub rozszerzone i czy dodałeś jakieś niestandardowe zdarzenia.

Zalecamy porównanie twojego kodu, który gromadzi dane zdarzeń, z poprzednią wersją kartridża Klaviyo, dostępną na Githubie Klaviyo. Zakładając, że twoje integracje nie zostały mocno spersonalizowane, znajdziesz swoje aktualne funkcje montażu danych w int_klaviyo_core/cartridge/scripts/utils/Klaviyo/klaviyoUtils .js, a dla Order Confirmation w int_klaviyo_core/cartridge/scripts/utils/Klaviyo/emailUtils .js.

Zanotuj wszelkie dostosowania, aby móc je ponownie zastosować po zainstalowaniu nowej kasety.

Podłącz piaskownicę SFCC do konta testowego Klaviyo

Jeśli nie utworzyłeś jeszcze dodatkowego konta Klaviyo do testowania, oddzielnego od konta powiązanego ze środowiskiem produkcyjnym SFCC, powinieneś to zrobić. Następnie połącz środowisko sandbox SFCC z nowym kontem. Zalecamy wykonanie tego kroku przy użyciu poprzedniej wersji wkładu Klaviyo, abyś mógł sprawdzić, czy zdarzenia są pomyślnie wysyłane i odbierane przez Twoje dodatkowe konto Klaviyo przed przystąpieniem do aktualizacji bazy kodu za pomocą nowego wkładu Klaviyo.

Usuń poprzedni kod wkładu Klaviyo

Jeśli twoje integracje nie były mocno spersonalizowane, będziesz w stanie usunąć większość poprzednich Klaviyo integracji poprzez proste usunięcie dwóch Klaviyo folderów cartridge: int_klaviyo_core i int_klaviyo (dla Site Genesis) lub int_klaviyo_sfra (dla SFRA) z bazy kodu. Będziesz jednak musiał również usunąć wszelki kod specyficzny dla Klaviyo, który mógł zostać dodany do plików szablonów i ewentualnie plików JavaScript.

Dla Site Genesis

Standard Integracje dla Site Genesis będą miały następujący kod dodany do footer_UI.isml:

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

Będą one również miały następujący blok dodany do minicart.isml, cart.isml i wszelkie inne pliki isml typu "cart":

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

Dla SFRA

Standard Integracje dla SFCC będą miały następujący kod dodany do pageFooter.isml:

<isinclude template="klaviyo/klaviyoFooter"/>

Będą one również miały następujący kod dodany do trasy AddProduct w kontrolerze Cart.js:

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

Zarówno w przypadku Site Genesis, jak i SFRA, po usunięciu folderów cartridge i wspomnianego wycinka kodu źródłowego, zaleca się wyszukanie w bazie kodu słowa "Klaviyo.". Upewnij się, że wiesz, co robi każdy kod związany z Klaviyo, który pozostaje w twojej bazie kodu, zanim go usuniesz, ponieważ te bloki mogą reprezentować dostosowania, które trzeba będzie przywrócić po zainstalowaniu nowego wkładu.

Usuń usługi

Poprzednie integracje utworzą KlaviyoTrackService, KlaviyoTrackProfile i KlaviyoTrackCredentials w Administration > Operations > Service. Wszystkie trzy można bezpiecznie usunąć, ponieważ proces integracji nowego wkładu Klaviyo utworzy nowe usługi o różnych nazwach.

Usunięcie starych usług nie jest konieczne, ale zaleca się ich wyczyszczenie, aby uniknąć nieporozumień w przyszłości.

Przejrzyj preferencje witryny

Proces integracji nowego wkładu Klaviyo zachowa niektóre z poprzednich preferencji witryny Klaviyo, a także doda kilka nowych. Sprawdź preferencje swojej witryny w Klaviyo w grupie preferencji na stronie Merchant tools > Site Preferences > Custom Preferences > Klaviyoi sprawdź, czy nie zostały dodane niestandardowe preferencje specjalnie dla Twojej witryny. Jeśli dostosowałeś kartridż, aby dodać własne ustawienia, będziesz chciał je zachować. Dla porównania, oto cztery preferencje witryny, które są wbudowane w poprzednie integracje Klaviyo:

• Klaviyo włącz (ID: klaviyo_enabled)
  Flaga, jeśli Klaviyo jest włączony lub wyłączony.
• Klaviyo konto (ID: klaviyo_account)
  Twój Klaviyo publiczny klucz API lub identyfikator witryny.
• Klaviyo Prywatny klucz API (ID: klaviyo_api_key)
  Prywatne API klucz Klaviyo.
• Typ obrazu dla Klaviyo (ID: klaviyo_image_size)
  Duży, mały, miniatura itp.

Przed skonfigurowaniem nowego wkładu zalecamy utworzenie kopii zapasowej bieżących preferencji witryny poprzez wyeksportowanie ich na stronie Administracja > Rozwój witryny > Importowanie witryny Importuj & Eksportuj. Rozwiń opcję Witryny, a następnie nazwę witryny i zaznacz pole Preferencje witryny przed wprowadzeniem nazwy pliku, do którego mają zostać wyeksportowane. Obecne preferencje Klaviyo nie powinny mieć negatywnego wpływu na późniejszą instalację nowej kasety, ale dobrym pomysłem jest przywrócenie ich na przyszłość.

Wyjmij wkłady Klaviyo ze ścieżki wkładu

Usuń int_klaviyo_core i int_klaviyo (Site Genesis) lub int_klaviyo_sfra (SFRA) ze ścieżki wkładów w Administracja > Witryny > Zarządzaj witrynami > [Nazwa witryny] > Ustawienia. Jeśli nie wykonasz tego kroku, pojawią się błędy wynikające z tego, że SFCC szuka wkładów do załadowania, które już nie istnieją.

Sprawdź konsolę programisty i dziennik po stronie serwera pod kątem błędów

W tym momencie nie powinieneś już mieć żadnego kodu Klaviyo w swojej bazie kodu. Zalecamy przejrzenie Twojego frontendu, odwiedzenie stron takich jak Wyniki wyszukiwania, PLP i PDP oraz wykonanie czynności takich jak dodanie produktów do koszyka, wejście i ukończenie strony płatności kasa. Gdy to zrobisz, obserwuj Konsolę programisty, aby sprawdzić, czy generowane są nowe błędy. Zrób to samo z dziennikiem zgłoszeń. Jeśli widzisz nowe błędy związane z Klaviyo, istnieje duża szansa, że nie usunąłeś w pełni całego poprzedniego kodu Klaviyo. Ważne jest, aby wyśledzić źródło wszelkich nowych błędów i odnotować je przed usunięciem.

Zainstaluj nowy wkład Klaviyo

Postępuj zgodnie z krokami opisanymi w Pierwsze kroki z Salesforce Commerce Cloud, aby zintegrować nowy wkład z bazą kodu. Mogą istnieć kroki, których nie musisz wykonywać - na przykład twoja instancja SFCC może, ale nie musi, mieć już ustanowione połączenia dla części OCAPI - ale ogólnie rzecz biorąc, powinieneś postępować zgodnie z każdym krokiem integracji. Z pewnością będziesz musiał wymienić oba wkłady Klaviyo i dodać powrót wycinka kodu źródłowego. 

Pamiętaj, że po zaimportowaniu metadata.zip, Będziesz mieć cztery nowe preferencje witryny, oprócz czterech, które zostały utworzone przez poprzednią wersję wkładu. Importowanie nowych preferencji nie powinno mieć wpływu na twoje poprzednie preferencje, ale zaleca się, aby przed kontynuowaniem upewnić się, że wszystkie preferencje witryny Klaviyo są prawidłowe.

Ponieważ dokonujesz aktualizacji z wersji wcześniejszej niż 23.7.0, nowe preferencje witryny Oznacz zdarzenia jako SFCC i Wyślij zdarzenie dodane do koszyka jako "Dodaj do koszyka" powinny być ustawione odpowiednio na Nie i Tak. Spowoduje to dalsze wysyłanie zdarzeń bez etykiety Salesforce Commerce Cloud metryka i używać typu zdarzenia Add To Cart (w przeciwieństwie do nowego Added to Cart). Nieprawidłowe ustawienie tych dwóch preferencji witryny spowoduje uszkodzenie raportowania i potencjalnie uszkodzenie istniejącej sekwencji w Klaviyo.

Sprawdź, czy wszystkie gotowe zdarzenia działają.

Przed próbą dodania powrotu do jakichkolwiek dostosowań z poprzedniej integracji, upewnij się, że nowa instalacja kasety Klaviyo działa poprawnie. Użyj frontendu, aby wygenerować zdarzenia dla wyszukiwanej witryny, przeglądanej kategorii, przeglądanego produktu, dodanego do koszyka, rozpoczętej strony płatności kasa i potwierdzenia zamówienia, a następnie sprawdź swoje konto Klaviyo, aby upewnić się, że zdarzenia te są prawidłowo śledzone. 

Sprawdź konsolę programisty pod kątem nowych błędów, które mogą być związane z integracjami na wszystkich stronach generujących zdarzenia Klaviyo. Włącz rejestrowanie usługi, zaznaczając pole wyboru Dziennik komunikacji włączając w Administracja > Operacje > Usługi > KlaviyoEventService - Szczegóły, a następnie przejrzyj pliki dziennika po stronie serwera, aby sprawdzić, czy nie ma błędów i czy dane zdarzeń są prawidłowo generowane dla każdego typu zdarzenia.

Porównaj dane zdarzeń z danymi produkcyjnymi

Powinieneś teraz porównać dane zdarzeń na testowym i produkcyjnym koncie Klaviyo, aby upewnić się, że niczego nie brakuje, a bieżące wartości są zgodne z oczekiwanym typem. Ważne jest, aby określić, czy nowe integracje będą miały wpływ na raportowanie lub sekwencję. Przekonasz się, że dodatkowe właściwości są teraz ustawiane i wysyłane do Klaviyo w porównaniu do poprzedniej wersji kartridża. 

Dodaj powrót dostosowań specyficznych dla witryny

Możesz teraz rozpocząć dodawanie dostosowań do kodu Klaviyo. Ze względu na poważne zmiany strukturalne i architektoniczne w najnowszym kartridżu Klaviyo, jest mało prawdopodobne, że będziesz w stanie po prostu skopiować i wkleić niestandardowy kod bezpośrednio do kartridża Klaviyo.

Każdy typ zdarzenia we wkładzie Klaviyo ma funkcję getData, która znajduje się w oddzielnym pliku skryptu o nazwie dla każdego typu zdarzenia. Pliki te można znaleźć w folderze int_klaviyo_core/cartridge/scripts/Klaviyo /eventData i są najbardziej prawdopodobnym miejscem, które zmienisz w celu dodania lub aktualizacji obiektów danych, które są przekazywane dla każdego zdarzenia. Jeśli tworzysz nowe zdarzenia niestandardowe, zalecamy postępowanie zgodnie z ustalonym schematem dodawania kodu do kontrolerów po stronie serwera (tj. bezpośrednio w SiteGen lub poprzez server.append w SFRA), który wywołuje funkcję getData z pliku skryptu dedykowanego nowemu zdarzeniu, a następnie używa funkcji trackEvent do wysyłania tych danych do Klaviyo za pośrednictwem usługi KlaviyoEventService.

Rezultat

Teraz zaktualizowałeś swój wkład Klaviyo dla Salesforce Commerce Cloud. 

Dodatkowe źródła 

• Pierwsze kroki z Salesforce Commerce Cloud
• Salesforce Commerce Cloud dane referencyjne
• Jak często integracje synchronizują odniesienie
• Kontaktowanie się z działem pomocy