Code source wiki de Sauvegarde et restauration

Modifié par Aurelie Bertrand le 2024/03/25 13:11
Afficher les derniers auteurs
1 {{ddtoc/}}
2
3 ----
4
5 = Sauvegarde / restauration manuelle =
6
7 Si vous souhaitez installer une nouvelle version de DigDash Enterprise ou migrer vers une 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 :
8
9 1. Utilisateurs, rôles et groupes d'utilisations,
10 1. Tableaux de bords,
11 1. Portefeuilles d'informations et modèles de données,
12 1. Images, dictionnaires de données (traductions, formats, connexions, palettes de couleurs...), etc.
13 1. 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.
14
15 Sélectionnez dans un premier temps les éléments que vous souhaitez sauvegarder. Ceci crée un fichier zip que vous devez ensuite restaurer sur le nouvel environnement ou la nouvelle version.
16
17 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 :
18
19 1. 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.(% class="box infomessage" %)
20 (((
21 **NB :** nous conseillons de modifier les styles du tableau de bord depuis l'éditeur CSS du tableau de bord. Celui-ci crée un fichier default.css dans le répertoire de données de l'utilisateur. Ce fichier peut être sauvé puis restauré.
22 )))
23 1. 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.
24
25 == Sauvegarder les données ==
26
27 1. Affichez la page d'accueil :
28
29 Démarrez le navigateur Internet de votre choix, puis tapez l'URL http:~/~/NomDuServeur:PortDuServeur (exemple: [[http://localhost:8080]]). La page d'accueil s'affiche.
30
31 (% start="2" %)
32 1. Cliquez sur le lien **Configuration **puis **Gestion des sauvegardes**. Cliquez sur **Sauvegarde **pour sauvegarder votre configuration actuelle.
33 1. Dans la boîte de connexion, saisissez le nom et le mot de passe de l'utilisateur.
34 1. Cochez dans chacune des sections les éléments que vous souhaitez sauvegarder : //Voir la définition de chaque élément en annexe//.
35 1. Cliquez sur **Générer** puis sur **Télécharger le fichier de restauration **pour obtenir le fichier de sauvegarde (fichier .zip)
36
37 (% class="box infomessage" %)
38 (((
39 **NB :** Le format de sauvegarde a changé en Novembre 2015 (version 2015B1124). Si vous souhaitez faire une sauvegarde pour une version antérieure à cette date, cochez la case **Générer pour une version antérieure à la version 2015B1124**.
40 )))
41
42 == Restaurer les données ==
43
44 1. Affichez la page d'accueil :
45
46 Démarrez le navigateur Internet de votre choix, puis tapez l'URL http:~/~/NomDuServeur:PortDuServeur (exemple: [[http://localhost:8080]]). La page d'accueil s'affiche.
47
48 (% start="2" %)
49 1. Cliquez sur le lien **Configuration **puis **Gestion des sauvegardes**. Cliquez sur **Restauration **pour restaurer une configuration.
50 1. Cliquez sur **Parcourir **pour sélectionner le fichier zip correspondant à votre backup puis cliquez sur **Charger**
51 1. La liste des connexions aux bases de données présentes dans le fichier de sauvegarde est affichée afin que vous puissiez les mettre à jour si nécessaire.
52
53 == Migration des connexions et des serveurs de documents ==
54
55 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.
56
57 Lors de la première migration entre un serveur de développement et un serveur de production :
58
59 1. Effectuez une sauvegarde complète de l'environnement de développement
60 1. Restaurez la sauvegarde sur l'environnement de production
61 1. Modifiez les chaînes de connexion vers les bases de données et les serveurs de fichiers sur l'environnement de production (depuis le gestionnaire de connexions et le gestionnaire de serveurs de documents dans Enterprise Studio).
62
63 Lors des migrations suivantes vers des environnements de production :
64
65 * Faire un sauvegarde sélective des données : modèles de données, portefeuilles, tableaux de bord modifiés ou nouveaux,...
66
67 Ne pas sauver le fichier contenant les connexions (dbcnxrepository.xml) ainsi que le fichier contenant les serveurs de documents (serverurlrepository.xml) même si ceux-ci comportent des modifications
68
69 1. Restaurez la sauvegarde sur l'environnement de production.
70 1. 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.
71
72 Pour les nouvelles connexions ou les nouveaux serveurs de documents, reportez l'identifiant utilisé sur l'environnement de développement.
73
74 Pour reporter l’identifiant de connexion, ouvrez le gestionnaires de connexions (menu **Outils\gestionnaire des connexions aux bases de données **dans le Studio). Éditez la connexion à modifier puis cliquez sur **Éditer **pour modifier l'identifiant.
75
76 Pour reporter l’identifiant d'un serveur de documents, ouvrez le gestionnaires de connexions (menu **Outils\ gestionnaire des serveurs de documents **dans le Studio). Éditez le serveur de documents à modifier puis cliquez sur **Éditer **pour modifier l'identifiant.
77
78 = Automatisation =
79
80 Vous pouvez effectuer automatiquement les sauvegardes de votre environnement. Pour cela, un outil de sauvegarde est fourni : backuptools.jar à exécuter sur le serveur.
81
82 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).
83
84 Les options disponibles sont les suivantes :
85
86 1. -url server_url : URL du serveur (par défaut [[http://localhost:8080]])
87 1. -domain dd_domain : nom de domaine de l'application (par défault ddenterpriseapi)
88 1. -login user_login : login de l'administrateur
89 1. -pass user_pass : mot de passe de l'administrateur
90 1. -export ou -backup : sauvegarde la configuration dans un fichier zip
91 1. -import ou -restore : restaure la configuration depuis un fichier zip
92 1. -file zipfile : chemin du fichier backup à restaurer
93 1. -ldap : sauvegarde ou restauration de l'annuaire LDAP
94 1. -noldap : pas de sauvegarde ni de restauration de l'annuaire LDAP
95 1. -ds: sauvegarde/restaure les sources de données (par défaut)
96 1. -nods: ne sauvegarde/restaure pas les sources de données
97 1. -backupxml xmlfile: spécifie un fichier backup.xml qui agit comme modèle de ce qui doit être sauvegardé. Les options -ldap/-noldap, -ds/-nods seront ignorrées. Pas disponible lors de la restauration.
98 1. -help : affiche l'aide
99 1. -debug : affiche les messages d'erreur
100
101
102 __Exemples d'utilisation :__
103
104 {{code language="java" cssClass="notranslate"}}
105 java -jar backuptools.jar -login admin -pass admin -export -noldap
106 java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -export -ldap
107 java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -import -ldap -file C:\\backup.zip
108 {{/code}}
109
110 Si vous effectuez une sauvegarde de votre environnement un fichier backup est créé. Ce fichier porte le nom datedujour_backup.zip (par exemple 20141219_backup.zip si le backup a été effectué le 19 Décembre 2014) 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**.)
111
112 Un fichier est également fournit : « backup_export.bat » (fichier interactif avec prompts) permettant de sauvegarder votre environnement :
113
114 Ce fichier se trouve dans le répertoire d'installation . A l'exécution du fichier, vous devez indiquer :
115
116 1. l'URL de votre serveur : par défaut, [[http:~~/~~/localhost:8080>>url:http://localhost:8080/]]
117 1. le domaine de l'application : par défaut, ddenterpriseapi
118 1. le login de l'utilisateur : par défaut, admin
119 1. le mot de passe de l'utilisateur : par défaut, admin
120 1. si vous souhaitez ou non sauvegarder le dictionnaire LDAP (utilisateurs et rôles): entrez **y** pour sauvegarder et **n** pour ne pas sauvegarder.
121
122 Un fichier backup est créé. Ce fichier porte le nom <datedujour>_backup.zip (par exemple 20130710_backup.zip si le backup a été effectué le 10 Juillet 2013) et se trouve dans un répertoire contenant les données. Par défaut, **<DD Install>/Application Data/Enterprise Server/<domain>/config**.
123
124 Par exemple sur Windows 7 :
125
126 (% class="box" %)
127 (((
128 C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config
129 )))
130
131 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).
132
133 = Annexe : Liste des éléments d'une sauvegarde =
134
135 Voici la liste des éléments qu’il est possible de sauvegarder / restaurer ainsi que leur description.
136
137 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.
138
139 |**Elément**|**Description**
140 |(% colspan="2" %)(((
141 __Utilisateurs__
142
143 Données relatives à chaque utilisateur.
144 )))
145 |LDAP|Informations utilisateur stockés dans LDAP :(((
146 * Attributs de l’utilisateur (nom, identifiant, mot de passe, variables...)
147 * Rôles de l’utilisateur
148 * Autorisations et groupes d’autorisations de l’utilisateur
149 )))
150 |Portefeuilles|(((
151 Portefeuille d'information et flux de l'utilisateur
152
153 Fichier : /server/<utilisateur>/config/wallet.iwt
154 )))
155 |Tableaux de bord|(((
156 Tableaux de bord de l'utilisateur
157
158 Fichier : /server/<utilisateur>/config/dashboard.xml
159 )))
160 |Modèles de données|(((
161 Modèles de données de l'utilisateur
162
163 Fichier : /server/<utilisateur>/config/tabledatamodelrepository.xml
164 )))
165 |Mots de passe|(((
166 Mots de passe de l'utilisateur
167
168 Fichier : /server/<utilisateur>/config/passwordrepository.xml
169 )))
170 |(% colspan="2" %)(((
171 __Rôles__
172
173 Données relatives à chaque rôle.
174 )))
175 |LDAP|Informations des rôles stocké dans LDAP :(((
176 * Attributs du rôle (nom, identifiant)
177 * utilisateurs du rôle
178 )))
179 |Portefeuilles|(((
180 Portefeuille d'information et flux de rôle
181
182 Fichier : /config/wallet_<Id_Role>.xml
183 )))
184 |Tableaux de bord|(((
185 Tableaux de bord du rôle
186
187 Fichier : /config/dashboard_<Id_Role>.xml
188 )))
189 |Modèles de données|(((
190 Modèles de données du rôle
191
192 Fichier : /config/tabledatamodelrepository_<Id_Role>.xml
193 )))
194 |Mots de passe|(((
195 Mots de passe du rôle
196
197 Fichier : /config/passwordrepository_<Id_Role>.xml
198 )))
199 |(% colspan="2" %)(((
200 __Groupes d'autorisation__
201
202 Définition des groupes d'autorisations fournis par DigDash ou ajoutés par l'utilisateur. Les groupes d’autorisations sont uniquement stockés dans LDAP.
203 )))
204 |<Nom du groupe d’autorisation>|Définition du groupe d’autorisation :(((
205 * Liste des autorisations unitaires du groupe
206 )))
207 |(% colspan="2" %)(((
208 __Fichiers communs du serveur__
209
210 Liste des fichiers communs à tous les utilisateurs et les rôles.
211 )))
212 |(% colspan="2" %)__Fichiers communs du serveur / Fichiers systèmes__
213 |serversettings.xml|(((
214 Paramètres du serveur DigDash Enterprise :
215
216 * Proxy HTTP
217 * Connexion LDAP
218 * Paramètres ordonnanceur
219 * Paramètres de performances
220 * Et tous les paramètres de la page de configuration du serveur
221
222 Fichier : /config/serversettings.xml
223
224 Recommandations : Ne pas porter ce fichier entre plusieurs configurations différentes
225 )))
226 |system.xml|(((
227 Informations système et certains paramètres cachés décrits dans le document **guide_avance_systeme_fr.pdf**
228
229 Fichier : /config/system.xml
230
231 Recommandations : Ne pas porter ce fichier entre plusieurs configurations différentes
232 )))
233 |userssettings.xml|(((
234 Paramètres utilisateurs incluant les paramètres que vous avez créé.
235
236 Fichier : /config/userssettings.xml
237 )))
238 |(% colspan="2" %)(((
239
240
241 __Fichiers communs du serveur / Dictionnaires__
242
243 Paramétrages communs à tous les utilisateurs et rôles. Ces fichiers peuvent être présents ou pas selon les paramètres utilisés par les flux ou les modèles de données.
244 )))
245 |colortablerepository.xml|(((
246 Dictionnaire des palettes de couleur
247
248 Portée : Configuration des flux
249
250 Fichier : /config/colortablerepository.xml
251 )))
252 |cssrepository.xml|(((
253 Dictionnaire des styles CSS
254
255 Portée : Configuration des flux
256
257 Fichier : /config/cssrepository.xml
258 )))
259 |clustersettings.xml|(((
260 Configuration du mode cluster (avancé)
261
262 Portée : Configuration du système
263
264 Fichier : /config/clustersettings.xml
265 )))
266 |DDComments.h2.db|(((
267 Base de données des commentaires figurant sur les flux et modèles de données du tableau de bord.
268
269 Portée : Affichage des tableaux de bords et flux
270
271 Fichier : /config/DDComments.h2.db
272 )))
273 |dbcnxrepository.xml|(((
274 Dictionnaire des connexions bases de données (avancé)
275
276 Portée : Configuration des modèles de données (connexions à des sources de données)
277
278 Fichier : /config/dbcnxrepository.xml
279 )))
280 |favoritedevicesrepository.xml|(((
281 Dictionnaire des appareils utilisés pour la synchronisation des flux
282
283 Portée : Export des flux
284
285 Fichier : /config/favoritedevicesrepository.xml
286 )))
287 |flowsnapshotrepository.xml|(((
288 Dictionnaire des vues utilisateurs des flux utilisés en self-service BI
289
290 Portée : Affichage des flux (éditables dans le tableau de bord)
291
292 Fichier : /config/flowsnapshotrepository.xml
293 )))
294 |formatrepository.xml|(((
295 Dictionnaire des formats de nombres et de dates
296
297 Portée : Configuration des modèles de données et des flux
298
299 Fichier : /config/formatrepository.xml
300 )))
301 |jsfunctionrepository.xml|(((
302 Dictionnaire des fonctions javascript utilisés dans les mesures dérivées, filtres, transformations de sources…
303
304 Portée : Configuration des modèles de données et des flux
305
306 Fichier : /config/jsfunctionrepository.xml
307 )))
308 |hierarchyrepository.xml|(((
309 Dictionnaire des hiérarchies partagées utilisées par les dimensions des modèles de données
310
311 Portée : Configuration des modèles de données
312
313 Fichier : /config/hierarchyrepository.xml
314 )))
315 |navigationsentencerepository.xml|(((
316 Dictionnaire des phrases créées pour la navigation vidéo et texte des flux de type Texte
317
318 Portée : Configuration des flux
319
320 Fichier : /config/navigationsentencerepository.xml
321 )))
322 |passwordrepository.xml|(((
323 Dictionnaire des mots de passe globaux. (Déprécié)
324
325 Fichier : /config/passwordrepository.xml
326 )))
327 |serverurlrepository.xml|(((
328 Dictionnaire des serveurs de documents utilisés dans DigDash Enterprise
329
330 Portée : Configuration des modèles de données
331
332 Fichier : /config/serverurlrepository.xml
333 )))
334 |vectoriconrepository.xml|(((
335 Dictionnaire des icônes vectorielles utilisées par les graphiques de type « Infographie »
336
337 Portée : Configuration des flux
338
339 Fichier : /config/vectoriconrepository.xml
340 )))
341 |vizmodelrepository.xml|(((
342 Dictionnaire des modèles de présentations partagés associés à des flux.
343
344 Portée : Configuration des flux
345
346 Fichier : /config/vizmodelrepository.xml
347 )))
348 |(% colspan="2" %)(((
349 __Fichiers communs du serveur / Fichiers de traductions__
350
351 Les dictionnaires de traductions regroupent les messages dans différentes langues.
352
353 Chaque fichier de traduction suivants peut être accompagné d’un fichier correspondant à la langue choisie. Par exemple les fichiers **dm.properties, dm_fr.properties, dm_es.properties** sont les traductions de messages correspondant au langue anglais (défaut), français et espagnol.
354 )))
355 |dashboard.properties|(((
356 Dictionnaire des traductions utilisées dans les éléments propres au tableau de bord :
357
358 * Nom des pages
359 * Nom des portlets
360
361 Fichier : /config/dashboard.properties
362
363 /config/dashboard_<lang>.properties
364 )))
365 |dm.properties|(((
366 Dictionnaires des traductions utilisées dans les modèles de données et les flux.
367
368 Portée : Affichage de flux et d’éléments des modèles de données
369
370 Fichiers : /config/dm.properties,
371
372 /config/dm_<lang>.properties
373 )))
374 |dmvoc.properties|(((
375 Dictionnaire des valeurs parlées pour les expressions des modèles de données.
376
377 Portée : Export vidéo de flux (option)
378
379 Fichiers : /config/dmvoc.properties,
380
381 /config/dmvoc_<lang>.properties
382 )))
383 |dmtag.properties|(((
384 Dictionnaire des synonymes créés dans les modèles de données. Ces dictionnaires sont utilisés par la fonction de recherche du tableau de bord : requête en langage naturel.
385
386 Portée : Recherche textuelle dans le tableau de bord
387
388 Fichiers : /config/dmtag.properties,
389
390 /config/dmtag_<lang>.properties
391 )))
392 |(((
393 dashboard<domain>.properties
394
395 //(Déprécié)//
396 )))|(((
397 Dictionnaire des éléments du tableau de bord (nom des pages, …).
398
399 (% class="box errormessage" %)
400 (((
401 //Ces fichiers sont dépréciés et n’ont pas à être sauvegardés/restaurés//
402 )))
403 )))
404 |(% colspan="2" %)(((
405 __Fichiers communs du serveur / Autres__
406
407 Autres fichiers liés à la configuration des tableaux de bord.
408 )))
409 |(((
410 Images
411
412 (*.png, *.jpg, *.gif...)
413 )))|(((
414 Liste des images ajoutées depuis l'éditeur de tableau de bord.
415
416 Dossier: /config/web/public/, /config/web/public/<Id_Role>/, /config/web/public/<utilisateur>/
417 )))
418 |(((
419 Styles
420
421 default.css
422
423 *.css
424 )))|(((
425 Fichiers contenant les styles personnalisés du tableau de bord. Les feuilles de styles CSS sont éditables dans l’interface d’édition des tableaux de bord.
426
427 Fichier: /config/web/public/default.css,
428
429 /config/web/public/*.css
430 )))
431 |js-const.js|(((
432 Constantes du serveur (propriétés figurant dans la page « Configuration du serveur > Avancé », section « Constantes » ) + paramètres d'export (section «Options d' export »)
433
434 Fichier: /config/web/session/js-const.js,
435 )))
436 |js-default.js|(((
437 Fichier de script custom du tableau de bord. Ce fichier peut directement être édité à partir de l’interface d’édition des tableaux de bord.
438
439 Fichier: /config/web/session/js-default.js
440 )))
441 |(% colspan="2" %)(((
442 __Fichiers communs du serveur / Sources de données__
443
444 Sources de données figurant dans le serveur de fichiers UserDocs. Les fichiers contenus dans ce serveur peuvent être intégrés au backup.
445 )))