Un Workspace Enterprise Server peut contenir un large éventail de données précieuses, notamment des utilisateurs définis, des groupes, des tâches de synchronisation LDAP, des données de conception (y compris des projets, composants, modèles et modèles de document), ainsi que des configurations pour les services PLS et NIS (et généralement une gamme de produits et d’extensions acquis, ainsi que des packages de déploiement définis pour ces derniers). Une exigence essentielle pour garantir l’intégrité à long terme de ces données est d’en effectuer une sauvegarde. L’installation standard d’Enterprise Server inclut un outil de sauvegarde et de restauration, accessible via une invite de commande.
L’emplacement par défaut de l’outil de sauvegarde se trouve dans le dossier \Program Files (x86)\Altium\Altium365\Tools\BackupTool.
Le nom de l’outil de sauvegarde est avbackup.exe.
-
Si l’outil avbackup.exe ne se trouve pas dans le chemin par défaut – \Program Files (x86)\Altium\Altium365\Tools\BackupTool – des erreurs/exceptions peuvent survenir lors d’une restauration.
-
L’outil autonome Health Monitor (avhealth.exe) doit être fermé lors de l’utilisation de l’outil de sauvegarde (en mode sauvegarde ou restauration), car les deux outils nécessitent l’accès au fichier de base de données d’Enterprise Server.
-
Il est fortement recommandé que les utilisateurs ne soient pas connectés au Workspace et ne l’utilisent pas pendant les प्रक्रessus de sauvegarde et de restauration, qui nécessitent l’accès à la base de données du Workspace. En tant qu’administrateur du Workspace, vous pouvez déconnecter de force les utilisateurs si nécessaire en supprimant leur session Workspace en cours via la page Sessions de l’interface du navigateur (Admin – Sessions). Consultez la page Sessions pour plus d’informations.
-
La restauration d’une sauvegarde n’est possible que vers la même version d’Enterprise Server que celle à partir de laquelle cette sauvegarde a été effectuée. À cet égard, il peut être judicieux de conserver le programme d’installation de cet Enterprise Server, ainsi que les fichiers de licence correspondants, avec l’archive Zip de sauvegarde.
Le processus de sauvegarde/restauration réinitialise également le compteur de transactions de la base de données. L’état actuel du compteur de transactions du serveur peut être vérifié à l’aide de l’outil Health Monitor (reportez-vous à l’entrée Transaction count dans la zone DATABASE de la fenêtre de l’outil).
L’outil de sauvegarde utilise le service Volume Shadow Copy Service (VSS) pour créer une copie instantanée du volume où se trouvent les données du serveur (une configuration dans laquelle les révisions sont stockées sur un volume distinct est également prise en charge). Avec VSS, l’outil de sauvegarde arrête les services, crée une copie instantanée, redémarre les services, puis effectue la sauvegarde des données à l’aide de la copie instantanée créée. Cette approche minimise la durée d’indisponibilité du serveur (la période entre l’arrêt et le redémarrage des services) et est utilisée par défaut. En cas d’erreur lors de la création d’une copie instantanée, l’outil de sauvegarde utilisera une approche sans création de copie instantanée (qui peut également être activée explicitement à l’aide du commutateur --skip-shadow-copy).
Accès à l’outil de sauvegarde
Pour utiliser l’outil :
-
Lancez une invite de commande Windows.
Vous devez exécuter l’invite de commande en mode administrateur pour pouvoir utiliser l’outil de sauvegarde et de restauration. Si vous n’exécutez pas une invite CMD en tant qu’administrateur Windows, toute tentative d’exécution d’une commande de sauvegarde ou de restauration de votre Enterprise Server entraînera l’affichage du message explicite suivant : Access Denied. Administrator permissions are needed to use the selected options. Use an administrator command prompt to complete these tasks.
-
Accédez au dossier approprié. Pour une installation par défaut sur le lecteur C de l’ordinateur hôte, il s’agira de : cd C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\
-
Pour exécuter l’outil et afficher les options disponibles, saisissez à l’invite : avbackup ?
Sur certaines versions de Windows, il n’est pas possible de coller dans une invite de commande avec Ctrl+V, mais vous pouvez coller via le menu contextuel accessible par clic droit. Copiez d’abord les chaînes requises, puis collez-les à l’aide de cette technique pour gagner du temps et éviter les erreurs.

Accès à l’outil de sauvegarde via une invite de commande (exécutée en tant qu’administrateur).
Notez le ? ; l’inclure affiche l’aide sur les fonctions disponibles dans l’outil de sauvegarde :
-
backup – sauvegarder les données dans une archive ZIP.
-
restore – restaurer les données à partir d’une archive ZIP. Le point de restauration sera créé automatiquement.
-
help – afficher l’écran d’aide (? peut être utilisé à la place de la chaîne help).
Contenu de l’archive Zip
L’outil sauvegarde l’intégralité d’Enterprise Server et des données utilisateur, notamment :
-
Sauvegarde complète de la base de données, y compris : tous les éléments de données (modèles, composants, feuilles gérées, modèles, conceptions publiées, etc.), utilisateurs, groupes, installations acquises via le Network Installation Service et paramètres de synchronisation LDAP.
-
Toutes les révisions de ce qui précède.
-
Référentiels et conceptions Workspace incluses.
-
Index de recherche.
-
Paramètres définis par l’utilisateur (personnalisés).
Syntaxe de sauvegarde et commutateurs
Les commutateurs suivants sont disponibles lors de l’utilisation de la fonction de sauvegarde de l’outil :
avbackup backup -z [-t] [-h] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – chemin et nom de fichier du fichier zip cible à créer. Mettez entre guillemets s’il y a des espaces dans la chaîne. Ce commutateur est requis.
-
-t, --test – si ce commutateur est spécifié, le fichier zip sera testé après la sauvegarde.
-
-h, --hash – si ce commutateur est spécifié, un fichier de hachage MD5 (*.md5) sera créé.
-
-i – chemin complet vers le fichier LocalVault.ini d’Enterprise Server, qui fournit les informations d’emplacement des données pour l’Enterprise Server à sauvegarder. Le chemin par défaut de ce fichier est C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Si ce commutateur n’est pas spécifié, l’outil tentera de trouver automatiquement le fichier en se basant sur cet emplacement d’installation par défaut. Mettez entre guillemets s’il y a des espaces dans la chaîne.
-
-m – vous permet de déterminer si l’opération de sauvegarde doit s’exécuter en mode silencieux (-m silent, qui est le mode par défaut), ou si une boîte de dialogue doit s’afficher pour demander une nouvelle tentative en cas d’échec (-m dialog). Si ce commutateur n’est pas spécifié, le mode silencieux sera utilisé.
-
-d, --debug – si ce commutateur est spécifié, le mode débogage sera utilisé, ce qui permettra de créer davantage de journaux à des fins de diagnostic et de partage avec les ingénieurs Altium.
-
-c – vous permet de spécifier le niveau de compression du fichier zip cible. Utilisez un nombre de 0 à 9. Vous pouvez également utiliser les valeurs suivantes :
-
Default – équivaut au niveau de compression 6 (utilisé si ce commutateur n’est pas spécifié)
-
None – équivaut au niveau de compression 0
-
BestSpeed – équivaut au niveau de compression 1
-
BestCompression – équivaut au niveau de compression 9.
-
--split – si ce commutateur est spécifié, des fichiers zip distincts seront créés pour les référentiels et les révisions (sans compression), en plus du fichier zip pour les autres données.
-
--skip-shadow-copy – si ce commutateur est spécifié, aucune copie instantanée ne sera créée. Notez que la durée d’indisponibilité du serveur (la période entre l’arrêt et le redémarrage des services) augmente lorsque ce commutateur est utilisé.
En saisissant simplement avbackup backup, ces commutateurs seront listés comme aide pratique.

Commutateurs disponibles lors de l’utilisation de l’outil en mode sauvegarde.
Backup Example
L’entrée suivante sauvegardera silencieusement l’Enterprise Server dans le fichier nommé 02102024_Backup.zip, en écrivant le fichier dans le dossier C:\Backups\Altium Enterprise Server\ :
avbackup backup -z "C:\Backups\Altium Enterprise Server\02102024_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"
Tous les dossiers spécifiés doivent déjà exister. De plus, les fichiers existants sont écrasés si le nouveau fichier porte le même nom qu’un fichier existant.

Résultat de l’exécution de l’exemple de commande de sauvegarde.
Syntaxe de restauration et commutateurs
Les commutateurs suivants sont disponibles lors de l’utilisation de la fonction de restauration de l’outil :
avbackup restore -z [--skip-backup] [-i] [-m] [-d] [-c] [--split] [--skip-shadow-copy]
-
-z – chemin et nom de fichier du fichier zip de sauvegarde à partir duquel restaurer. Mettez entre guillemets s’il y a des espaces dans la chaîne. Ce commutateur est requis.
-
--skip-backup – vous permet d’ignorer la création d’un point de restauration avant de commencer la restauration de l’Enterprise Server. Utilisez-le avec précaution, car si la restauration des données échoue, il ne sera pas possible de revenir en arrière.
-
-i – chemin complet vers le fichier LocalVault.ini d’Enterprise Server, qui fournit des informations sur les emplacements dans lesquels restaurer les données d’Enterprise Server. Le chemin par défaut de ce fichier est C:\Program Files (x86)\Altium\Altium365\LocalVault.ini. Si ce commutateur n’est pas spécifié, l’outil tentera de trouver automatiquement le fichier en se basant sur cet emplacement d’installation par défaut. Mettez entre guillemets s’il y a des espaces dans la chaîne.
-
-m – vous permet de déterminer si l’opération de restauration doit s’exécuter en mode silencieux (-m silent, qui est le mode par défaut), ou si une boîte de dialogue doit s’afficher pour demander une nouvelle tentative en cas d’échec (-m dialog). Si ce commutateur n’est pas spécifié, le mode silencieux sera utilisé.
-
-d, --debug – si ce commutateur est spécifié, le mode débogage sera utilisé, ce qui permettra de créer davantage de journaux à des fins de diagnostic et de partage avec les ingénieurs Altium.
-
-c – vous permet de spécifier le niveau de compression du fichier zip cible pour le point de restauration (une sauvegarde de l’installation Enterprise Server actuelle). Utilisez un nombre de 0 à 9. Vous pouvez également utiliser les valeurs suivantes :
-
Default – équivaut au niveau de compression 6 (utilisé si ce commutateur n’est pas spécifié)
-
None – équivaut au niveau de compression 0
-
BestSpeed – équivaut au niveau de compression 1
-
BestCompression – équivaut au niveau de compression 9.
-
--split – si ce commutateur est spécifié, des fichiers zip distincts seront créés pour les référentiels et les révisions (sans compression), en plus du fichier zip pour les autres données, pour le point de restauration (une sauvegarde de l’installation Enterprise Server actuelle).
-
--skip-shadow-copy – si ce commutateur est spécifié, aucune copie miroir ne sera créée pour le point de restauration (une sauvegarde de l’installation actuelle d’Enterprise Server). Notez que l’indisponibilité du serveur (la période entre l’arrêt et le redémarrage des services) augmente lorsque ce commutateur est utilisé.
En saisissant simplement avbackup restore, ces commutateurs seront affichés à titre d’aide.

Commutateurs disponibles lors de l’utilisation de l’outil en mode restauration.
Si un fichier de hachage *.md5 existe pour le fichier ZIP de sauvegarde à partir duquel effectuer la restauration (le fichier *.md5 se trouve dans le même dossier que le fichier ZIP et porte le nom du fichier ZIP, c.-à-d. <ZipFileName>.zip.md5), son hachage sera vérifié avant la restauration.
Restore Example
L’entrée suivante restaurera silencieusement Enterprise Server à l’aide du fichier ZIP de sauvegarde nommé 30082022_Backup.zip, qui est stocké dans le dossier C:\Backups\Altium Enterprise Server\:
avbackup restore -z "C:\Backups\Altium Enterprise Server\30082022_Backup.zip" -i "C:\Program Files (x86)\Altium\Altium365\LocalVault.ini"

Résultat de l’exécution de la commande de restauration d’exemple. Notez que l’outil crée d’abord un point de restauration (une sauvegarde de l’installation actuelle d’Enterprise Server), avant d’effectuer la restauration.
Point de restauration
L’outil de sauvegarde crée automatiquement un point de restauration avant de commencer à restaurer Enterprise Server (si --skip-backup n’a pas été utilisé pour la restauration). Pour ce faire, l’outil de sauvegarde effectue une sauvegarde de l’Enterprise Server existant et copie le ZIP de restauration à l’emplacement suivant :
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\Backups\
Le ZIP est nommé selon le format suivant : Backup_<Date>_<Time>.zip.
Journalisation de la sauvegarde et de la restauration
Les informations sur les événements survenant pendant une sauvegarde ou une restauration sont affichées directement dans la fenêtre CMD et peuvent également être consultées dans le fichier journal :
C:\Program Files (x86)\Altium\Altium365\Tools\BackupTool\avbackup.log
Si une erreur se produit pendant une sauvegarde ou une restauration, toutes les informations la concernant peuvent également être consultées dans le fichier journal (
).