Lokale Sync Client

Overzicht

Sync Client is een desktopapplicatie waarmee SEW OrchestrationSuite-projecten beschikbaar blijven op een lokale computer of netwerkshare. De applicatie draait met een achtergrondservice en biedt een venster voor het selecteren van projecten, het synchroniseren van versies, het uitchecken van projecten om te bewerken en het inchecken van wijzigingen.

De werkwijze van de applicatie is op Windows en Linux identiek. Voor installatie en verwijdering worden platformspecifieke instructies gegeven; de overige schermafbeeldingen tonen de gedeelde interface.

Download

Download het nieuwste SEW-pakket voor uw besturingssysteem:

• Windows-installatieprogramma
• Linux AMD64-pakket

Sync Client installeren

Windows

1. Zoek sync-client-windows-setup.exe in Downloads, klik er met de rechtermuisknop op en selecteer Als administrator uitvoeren. De installatie als administrator uitvoeren is verplicht.

   

   

2. Bevestig de melding van Windows Gebruikersaccountbeheer en ga verder vanaf het welkomstscherm.

   

   

3. Kies de installatiemap. De standaardlocatie wordt aanbevolen.

   

4. Houd Install Sync Client, Create desktop shortcut en Start on login geselecteerd voor de standaardinstallatie.

   

5. Wacht tot de setup de applicatie en de achtergrondservice heeft geïnstalleerd.

   

6. Houd Run Sync Client geselecteerd en kies Finish.

   

Linux

1. Download sync-client-linux.tar.bz2 en pak het uit:

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

2. Open een terminal in de uitgepakte map:

   cd sync-client-linux

3. Voer het installatieprogramma uit met beheerdersrechten:

   sudo ./install.sh

   

4. Controleer of de terminal Installed Sync Client meldt en de geïnstalleerde bundel, CLI, desktopvermelding, service en serviceaccount weergeeft. Sync Client wordt automatisch geopend zodra de installatie is voltooid.

5. Meld u af bij de Linux-desktop en meld u opnieuw aan voordat u Sync Client gebruikt. Het installatieprogramma voegt uw desktopgebruiker toe aan de groep sync-client; het nieuwe groepslidmaatschap wordt actief in de nieuwe aanmeldsessie.

6. Na het opnieuw aanmelden kan Sync Client worden geopend vanuit de applicatiestarter of vanuit het systeemvakpictogram, als de applicatie nog niet draait.

Eerste configuratie

De eerste configuratie doorloopt automatisch:

Login → Storage → Filters / Policy

De onderstaande schermafbeeldingen tonen de Windows-versie, maar dezelfde instellingen en bedieningselementen zijn beschikbaar op Linux.

Aanmelden

Voer uw e-mailadres en wachtwoord voor SEW OrchestrationSuite in, bevestig de API-URL en selecteer Connect.

De pictogrammen naast de velden geven aan of de afzonderlijke waarden zijn geverifieerd. Na een geslaagde verbinding opent Sync Client automatisch de stap Storage.

Multifactorauthenticatie

Als multifactorauthenticatie is ingeschakeld voor het account, voert u het zescijferige token uit de authenticator-applicatie in en selecteert u Confirm.

Opslag kiezen

Sync Client kan gesynchroniseerde projecten opslaan in een lokale map of op een SMB-netwerkshare.

Lokaal bestandssysteem

Selecteer Local Filesystem, kies Browse, selecteer de projectmap, stel het synchronisatie-interval in en selecteer Save.

Nadat de instellingen zijn geverifieerd en opgeslagen, gaat Sync Client automatisch verder naar Filters / Policy.

SMB-netwerkopslag

Selecteer Network Location en geef het volgende op:

• UNC Path: de netwerkshare en optionele submap, bijvoorbeeld \\fileserver\engineering
• Domain: het Windows-domein of de werkgroep, indien vereist
• SMB Username en SMB Password: een account met lees- en schrijftoegang
• Sync Interval: hoe vaak Sync Client controleert op projectupdates

Selecteer Save om de instellingen te verifiëren en toe te passen. Als de verificatie mislukt, controleert u of het UNC-pad bereikbaar is en of het account lees- en schrijftoegang heeft.

Projecten en versies selecteren

Gebruik Filters / Policy om te kiezen welke projecten moeten worden gesynchroniseerd en hoeveel versies lokaal beschikbaar moeten blijven.

• Gebruik IDE, Vendor, Groups en From Time om de projectlijst te beperken.
• Doorzoek de hiërarchische projectboom op naam.
• Vouw groepen uit en selecteer volledige groepen of afzonderlijke projecten.
• Verwijder een actief filter door de betreffende pill te selecteren.

Kies onder Version policy de optie Keep all, Last N Versions of Since date.

Gebruik Delete older versions on next sync wanneer versies buiten het geselecteerde beleid uit de lokale opslag moeten worden verwijderd.

Kies voor een tijdgebaseerd beleid Since date en selecteer de gewenste datum en tijd.

Selecteer Apply en controleer de bevestiging, die de actieve filters, geselecteerde projecten, bewaarregel en het al dan niet verwijderen van oudere lokale versies samenvat.

Werken met projecten

Een project zoeken en synchroniseren

Open Projects en gebruik de zoekfunctie, All of Groups om een project te vinden. Bij het selecteren van een project worden de beschikbare versies, tijdstempels, IDE-informatie, lokale paden, commit-berichten en synchronisatiestatus weergegeven.

De gegroepeerde projectboom helpt bij het navigeren door projecten op basis van hun toegewezen groepen.

Gebruik Sync now om een onmiddellijke synchronisatie aan te vragen in plaats van te wachten op het geconfigureerde interval.

Een project uitchecken en openen

Selecteer een project en versie om de beschikbare projectacties weer te geven.

Kies Checkout. U kunt vóór de bevestiging een optioneel vergrendelingsbericht toevoegen.

Sync Client downloadt de benodigde bestanden en vergrendelt het project voor uw werk.

Zodra de checkout is voltooid, geeft de projectweergave de uitgecheckte versie aan en worden Open project, Checkin en Discard checkout ingeschakeld.

Kies Open project om de lokale checkout te openen met de engineeringapplicatie die voor dat projecttype is geregistreerd. De betreffende IDE moet op de computer zijn geïnstalleerd.

Wijzigingen inchecken of verwerpen

Keer na het bewerken terug naar Sync Client en kies Checkin. Voer een bericht in waarin de wijzigingen worden beschreven en bevestig.

Sluit de externe engineering-IDE voordat u incheckt. Een geopende IDE kan projectvergrendelingsbestanden in de checkout achterlaten en verhinderen dat Sync Client de check-in voorbereidt.

Sync Client uploadt het gewijzigde project, voegt de nieuwe versie toe aan de versiegeschiedenis en heft de projectvergrendeling op. Om de lokale wijzigingen te verwerpen, kiest u in plaats daarvan Discard checkout en bevestigt u.

Favoriete projecten

Gebruik de ster naast een project om het toe te voegen aan of te verwijderen uit Favorites. Gevulde sterren geven favoriete projecten aan en bieden snellere toegang vanuit de projectlijst.

Favorietmarkeringen blijven ook zichtbaar in de gegroepeerde projectboom.

Help en diagnose

Gebruik Export logs om een diagnosepakket voor support te maken. De export bevat applicatie- en servicelogboeken, maar geen opgeslagen wachtwoorden.

Open About om de geïnstalleerde applicatieversie, licentie-informatie en kennisgevingen van derden te bekijken.

Sync Client kan in het systeemvak blijven draaien. Gebruik het menu in het systeemvak om de applicatie te openen of af te sluiten.

Opdrachtregelinterface

De installatie levert ook sync-cli, die met dezelfde achtergrondservice communiceert als de desktopapplicatie.

Wachtwoordgegevens configureren

Voor een account waarvoor geen MFA vereist is, kan de CLI de gebruikersnaam, het wachtwoord, de API-URL, het lokale opslagpad en het synchronisatie-interval opslaan:

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

Dit commando slaat de configuratie op; het is geen interactieve aanmelding en de inloggegevens worden niet direct geverifieerd. Authenticatie vindt plaats wanneer de synchronisatie start. Voer sync-cli --sync-now uit, gevolgd door sync-cli --status, om de synchronisatie te starten en het resultaat te bekijken.

Aanmelden met MFA en SSO wordt niet ondersteund via sync-cli. Als het account MFA of SSO vereist, voltooit u de aanmelding in de desktopapplicatie. Het meegeven van --password kan het wachtwoord bovendien in de terminalgeschiedenis achterlaten en tijdelijk zichtbaar maken op de opdrachtregel van het proces; gebruik daarom waar mogelijk de aanmelding via de desktopapplicatie.

Sync Client inspecteren en besturen

Controleer de service- en synchronisatiestatus:

sync-cli --status

Geef de huidige niet-geheime instellingen weer:

sync-cli --show-settings

Vraag een onmiddellijke synchronisatie aan:

sync-cli --sync-now

Toon actieve project-checkouts:

sync-cli --show-checkouts

Voer sync-cli --help uit om alle ondersteunde project- en uitvoeropties te bekijken. Voeg --json toe wanneer u de uitvoer van het commando in een script verwerkt.

Sync Client verwijderen

Windows

Sluit Sync Client eerst af via het systeemvak. Open vervolgens Windows Apps of Programma's, selecteer Sync Client en doorloop de verwijderingsmeldingen.

Linux

1. Sluit Sync Client af via het systeemvakmenu voordat u het verwijderprogramma uitvoert.

2. Open een terminal in de uitgepakte map sync-client-linux.

3. Voer het verwijderprogramma uit met beheerdersrechten:

   sudo ./uninstall.sh

   

Het verwijderprogramma verwijdert de applicatiebundel uit /opt/sync-client. Configuratie, gesynchroniseerde gegevens en logboeken blijven behouden in /etc/sync-client, /var/lib/sync-client en /var/log/sync-client, zodat deze later opnieuw kunnen worden gebruikt of geïnspecteerd.