• Sauvegarde / restauration manuelle
  • Sauvegarder les données
  • Restaurer les données
• Migration des connexions aux bases de données et des serveurs de fichiers
• Automatisation
• Annexe : Liste des éléments d'une sauvegarde

Sauvegarde / restauration manuelle

Si vous souhaitez installer une nouvelle version de DigDash Enterprise ou migrer vers un nouvel environnement (passage d'un environnement de test à un environnement de production, modification de la machine serveur,...), vous pouvez sauvegarder puis restaurer les données de votre environnement actuel :

• Utilisateurs, rôles et groupes d'utilisations,
• Tableaux de bords,
• Portefeuilles d'informations et modèles de données,
• Images, dictionnaires de données (traductions, formats, connexions, palettes de couleurs...), etc.
• Sources de données : les sources de données figurant dans le répertoire de données de l'utilisateur UserDocs peuvent être sauvegardées.

Il faudra sélectionner les éléments que vous souhaitez sauvegarder puis générer un fichier zip qui vous permettra ensuite de les restaurer sur le nouvel environnement ou la nouvelle version.

❗Attention, les fichiers figurant dans le répertoire d'installation, ne sont pas sauvés ni restaurés par l'outil, vous devez donc les recopier manuellement si vous avez effectué des modifications :

• Styles du tableau de bord : si vous avez modifié les styles du tableau de bord depuis le fichier dashboard.css figurant dans le répertoire webapps/digdash_dashboard, celui-ci devra être manuellement copié vers le nouvel environnement.

• Images, logos et icônes : si vous avez modifié les fichiers se trouvant dans le répertoire webapps/digdash_dashboard/icons, vous devrez les copier pour les ré-appliquer sur votre nouvelle version.

Sauvegarder les données

Pour sauvegarder les données :

1. Depuis la page d'accueil, allez dans Configuration puis Gestion des sauvegardes
2. Cliquez sur Sauvegarde.
3. Dans la boîte de connexion, saisissez le nom et le mot de passe de l'utilisateur.
   ➡ La page Sauvegarde s'affiche.
4. Cochez dans chacune des sections les éléments que vous souhaitez sauvegarder : Voir la définition de chaque élément.
5. Cliquez sur Générer en bas à droite de la page puis sur Télécharger le fichier de restauration pour obtenir le fichier de sauvegarde (fichier .zip).

Vous pouvez sauvegarder directement l'ensemble des données en cliquant sur le bouton Sélectionner tout & Générer en haut de la page.

Restaurer les données

1. Depuis la page d'accueil, allez dans Configuration puis Gestion des sauvegardes.
2. Cliquez sur Restauration.
   ➡ La page Restauration s'affiche.
3. Vous avez 2 possibilités :
   • Cliquer sur Parcourir pour sélectionner le fichier zip correspondant à la sauvegarde que vous souhaitez restaurer.
   • Sélectionner une sauvegarde dans la liste de sauvegardes automatiques dans la liste déroulante correspondante :
     
4. Cliquez sur Charger.
   ➡ La page Restauration affiche les données contenues dans la sauvegarde. Elles sont toutes sélectionnées par défaut. Vous pouvez modifier la sélection comme souhaité.
5. Cliquez sur Valider en bas de la page.
   ➡ Un message vous indique que les données ont été rechargées et vous invite à redémarrer le serveur. 

Migration des connexions aux bases de données et des serveurs de fichiers

Afin de faciliter la migration de ces éléments, Il est possible de modifier leurs identifiants afin que ceux-ci soient identiques entre les serveurs de développement et production.

Lors de la première migration entre un serveur de développement et un serveur de production :

1. Effectuez une sauvegarde complète de l'environnement de développement.
2. Restaurez la sauvegarde sur l'environnement de production.
3. Modifiez les chaînes de connexion vers les bases de données et les serveurs de fichiers sur l'environnement de production depuis, respectivement, le Gestionnaire de connexions aux bases de données et le Gestionnaire des serveurs de fichiers dans le Studio.

Lors des migrations suivantes vers des environnements de production :

1. Faire un sauvegarde sélective des données : modèles de données, portefeuilles, tableaux de bord modifiés ou nouveaux,...

2. Restaurez la sauvegarde sur l'environnement de production.
3. Si des modifications ont été apportées aux connexions ou serveurs de fichiers dans l'environnement de développement, reportez les manuellement sur l'environnement de production.

Pour les nouvelles connexions ou les nouveaux serveurs de documents, reportez l'identifiant utilisé sur l'environnement de développement :

• Pour reporter l’identifiant de connexion base de données, ouvrez le Gestionnaire de connexions aux bases de données dans le Studio. Éditez la connexion à modifier puis cliquez sur le bouton Éditer à droite du champ Identifiant pour modifier ce dernier.
  
   
• Pour reporter l’identifiant d'un serveur de documents, ouvrez Gestionnaire des serveurs de fichiers dans le Studio. Éditez le serveur de fichiers à modifier puis cliquez sur le bouton Éditer à droite du champ Identifiant pour modifier ce dernier.

Automatisation

Vous pouvez effectuer automatiquement les sauvegardes de votre environnement. Pour cela, un outil de sauvegarde est fourni : backuptools.jar à exécuter sur le serveur.

Ce fichier jar se trouve dans le répertoire <tomcat webapps>/ddenterpriseapi/WEB-INF/lib et doit être utilisé depuis cet endroit (car il utilise d'autres fichiers jar situés dans le même répertoire).

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. -help : affiche l'aide
11. -debug : affiche les messages d'erreur
12. -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.)

Exemples d'utilisation :

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 :

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).

Annexe : Liste des éléments d'une sauvegarde

Voici la liste des éléments qu’il est possible de sauvegarder / restaurer ainsi que leur description.

Lorsque l’élément correspond à un fichier, il est situé dans le répertoire des données du domaine DigDash. Par exemple : <AppData>/Enterprise Server/ddenterpriseapi. Les chemins des fichiers mentionnés ci-dessous sont relatifs à ce répertoire.