Lokalny Sync Client

Przegląd

Sync Client to aplikacja desktopowa służąca do utrzymywania projektów SEW OrchestrationSuite dostępnych na komputerze lokalnym lub w zasobie sieciowym. Działa z usługą działającą w tle i udostępnia okno umożliwiające wybór projektów, synchronizację wersji, pobieranie projektów do edycji oraz zwracanie zmian.

Sposób pracy z aplikacją jest taki sam w systemach Windows i Linux. Instrukcje zależne od platformy dotyczą instalacji i usuwania; pozostałe zrzuty ekranu przedstawiają wspólny interfejs.

Pobieranie

Pobierz najnowszy pakiet SEW dla swojego systemu operacyjnego:

• Instalator dla systemu Windows
• Pakiet Linux AMD64

Instalacja Sync Client

Windows

1. Znajdź plik sync-client-windows-setup.exe w folderze Pobrane, kliknij go prawym przyciskiem myszy i wybierz Uruchom jako administrator. Uruchomienie instalacji z uprawnieniami administratora jest obowiązkowe.

   

   

2. Zatwierdź monit Kontroli konta użytkownika systemu Windows i kontynuuj z ekranu powitalnego.

   

   

3. Wybierz folder instalacji. Zalecana jest lokalizacja domyślna.

   

4. W przypadku instalacji standardowej pozostaw zaznaczone opcje Install Sync Client, Create desktop shortcut oraz Start on login.

   

5. Poczekaj, aż instalator zainstaluje aplikację i usługę działającą w tle.

   

6. Pozostaw zaznaczoną opcję Run Sync Client i wybierz Finish.

   

Linux

1. Pobierz plik sync-client-linux.tar.bz2 i rozpakuj go:

   tar -xjvf sync-client-linux.tar.bz2

2. Otwórz terminal w rozpakowanym katalogu:

   cd sync-client-linux

3. Uruchom instalator z uprawnieniami administratora:

   sudo ./install.sh

   

4. Sprawdź, czy terminal zgłasza komunikat Installed Sync Client oraz wyświetla listę zainstalowanego pakietu, CLI, wpisu w menu aplikacji, usługi i użytkownika usługi. Po zakończeniu instalacji Sync Client uruchamia się automatycznie.

5. Wyloguj się ze środowiska graficznego Linux i zaloguj ponownie przed użyciem Sync Client. Instalator dodaje Twojego użytkownika do grupy sync-client, a nowe członkostwo w grupie staje się aktywne w nowej sesji logowania.

6. Po ponownym zalogowaniu Sync Client można uruchomić z menu aplikacji lub z ikony w zasobniku systemowym, jeśli nie jest jeszcze uruchomiony.

Konfiguracja początkowa

Konfiguracja początkowa przebiega automatycznie przez etapy:

Login → Storage → Filters / Policy

Poniższe zrzuty ekranu przedstawiają wersję dla systemu Windows, ale te same ustawienia i elementy sterujące są dostępne w systemie Linux.

Logowanie

Wprowadź swój adres e-mail i hasło do SEW OrchestrationSuite, potwierdź adres API URL i wybierz Connect.

Ikony obok pól wskazują, czy poszczególne wartości zostały zweryfikowane. Po pomyślnym połączeniu Sync Client automatycznie otwiera krok Storage.

Uwierzytelnianie wieloskładnikowe

Jeśli dla konta włączono uwierzytelnianie wieloskładnikowe, wprowadź sześciocyfrowy token z aplikacji uwierzytelniającej i wybierz Confirm.

Wybór miejsca przechowywania

Sync Client może przechowywać zsynchronizowane projekty w folderze lokalnym lub w zasobie sieciowym SMB.

Lokalny system plików

Wybierz Local Filesystem, następnie Browse, wskaż folder projektów, ustaw interwał synchronizacji i wybierz Save.

Po zweryfikowaniu i zapisaniu ustawień Sync Client automatycznie przechodzi do kroku Filters / Policy.

Magazyn sieciowy SMB

Wybierz Network Location i podaj:

• UNC Path: zasób sieciowy i opcjonalny podfolder, na przykład \\fileserver\engineering
• Domain: domena Windows lub grupa robocza, jeśli jest wymagana
• SMB Username i SMB Password: konto z prawami odczytu i zapisu
• Sync Interval: częstotliwość sprawdzania przez Sync Client aktualizacji projektów

Wybierz Save, aby zweryfikować i zastosować ustawienia. Jeśli weryfikacja się nie powiedzie, sprawdź, czy ścieżka UNC jest osiągalna i czy konto ma prawa odczytu i zapisu.

Wybór projektów i wersji

Użyj sekcji Filters / Policy, aby wybrać, które projekty mają być synchronizowane i ile wersji ma pozostawać dostępnych lokalnie.

• Użyj filtrów IDE, Vendor, Groups i From Time, aby zawęzić listę projektów.
• Przeszukuj hierarchiczne drzewo projektów według nazwy.
• Rozwijaj grupy i wybieraj całe grupy lub pojedyncze projekty.
• Usuń aktywny filtr, wybierając jego etykietę.

W sekcji Version policy wybierz Keep all, Last N Versions lub Since date.

Użyj opcji Delete older versions on next sync, jeśli wersje spoza wybranej zasady mają zostać usunięte z lokalnego magazynu.

W przypadku zasady opartej na czasie wybierz Since date i wskaż wymaganą datę oraz godzinę.

Wybierz Apply i sprawdź potwierdzenie, które podsumowuje aktywne filtry, wybrane projekty, regułę przechowywania oraz informację o tym, czy starsze wersje lokalne zostaną usunięte.

Praca z projektami

Wyszukiwanie i synchronizacja projektu

Otwórz Projects i użyj wyszukiwania, zakładki All lub Groups, aby znaleźć projekt. Wybranie projektu powoduje wyświetlenie jego dostępnych wersji, znaczników czasu, informacji o IDE, ścieżek lokalnych, komunikatów commit oraz stanu synchronizacji.

Pogrupowane drzewo projektów ułatwia nawigację według przypisanych grup.

Użyj opcji Sync now, aby zażądać natychmiastowej synchronizacji zamiast czekać na skonfigurowany interwał.

Pobieranie i otwieranie projektu

Wybierz projekt i wersję, aby wyświetlić dostępne akcje projektu.

Wybierz Checkout. Przed potwierdzeniem możesz dodać opcjonalny komunikat blokady.

Sync Client pobiera wymagane pliki i blokuje projekt na czas Twojej pracy.

Po zakończeniu pobierania widok projektu wskazuje pobraną wersję i udostępnia opcje Open project, Checkin oraz Discard checkout.

Wybierz Open project, aby otworzyć lokalną kopię w aplikacji inżynierskiej zarejestrowanej dla danego typu projektu. Odpowiednie IDE musi być zainstalowane na komputerze.

Zwracanie lub odrzucanie zmian

Po zakończeniu edycji wróć do Sync Client i wybierz Checkin. Wprowadź komunikat opisujący zmiany i potwierdź.

Przed zwróceniem zmian zamknij zewnętrzne inżynierskie IDE. Otwarte IDE może pozostawić pliki blokady projektu w kopii lokalnej i uniemożliwić Sync Client przygotowanie zwrotu zmian.

Sync Client przesyła zmieniony projekt, dodaje nową wersję do historii wersji i zwalnia blokadę projektu. Aby zamiast tego odrzucić zmiany lokalne, wybierz Discard checkout i potwierdź.

Ulubione projekty

Użyj gwiazdki obok projektu, aby dodać go do Favorites lub usunąć z tej listy. Wypełnione gwiazdki oznaczają ulubione projekty i zapewniają szybszy dostęp z listy projektów.

Oznaczenia ulubionych pozostają widoczne również w pogrupowanym drzewie projektów.

Pomoc i diagnostyka

Użyj opcji Export logs, aby utworzyć pakiet diagnostyczny dla działu wsparcia. Eksport zawiera logi aplikacji i usługi, ale nie ujawnia zapisanych haseł.

Otwórz About, aby wyświetlić zainstalowaną wersję aplikacji, informacje licencyjne oraz noty dotyczące oprogramowania firm trzecich.

Sync Client może działać dalej w zasobniku systemowym. Użyj menu zasobnika, aby otworzyć aplikację lub ją zamknąć.

Interfejs wiersza poleceń

Instalacja udostępnia również narzędzie sync-cli, które komunikuje się z tą samą usługą działającą w tle co aplikacja desktopowa.

Konfiguracja poświadczeń z hasłem

W przypadku konta, które nie wymaga MFA, CLI może zapisać nazwę użytkownika, hasło, adres API URL, lokalną ścieżkę magazynu oraz interwał synchronizacji:

sync-cli --username "user@example.com" --password "<password>" --api-url "https://<sew-api-url>" --local-path "<project-folder>" --sync-frequency 30

To polecenie zapisuje konfigurację; nie jest to interaktywne logowanie i nie weryfikuje poświadczeń natychmiast. Uwierzytelnianie następuje w momencie rozpoczęcia synchronizacji. Uruchom sync-cli --sync-now, a następnie sync-cli --status, aby rozpocząć synchronizację i sprawdzić wynik.

Logowanie z MFA i SSO nie jest obsługiwane przez sync-cli. Jeśli konto wymaga MFA lub SSO, wykonaj logowanie w aplikacji desktopowej. Przekazanie parametru --password może również pozostawić hasło w historii terminala i tymczasowo ujawnić je w wierszu poleceń procesu, dlatego w miarę możliwości korzystaj z logowania w aplikacji desktopowej.

Kontrola i sprawdzanie stanu Sync Client

Sprawdź stan usługi i synchronizacji:

sync-cli --status

Wyświetl bieżące ustawienia niebędące danymi poufnymi:

sync-cli --show-settings

Zażądaj natychmiastowej synchronizacji:

sync-cli --sync-now

Wyświetl listę aktywnych pobrań projektów:

sync-cli --show-checkouts

Uruchom sync-cli --help, aby zobaczyć wszystkie obsługiwane opcje projektów i formatu wyjścia. Dodaj --json, gdy wynik polecenia ma być przetwarzany przez skrypt.

Odinstalowanie Sync Client

Windows

Najpierw zamknij Sync Client z poziomu zasobnika systemowego. Następnie otwórz Aplikacje lub Programy w systemie Windows, wybierz Sync Client i wykonaj kroki dezinstalacji.

Linux

1. Przed uruchomieniem dezinstalatora zamknij Sync Client z menu zasobnika systemowego.

2. Otwórz terminal w rozpakowanym katalogu sync-client-linux.

3. Uruchom dezinstalator z uprawnieniami administratora:

   sudo ./uninstall.sh

   

Dezinstalator usuwa pakiet aplikacji z katalogu /opt/sync-client. Konfiguracja, zsynchronizowane dane i logi pozostają w katalogach /etc/sync-client, /var/lib/sync-client oraz /var/log/sync-client, aby można było je później ponownie wykorzystać lub przeanalizować.