Sauvegarde et restauration automatisée (backuptools)

Modifié par Aurelie Bertrand le 2025/12/19 08:51

Vous pouvez effectuer automatiquement les sauvegardes de votre environnement. Pour cela, un outil de sauvegarde est fourni : backuptools.jar à exécuter sur le serveur. 
Il peut être exécuté via l’outil Java "backuptools.jar" fourni dans le dossier <digdash_install>\add-ons\tools\lib avec les arguments par défaut ou personnalisables (voir partie suivante).

Les options disponibles sont les suivantes :

  1. -url server_url : URL du serveur (par défaut http://localhost:8080)
  2. -domain dd_domain : nom de domaine de l'application (par défault ddenterpriseapi)
  3. -login user_login : login de l'administrateur
  4. -pass user_pass : mot de passe de l'administrateur
  5. -export ou -backup : sauvegarde la configuration dans un fichier zip
  6. -import ou -restore : restaure la configuration depuis un fichier zip
  7. -file zipfile : chemin du fichier backup à restaurer
  8. -ldap : sauvegarde ou restauration de l'annuaire LDAP
  9. -noldap : pas de sauvegarde ni de restauration de l'annuaire LDAP
  10. -ds : sauvegarde ou restauration des sources de données figurant dans le répertoire de données Common Datasources
  11.  -nods : pas de sauvegarde ni de restauration des sources de données figurant dans le répertoire de données Common Datasources
  12. -help : affiche l'aide
  13. -debug : affiche les messages d'erreur
  14. -backupxml xmlfile: spécifie un fichier backup.xml qui sert de modèle pour la sauvegarde. (Ignore les options -ldap/-noldap, -ds/-nods. Non disponible en mode restauration.)
    Ce modèle permet de spécifier les éléments à sauvegarder (modèles de données, flux, formats, etc) comme vous pouvez le faire dans l'interface de sauvegarde classique. Un fichier d'exemple backupTemplate.xml est disponible dans le répertoire /add-ons/tools/backuptools/. Afin de faciliter la configuration, vous pouvez également récupérer le fichier backup.xml d'une sauvegarde existante et le modifier.

Exemples d'utilisation :

java -jar backuptools.jar -login admin -pass admin -export -noldap
java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -export -ldap
java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -import -ldap -file C:\\backup.zip

Si vous effectuez une sauvegarde de votre environnement un fichier backup est créé. Ce fichier porte le nom datedujour_backup.zip (par exemple 20121219_backup.zip si le backup a été effectué le 19 Décembre 2022) et se trouve dans le répertoire contenant les données de l'outil (Par défaut, <DD Install>/Application Data/Enterprise Server/<domain>/config.)

Un fichier est également fournit : « backup_export.bat » (fichier interactif avec prompts) permettant de sauvegarder votre environnement :

Ce fichier se trouve dans le répertoire d'installation . A l'exécution du fichier, vous devez indiquer :

  1. L'URL de votre serveur : par défaut, http://localhost:8080
  2. Le domaine de l'application : par défaut, ddenterpriseapi
  3. L'identifiant de l'utilisateur : par défaut, admin
  4. Le mot de passe de l'utilisateur : par défaut, admin
  5. Si vous souhaitez ou non sauvegarder le dictionnaire LDAP (utilisateurs et rôles): entrez y pour sauvegarder et n pour ne pas sauvegarder.

Un fichier backup est créé. Ce fichier porte le nom <datedujour>_backup.zip (par exemple 20230710_backup.zip si le backup a été effectué le 10 Juillet 2023) et se trouve dans un répertoire contenant les données. Par défaut, <DD Install>/Application Data/Enterprise Server/<domain>/config.

Par exemple sur Windows :

C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config

Pour restaurer un backup automatiquement, vous pouvez également utiliser le fichier backup_import.bat. Vous devez renseigner les même paramètres que pour backup_export (au lieu d'indiquer si vous souhaitez sauvegarder le répertoire LDAP, indiquez si vous souhaitez le restaurer). Indiquez également le nom du fichier backup (par défaut, il doit se trouver dans le répertoire ou figure le fichier backup_import.bat).