Jak skonfigurować dodatek Comarch Liquid Sync?

Spis treści

- Praca z plikami
Rozwiązywanie konfliktów
- - Jak zmodyfikować plik w panelu administracyjnym e-Sklep?
- Jak zmodyfikować plik lokalny, kiedy aplikacja Comarch Liquid Sync była wyłączona?

Jak działa Comarch Liquid Sync?

Liquid Sync synchronizuje pliki umieszczone na komputerze użytkownika z plikami szablonu Liquid. Pilnuje zgodności danych wykrywając modyfikacje w plikach lokalnych lub w plikach szablonu Liquid, a następnie podmienia nieaktualny plik na jego nowszą wersje.

Dzięki aplikacji Liquid Sync nie trzeba używać edytorów kodu dostępnych w panelu administracyjnym e-Sklep. Każdy użytkownik może korzystać z dowolnego środowiska programistycznego, a Liquid Sync zadba o zgodność utworzonego lokalnie projektu z plikami w panelu administracyjnym.

Jak uruchomić Comarch Liquid Sync?

Aplikacja dostępna dla sklepów Comarch.

Liquid Sync można pobrać ze strony Liquid Sync.

Rozpakowany folder będzie zawierać między innymi:

Katalog pl – zawiera XML z ustawieniami. Nie należy go usuwać.
Katalog logs – zawiera logi operacji.
COMARCHeShopLiquidSync – aplikacja Liquid Sync.

Aplikację należy uruchomić z prawami administratora. Po uruchomieniu zostaną otwarte dwa okna: okno konsolowe oraz okno przeglądarki z interfejsem aplikacji. Obydwa okna powinny pozostać włączone.

Jak skonfigurować Comarch Liquid Sync?

Liquid Sync potrzebuje danych logowania do sklepu. Przy pierwszym uruchomieniu widoczny będzie formularz, w którym należy wpisać:

Nazwę sklepu – dowolna nazwa, po której będzie można rozpoznać sklep na liście sklepów
Url – adres url istniejącego sklepu
Login – login użytkownika, na którego aplikacja ma się zalogować do panelu e-Sklepu. Należy wykorzystać login webmaster, którego konfiguracja dostępna jest w panelu administracyjnym**.
Hasło – hasło wskazanego użytkownika

Wskazówka

Comarch e-Sklep Liquid Sync do połączenia wymaga SSL

konfiguracja liquid sync

Wskazówka

**Zaloguj się do panelu administracyjnego e-Sklepu przejdź do zakładki Integracje > Dodaj integrację. Na filtrze Typ wybierz Dodatki. Następnie wybierz dodatek Comarch Liquid Sync, naciśnij Dodaj, a w kolejnym kroku Konfiguruj.

Po kliknięciu Zaloguj się sklep zostanie dodany do listy po lewej stronie. W prawym oknie pojawi się lista dostępnych szablonów.

Szablony w sklepie połączonym z Liquid Sync
Od teraz będzie to ekran startowy aplikacji. Aby dodać kolejny sklep trzeba będzie nacisnąć przycisk Dodaj sklep.

Po zalogowaniu w rozpakowanym katalogu COMARCHeShopLiquidSync zostanie utworzony katalog o podanej w formularzu nazwie.

Lokalny katalog sklepu utworzony przez LiquidSync
Katalog będzie zawierał:

Katalog logs – zawiera logi operacji danego e-Sklepu
Katalog sync – zawiera plik z ustawieniami
Katalog templates – w tym miejscu będą tworzyć się podkatalogi z plikami dla dostępnych szablonów

Katalogi z plikami szablonu nie mogą zostać przeniesione.

Synchronizacja

Praca z plikami

Aby wybrać, który z szablonów aplikacja powinna synchronizować, wystarczy wybrać odpowiednią pozycję na liście dostępnych szablonów. Jeżeli synchronizacja dotyczy szablonu, który jest zabezpieczony hasłem, Liquid Sync również będzie potrzebował hasła.

Hasło szablonu w Liquid Sync
Po wybraniu szablonu otworzy się okno synchronizacji. Lewa kolumna o nazwie Log będzie zawierać logi synchronizacji, natomiast prawa o nazwie Pliki będzie informować o konfliktach do rozwiązania.

Szynchronizacja szablonu za pomocą Liquid Sync
Przy pierwszej synchronizacji szablonu, wewnątrz katalogu templates, zostanie utworzony odpowiadający mu katalog. Nazwami katalogów są id szablonów.
Folder lokalny szablonu w aplikacji Liquid Sync
Jeżeli w panelu administracyjnym e-Sklep nie zostały wcześniej dodane żadne pliki dla danego szablonu, to wewnątrz powyższego folderu należy samodzielnie utworzyć katalog o nazwie 0 (zero). W katalogu 0 należy umieszczać wszystkie pliki wymagające synchronizacji. Jeżeli szablon zawierał już jakiekolwiek pliki, katalog utworzy się automatycznie, a wewnątrz niego znajdować się będą pliki pobrane z panelu. Każdy nowy plik umieszczony w katalogu 0 automatycznie pojawi się w plikach szablonu Liquid w panelu administracyjnym e-Sklep.

Plik lokalny synchronizowany z szablonem Liquid
pliki liquid sync Aplikacja Liquid Sync wyświetli również odpowiedni log.

Log nowego pliku w Liquid Sync
Plik lokalny zostanie również wysłany do sklepu po każdym zapisie, a jego usunięcie spowoduje usunięcie odpowiadającego pliku z szablonu Liquid.

Rozwiązywanie konfliktów

Zdarza się, że pliki lokalne nie są zgodne z plikami szablonu Liquid. W takiej sytuacji, w kolumnie Pliki, Liquid Sync wyświetli odpowiedni komunikat. Komunikat zapyta użytkownika, w jaki sposób aplikacja powinna rozwiązać konflikt. Poniżej opisane zostaną przyczyny konfliktów oraz sposoby ich rozwiązania.

Jak zmodyfikować plik w panelu administracyjnym e-Sklep?

Modyfikacja plików po stronie panelu administracyjnego, w przeciwieństwie do modyfikacji plików lokalnych, jest traktowana jako konflikt. Komunikat konfliktu, w przypadku modyfikacji istniejących plików, będzie proponował dwa rozwiązania: pobrać plik szablonu do projektu lokalnego lub wysłać lokalny plik do panelu administracyjnego.

Konflikt: Pliki nie są zgodne
Jeżeli zmiana zostanie wykonana w podczas aktywnej synchronizacji, należy kliknąć przycisk Odśwież, aby zobaczyć komunikat.

Usunięcie pliku po stronie panelu administracyjnego będzie wymagało podjęcia decyzji: usunąć plik z lokalnego systemu plików, czy wysłać istniejący lokalnie plik do panelu administracyjnego e-Sklep.
Konflikt: Brak pliku na zdalnym systemie
Dodanie nowego pliku w panelu administracyjnym również wyświetli stosowny komunikat. Liquid Sync zaproponuje wtedy pobranie nowego pliku z panelu do projektu lokalnego lub usunięcie nowego pliku z szablonu Liquid.

Konflikt: Brak pliku na lokalnym systemie

Jak zmodyfikować plik lokalny, kiedy aplikacja Comarch Liquid Sync była wyłączona?

Liquid Sync nie miał okazji zaktualizować pliku lokalnego po jego modyfikacji, więc wystąpiła niezgodność. W przypadku istniejących plików aplikacja wyświetli komunikat z rozwiązaniami: pobrać plik szablonu do projektu lokalnego lub wysłać plik lokalny do sklepu.

Konflikt: Pliki nie są zgodne
Jeżeli plik lokalny zostanie usunięty, komunikat będzie zawierał opcję pobrania odpowiadającego pliku ze sklepu lub jego usunięcie.

Konflikt: Brak pliku na lokalnym systemie
Gdy nowy plik zostanie dodany, rozwiązać konflikt można poprzez wysłanie nowego pliku do sklepu lub usunięcie go.