Local Sync Client

Yleiskatsaus

Sync Client on työpöytäsovellus, jonka avulla SEW OrchestrationSuite -projektit pidetään saatavilla paikallisella tietokoneella tai verkkojaossa. Se toimii taustapalvelun kanssa ja tarjoaa ikkunan projektien valintaan, versioiden synkronointiin, projektien uloskuittaukseen muokkausta varten sekä muutosten sisäänkuittaukseen.

Sovelluksen työnkulku on sama Windowsissa ja Linuxissa. Alustakohtaiset ohjeet annetaan asennukselle ja poistolle; muut kuvakaappaukset esittävät yhteistä käyttöliittymää.

Lataus

Lataa käyttöjärjestelmääsi soveltuva uusin SEW-paketti:

• Windows-asennusohjelma
• Linux AMD64 -paketti

Sync Clientin asennus

Windows

1. Etsi sync-client-windows-setup.exe Downloads-kansiosta, napsauta sitä hiiren kakkospainikkeella ja valitse Run as administrator. Asennuksen suorittaminen järjestelmänvalvojana on pakollista.

   

   

2. Hyväksy Windowsin käyttäjätilien valvonnan kehote ja jatka aloitusnäytöstä.

   

   

3. Valitse asennuskansio. Oletussijaintia suositellaan.

   

4. Pidä vaihtoehdot Install Sync Client, Create desktop shortcut ja Start on login valittuina vakioasennusta varten.

   

5. Odota, kunnes asennusohjelma asentaa sovelluksen ja taustapalvelun.

   

6. Pidä Run Sync Client valittuna ja valitse Finish.

   

Linux

1. Lataa sync-client-linux.tar.bz2 ja pura se:

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

2. Avaa pääte purettuun hakemistoon:

   cd sync-client-linux

3. Suorita asennusohjelma järjestelmänvalvojan oikeuksin:

   sudo ./install.sh

   

4. Varmista, että pääte ilmoittaa Installed Sync Client ja listaa asennetun paketin, CLI:n, työpöytämerkinnän, palvelun ja palvelukäyttäjän. Sync Client avautuu automaattisesti, kun asennus on valmis.

5. Kirjaudu ulos Linux-työpöydältä ja kirjaudu uudelleen sisään ennen Sync Clientin käyttöä. Asennusohjelma lisää työpöytäkäyttäjäsi sync-client-ryhmään, ja uusi ryhmäjäsenyys tulee voimaan uudessa kirjautumisistunnossa.

6. Uudelleenkirjautumisen jälkeen Sync Client voidaan avata sovellusvalikosta tai ilmaisinalueen kuvakkeesta, jos se ei ole jo käynnissä.

Ensimmäisen käyttökerran määritys

Ensimmäisen käyttökerran määritys etenee automaattisesti vaiheiden läpi:

Login → Storage → Filters / Policy

Alla olevat kuvakaappaukset esittävät Windows-version, mutta samat asetukset ja hallintatoiminnot ovat käytettävissä myös Linuxissa.

Kirjautuminen

Anna SEW OrchestrationSuite -sähköpostiosoitteesi ja salasanasi, vahvista API-osoite ja valitse Connect.

Kenttien vieressä olevat kuvakkeet osoittavat, onko yksittäiset arvot vahvistettu. Onnistuneen yhteyden jälkeen Sync Client avaa automaattisesti Storage-vaiheen.

Monivaiheinen todennus

Jos tilille on otettu käyttöön monivaiheinen todennus, syötä kuusinumeroinen tunnusluku todennussovelluksesta ja valitse Confirm.

Tallennuspaikan valinta

Sync Client voi tallentaa synkronoidut projektit paikalliseen kansioon tai SMB-verkkojakoon.

Paikallinen tiedostojärjestelmä

Valitse Local Filesystem, valitse Browse, valitse projektikansio, aseta synkronointiväli ja valitse Save.

Kun asetukset on vahvistettu ja tallennettu, Sync Client jatkaa automaattisesti vaiheeseen Filters / Policy.

SMB-verkkotallennus

Valitse Network Location ja anna:

• UNC Path: verkkojako ja valinnainen alikansio, kuten \\fileserver\engineering
• Domain: Windows-toimialue tai työryhmä, kun sitä tarvitaan
• SMB Username ja SMB Password: tili, jolla on luku- ja kirjoitusoikeudet
• Sync Interval: kuinka usein Sync Client tarkistaa projektipäivitykset

Valitse Save asetusten vahvistamiseksi ja käyttöönottamiseksi. Jos vahvistus epäonnistuu, varmista, että UNC-polku on tavoitettavissa ja että tilillä on luku- ja kirjoitusoikeudet.

Projektien ja versioiden valinta

Valitse kohdassa Filters / Policy, mitkä projektit synkronoidaan ja kuinka monta versiota pidetään saatavilla paikallisesti.

• Rajaa projektiluetteloa valinnoilla IDE, Vendor, Groups ja From Time.
• Hae hierarkkisesta projektipuusta nimen perusteella.
• Laajenna ryhmiä ja valitse kokonaisia ryhmiä tai yksittäisiä projekteja.
• Poista aktiivinen suodatin valitsemalla sen tunnus.

Valitse kohdassa Version policy vaihtoehto Keep all, Last N Versions tai Since date.

Käytä valintaa Delete older versions on next sync, kun valitun käytännön ulkopuoliset versiot tulee poistaa paikallisesta tallennustilasta.

Aikaperusteista käytäntöä varten valitse Since date ja valitse haluttu päivämäärä ja kellonaika.

Valitse Apply ja tarkista vahvistus, joka esittää yhteenvedon aktiivisista suodattimista, valituista projekteista, säilytyssäännöstä ja siitä, poistetaanko vanhemmat paikalliset versiot.

Projektien käsittely

Projektin etsiminen ja synkronointi

Avaa Projects ja etsi projekti haun tai valintojen All tai Groups avulla. Projektin valitseminen näyttää sen saatavilla olevat versiot, aikaleimat, IDE-tiedot, paikalliset polut, commit-viestit ja synkronoinnin tilan.

Ryhmitelty projektipuu helpottaa projektien selaamista niille määritettyjen ryhmien mukaan.

Valitse Sync now pyytääksesi välitöntä synkronointia sen sijaan, että odottaisit määritettyä aikaväliä.

Projektin uloskuittaus ja avaaminen

Valitse projekti ja versio, jolloin käytettävissä olevat projektitoiminnot tulevat näkyviin.

Valitse Checkout. Voit lisätä valinnaisen lukitusviestin ennen vahvistamista.

Sync Client lataa tarvittavat tiedostot ja lukitsee projektin työskentelyäsi varten.

Kun uloskuittaus on valmis, projektinäkymä osoittaa uloskuitatun version ja ottaa käyttöön toiminnot Open project, Checkin ja Discard checkout.

Valitse Open project avataksesi paikallisen uloskuittauksen sillä suunnittelusovelluksella, joka on rekisteröity kyseiselle projektityypille. Vastaavan IDE:n on oltava asennettuna tietokoneelle.

Muutosten sisäänkuittaus tai hylkääminen

Palaa muokkauksen jälkeen Sync Clientiin ja valitse Checkin. Kirjoita muutoksia kuvaava viesti ja vahvista.

Sulje ulkoinen suunnittelu-IDE ennen sisäänkuittausta. Avoin IDE voi jättää projektin lukitustiedostoja uloskuittaukseen ja estää Sync Clientia valmistelemasta sisäänkuittausta.

Sync Client lähettää muuttuneen projektin, lisää uuden version versiohistoriaan ja vapauttaa projektin lukituksen. Jos haluat sen sijaan hylätä paikalliset muutokset, valitse Discard checkout ja vahvista.

Suosikkiprojektit

Lisää tai poista projekti kohteesta Favorites projektin vieressä olevalla tähdellä. Täytetyt tähdet osoittavat suosikkiprojektit ja tarjoavat nopeamman pääsyn projektiluettelosta.

Suosikkimerkinnät näkyvät myös ryhmitellyssä projektipuussa.

Ohje ja diagnostiikka

Käytä toimintoa Export logs luodaksesi diagnostiikkapaketin tukea varten. Vienti sisältää sovellus- ja palvelulokit, mutta se ei paljasta tallennettuja salasanoja.

Avaa About nähdäksesi asennetun sovelluksen version, lisenssitiedot ja kolmansien osapuolten ilmoitukset.

Sync Client voi jatkaa toimintaansa ilmaisinalueella. Avaa sovellus tai lopeta se ilmaisinalueen valikosta.

Komentorivikäyttöliittymä

Asennus tarjoaa myös työkalun sync-cli, joka on yhteydessä samaan taustapalveluun kuin työpöytäsovellus.

Salasanatunnusten määrittäminen

Tilille, joka ei vaadi MFA:ta, CLI voi tallentaa käyttäjätunnuksen, salasanan, API-osoitteen, paikallisen tallennuspolun ja synkronointivälin:

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

Tämä komento tallentaa määrityksen; se ei ole vuorovaikutteinen kirjautuminen eikä se vahvista tunnuksia välittömästi. Todennus tapahtuu, kun synkronointi käynnistyy. Suorita sync-cli --sync-now ja sen jälkeen sync-cli --status käynnistääksesi synkronoinnin ja tarkastellaksesi tulosta.

MFA- ja SSO-kirjautumista ei tueta sync-cli-työkalussa. Jos tili vaatii MFA:n tai SSO:n, suorita kirjautuminen työpöytäsovelluksessa. Parametrin --password välittäminen voi myös jättää salasanan päätteen historiaan ja paljastaa sen tilapäisesti prosessin komentorivillä, joten käytä mahdollisuuksien mukaan työpöytäkirjautumista.

Sync Clientin tarkastelu ja hallinta

Tarkista palvelun ja synkronoinnin tila:

sync-cli --status

Näytä nykyiset ei-salaiset asetukset:

sync-cli --show-settings

Pyydä välitöntä synkronointia:

sync-cli --sync-now

Listaa aktiiviset projektien uloskuittaukset:

sync-cli --show-checkouts

Suorita sync-cli --help nähdäksesi kaikki tuetut projekti- ja tulostusvaihtoehdot. Lisää --json, kun komennon tulostetta käsitellään skriptillä.

Sync Clientin poisto

Windows

Sulje ensin Sync Client ilmaisinalueelta. Avaa sitten Windowsin Apps- tai Programs-näkymä, valitse Sync Client ja suorita poistokehotteet loppuun.

Linux

1. Sulje Sync Client ilmaisinalueen valikosta ennen poisto-ohjelman suorittamista.

2. Avaa pääte purettuun sync-client-linux-hakemistoon.

3. Suorita poisto-ohjelma järjestelmänvalvojan oikeuksin:

   sudo ./uninstall.sh

   

Poisto-ohjelma poistaa sovelluspaketin sijainnista /opt/sync-client. Määritykset, synkronoidut tiedot ja lokit säilyvät sijainneissa /etc/sync-client, /var/lib/sync-client ja /var/log/sync-client, jotta niitä voidaan käyttää uudelleen tai tarkastella myöhemmin.