Sync Client locale

Panoramica

Sync Client è un'applicazione desktop che consente di mantenere disponibili i progetti SEW OrchestrationSuite su un computer locale o su una condivisione di rete. Viene eseguita tramite un servizio in background e mette a disposizione una finestra per selezionare i progetti, sincronizzare le versioni, effettuare il check-out dei progetti per la modifica e il check-in delle modifiche.

Il flusso di lavoro dell'applicazione è identico su Windows e Linux. Le istruzioni specifiche per piattaforma riguardano l'installazione e la rimozione; le restanti schermate mostrano l'interfaccia comune.

Download

Scaricare il pacchetto SEW più recente per il proprio sistema operativo:

• Programma di installazione per Windows
• Pacchetto Linux AMD64

Installazione di Sync Client

Windows

1. Individuare sync-client-windows-setup.exe in Download, fare clic con il pulsante destro del mouse e selezionare Esegui come amministratore. L'esecuzione dell'installazione come amministratore è obbligatoria.

   

   

2. Approvare la richiesta di Controllo account utente di Windows e proseguire dalla schermata di benvenuto.

   

   

3. Scegliere la cartella di installazione. Si consiglia di mantenere il percorso predefinito.

   

4. Per l'installazione standard mantenere selezionate le opzioni Install Sync Client, Create desktop shortcut e Start on login.

   

5. Attendere che il programma di installazione installi l'applicazione e il servizio in background.

   

6. Mantenere selezionata l'opzione Run Sync Client e scegliere Finish.

   

Linux

1. Scaricare sync-client-linux.tar.bz2 ed estrarlo:

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

2. Aprire un terminale nella directory estratta:

   cd sync-client-linux

3. Eseguire il programma di installazione con privilegi di amministratore:

   sudo ./install.sh

   

4. Verificare che il terminale riporti Installed Sync Client ed elenchi il bundle installato, la CLI, la voce desktop, il servizio e l'utente del servizio. Al termine dell'installazione, Sync Client si apre automaticamente.

5. Disconnettersi dal desktop Linux ed effettuare nuovamente l'accesso prima di utilizzare Sync Client. Il programma di installazione aggiunge l'utente desktop al gruppo sync-client e la nuova appartenenza al gruppo diventa attiva nella nuova sessione di accesso.

6. Dopo aver effettuato nuovamente l'accesso, Sync Client può essere aperto dal launcher delle applicazioni oppure dalla relativa icona nell'area di notifica, se non è già in esecuzione.

Configurazione iniziale

La configurazione iniziale procede automaticamente attraverso:

Login → Storage → Filters / Policy

Le schermate seguenti mostrano la versione per Windows, ma le stesse impostazioni e gli stessi comandi sono disponibili anche su Linux.

Accesso

Inserire l'indirizzo e-mail e la password di SEW OrchestrationSuite, confermare l'URL dell'API e selezionare Connect.

Le icone accanto ai campi indicano se i singoli valori sono stati verificati. Dopo una connessione riuscita, Sync Client apre automaticamente il passaggio Storage.

Autenticazione a più fattori

Se per l'account è abilitata l'autenticazione a più fattori, inserire il token a sei cifre generato dall'applicazione di autenticazione e selezionare Confirm.

Scelta dell'archiviazione

Sync Client può archiviare i progetti sincronizzati in una cartella locale oppure su una condivisione di rete SMB.

Filesystem locale

Selezionare Local Filesystem, scegliere Browse, selezionare la cartella dei progetti, impostare l'intervallo di sincronizzazione e selezionare Save.

Dopo la verifica e il salvataggio delle impostazioni, Sync Client prosegue automaticamente al passaggio Filters / Policy.

Archiviazione di rete SMB

Selezionare Network Location e indicare:

• UNC Path: la condivisione di rete e l'eventuale sottocartella, ad esempio \\fileserver\engineering
• Domain: il dominio Windows o il gruppo di lavoro, se richiesto
• SMB Username e SMB Password: un account con accesso in lettura e scrittura
• Sync Interval: la frequenza con cui Sync Client verifica la presenza di aggiornamenti dei progetti

Selezionare Save per verificare e applicare le impostazioni. Se la verifica non riesce, controllare che il percorso UNC sia raggiungibile e che l'account disponga dell'accesso in lettura e scrittura.

Selezione di progetti e versioni

Utilizzare Filters / Policy per scegliere quali progetti sincronizzare e quante versioni mantenere disponibili localmente.

• Utilizzare IDE, Vendor, Groups e From Time per restringere l'elenco dei progetti.
• Cercare per nome nell'albero gerarchico dei progetti.
• Espandere i gruppi e selezionare interi gruppi o singoli progetti.
• Rimuovere un filtro attivo selezionando il relativo pill.

In Version policy, scegliere Keep all, Last N Versions oppure Since date.

Utilizzare Delete older versions on next sync quando le versioni non incluse nel criterio selezionato devono essere rimosse dall'archiviazione locale.

Per un criterio basato sul tempo, scegliere Since date e selezionare la data e l'ora richieste.

Selezionare Apply ed esaminare la conferma, che riepiloga i filtri attivi, i progetti selezionati, la regola di conservazione e l'eventuale eliminazione delle versioni locali precedenti.

Lavorare con i progetti

Trovare e sincronizzare un progetto

Aprire Projects e utilizzare la ricerca, All oppure Groups per trovare un progetto. Selezionando un progetto vengono visualizzate le versioni disponibili, i timestamp, le informazioni sull'IDE, i percorsi locali, i messaggi di commit e lo stato di sincronizzazione.

L'albero dei progetti raggruppato facilita la navigazione dei progetti in base ai gruppi assegnati.

Utilizzare Sync now per richiedere una sincronizzazione immediata senza attendere l'intervallo configurato.

Check-out e apertura di un progetto

Selezionare un progetto e una versione per visualizzare le azioni disponibili per il progetto.

Scegliere Checkout. Prima di confermare è possibile aggiungere un messaggio di blocco facoltativo.

Sync Client scarica i file necessari e blocca il progetto per il proprio lavoro.

Al termine del check-out, la vista del progetto indica la versione sottoposta a check-out e abilita Open project, Checkin e Discard checkout.

Scegliere Open project per aprire il check-out locale con l'applicazione di progettazione registrata per quel tipo di progetto. L'IDE corrispondente deve essere installato sul computer.

Check-in o annullamento delle modifiche

Al termine delle modifiche, tornare a Sync Client e scegliere Checkin. Inserire un messaggio che descriva le modifiche e confermare.

Prima di eseguire il check-in, chiudere l'IDE di progettazione esterno. Un IDE aperto può lasciare file di blocco del progetto nel check-out e impedire a Sync Client di preparare il check-in.

Sync Client carica il progetto modificato, aggiunge la nuova versione alla cronologia delle versioni e rilascia il blocco del progetto. Per annullare invece le modifiche locali, scegliere Discard checkout e confermare.

Progetti preferiti

Utilizzare la stella accanto a un progetto per aggiungerlo o rimuoverlo dai Favorites. Le stelle piene identificano i progetti preferiti e consentono un accesso più rapido dall'elenco dei progetti.

I contrassegni dei preferiti rimangono visibili anche nell'albero dei progetti raggruppato.

Guida e diagnostica

Utilizzare Export logs per creare un pacchetto diagnostico destinato al supporto. L'esportazione include i log dell'applicazione e del servizio, ma non espone le password salvate.

Aprire About per visualizzare la versione dell'applicazione installata, le informazioni sulla licenza e le note relative a terze parti.

Sync Client può continuare a essere eseguito nell'area di notifica. Utilizzare il menu dell'area di notifica per aprire l'applicazione o uscire.

Interfaccia a riga di comando

L'installazione fornisce anche sync-cli, che comunica con lo stesso servizio in background dell'applicazione desktop.

Configurare le credenziali con password

Per un account che non richiede MFA, la CLI può salvare il nome utente, la password, l'URL dell'API, il percorso di archiviazione locale e l'intervallo di sincronizzazione:

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

Questo comando salva la configurazione; non si tratta di un accesso interattivo e non verifica immediatamente le credenziali. L'autenticazione avviene all'avvio della sincronizzazione. Eseguire sync-cli --sync-now, seguito da sync-cli --status, per avviare la sincronizzazione ed esaminarne il risultato.

L'accesso con MFA e SSO non è supportato tramite sync-cli. Se l'account richiede MFA o SSO, completare l'accesso nell'applicazione desktop. L'utilizzo di --password può inoltre lasciare la password nella cronologia del terminale ed esporla temporaneamente nella riga di comando del processo: quando possibile, utilizzare pertanto l'accesso dall'applicazione desktop.

Esaminare e controllare Sync Client

Verificare lo stato del servizio e della sincronizzazione:

sync-cli --status

Visualizzare le impostazioni non riservate correnti:

sync-cli --show-settings

Richiedere una sincronizzazione immediata:

sync-cli --sync-now

Elencare i check-out di progetto attivi:

sync-cli --show-checkouts

Eseguire sync-cli --help per visualizzare tutte le opzioni di progetto e di output supportate. Aggiungere --json quando l'output del comando viene elaborato da uno script.

Disinstallazione di Sync Client

Windows

Chiudere innanzitutto Sync Client dall'area di notifica. Aprire quindi App o Programmi di Windows, selezionare Sync Client e completare le richieste di disinstallazione.

Linux

1. Chiudere Sync Client dal menu dell'area di notifica prima di eseguire il programma di disinstallazione.

2. Aprire un terminale nella directory sync-client-linux estratta.

3. Eseguire il programma di disinstallazione con privilegi di amministratore:

   sudo ./uninstall.sh

   

Il programma di disinstallazione rimuove il bundle dell'applicazione da /opt/sync-client. La configurazione, i dati sincronizzati e i log rimangono in /etc/sync-client, /var/lib/sync-client e /var/log/sync-client, in modo da poter essere riutilizzati o esaminati in seguito.