Code source wiki de Sauvegarde et restauration

Modifié par Aurelie Bertrand le 2024/04/02 14:41
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. -help : affiche l'aide
96 1. -debug : affiche les messages d'erreur
97
98
99 __Exemples d'utilisation :__
100
101 {{code language="java"}}
102 java -jar backuptools.jar -login admin -pass admin -export -noldap
103 java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -export -ldap
104 java -jar backuptools.jar -url http://localhost:8080 -domain ddenterpriseapi -login admin -pass admin -import -ldap -file C:\\backup.zip
105 {{/code}}
106
107 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**.)
108
109 Un fichier est également fournit : « backup_export.bat » (fichier interactif avec prompts) permettant de sauvegarder votre environnement :
110
111 Ce fichier se trouve dans le répertoire d'installation . A l'exécution du fichier, vous devez indiquer :
112
113 1. l'URL de votre serveur : par défaut, [[http:~~/~~/localhost:8080>>url:http://localhost:8080/]]
114 1. le domaine de l'application : par défaut, ddenterpriseapi
115 1. le login de l'utilisateur : par défaut, admin
116 1. le mot de passe de l'utilisateur : par défaut, admin
117 1. si vous souhaitez ou non sauvegarder le dictionnaire LDAP (utilisateurs et rôles): entrez **y** pour sauvegarder et **n** pour ne pas sauvegarder.
118
119 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**.
120
121 Par exemple sur Windows 7 :
122
123 (% class="box" %)
124 (((
125 C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config
126 )))
127
128 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).
129
130 = Annexe : Liste des éléments d'une sauvegarde =
131
132 Voici la liste des éléments qu’il est possible de sauvegarder / restaurer ainsi que leur description.
133
134 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.
135
136 |**Elément**|**Description**
137 |(% colspan="2" %)(((
138 __Utilisateurs__
139
140 Données relatives à chaque utilisateur.
141 )))
142 |LDAP|Informations utilisateur stockés dans LDAP :(((
143 * Attributs de l’utilisateur (nom, identifiant, mot de passe, variables...)
144 * Rôles de l’utilisateur
145 * Autorisations et groupes d’autorisations de l’utilisateur
146 )))
147 |Portefeuilles|(((
148 Portefeuille d'information et flux de l'utilisateur
149
150 Fichier : /server/<utilisateur>/config/wallet.iwt
151 )))
152 |Tableaux de bord|(((
153 Tableaux de bord de l'utilisateur
154
155 Fichier : /server/<utilisateur>/config/dashboard.xml
156 )))
157 |Modèles de données|(((
158 Modèles de données de l'utilisateur
159
160 Fichier : /server/<utilisateur>/config/tabledatamodelrepository.xml
161 )))
162 |Mots de passe|(((
163 Mots de passe de l'utilisateur
164
165 Fichier : /server/<utilisateur>/config/passwordrepository.xml
166 )))
167 |(% colspan="2" %)(((
168 __Rôles__
169
170 Données relatives à chaque rôle.
171 )))
172 |LDAP|Informations des rôles stocké dans LDAP :(((
173 * Attributs du rôle (nom, identifiant)
174 * utilisateurs du rôle
175 )))
176 |Portefeuilles|(((
177 Portefeuille d'information et flux de rôle
178
179 Fichier : /config/wallet_<Id_Role>.xml
180 )))
181 |Tableaux de bord|(((
182 Tableaux de bord du rôle
183
184 Fichier : /config/dashboard_<Id_Role>.xml
185 )))
186 |Modèles de données|(((
187 Modèles de données du rôle
188
189 Fichier : /config/tabledatamodelrepository_<Id_Role>.xml
190 )))
191 |Mots de passe|(((
192 Mots de passe du rôle
193
194 Fichier : /config/passwordrepository_<Id_Role>.xml
195 )))
196 |(% colspan="2" %)(((
197 __Groupes d'autorisation__
198
199 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.
200 )))
201 |<Nom du groupe d’autorisation>|Définition du groupe d’autorisation :(((
202 * Liste des autorisations unitaires du groupe
203 )))
204 |(% colspan="2" %)(((
205 __Fichiers communs du serveur__
206
207 Liste des fichiers communs à tous les utilisateurs et les rôles.
208 )))
209 |(% colspan="2" %)__Fichiers communs du serveur / Fichiers systèmes__
210 |serversettings.xml|(((
211 Paramètres du serveur DigDash Enterprise :
212
213 * Proxy HTTP
214 * Connexion LDAP
215 * Paramètres ordonnanceur
216 * Paramètres de performances
217 * Et tous les paramètres de la page de configuration du serveur
218
219 Fichier : /config/serversettings.xml
220
221 Recommandations : Ne pas porter ce fichier entre plusieurs configurations différentes
222 )))
223 |system.xml|(((
224 Informations système et certains paramètres cachés décrits dans le document **guide_avance_systeme_fr.pdf**
225
226 Fichier : /config/system.xml
227
228 Recommandations : Ne pas porter ce fichier entre plusieurs configurations différentes
229 )))
230 |userssettings.xml|(((
231 Paramètres utilisateurs incluant les paramètres que vous avez créé.
232
233 Fichier : /config/userssettings.xml
234 )))
235 |(% colspan="2" %)(((
236
237
238 __Fichiers communs du serveur / Dictionnaires__
239
240 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.
241 )))
242 |colortablerepository.xml|(((
243 Dictionnaire des palettes de couleur
244
245 Portée : Configuration des flux
246
247 Fichier : /config/colortablerepository.xml
248 )))
249 |cssrepository.xml|(((
250 Dictionnaire des styles CSS
251
252 Portée : Configuration des flux
253
254 Fichier : /config/cssrepository.xml
255 )))
256 |clustersettings.xml|(((
257 Configuration du mode cluster (avancé)
258
259 Portée : Configuration du système
260
261 Fichier : /config/clustersettings.xml
262 )))
263 |DDComments.h2.db|(((
264 Base de données des commentaires figurant sur les flux et modèles de données du tableau de bord.
265
266 Portée : Affichage des tableaux de bords et flux
267
268 Fichier : /config/DDComments.h2.db
269 )))
270 |dbcnxrepository.xml|(((
271 Dictionnaire des connexions bases de données (avancé)
272
273 Portée : Configuration des modèles de données (connexions à des sources de données)
274
275 Fichier : /config/dbcnxrepository.xml
276 )))
277 |favoritedevicesrepository.xml|(((
278 Dictionnaire des appareils utilisés pour la synchronisation des flux
279
280 Portée : Export des flux
281
282 Fichier : /config/favoritedevicesrepository.xml
283 )))
284 |flowsnapshotrepository.xml|(((
285 Dictionnaire des vues utilisateurs des flux utilisés en self-service BI
286
287 Portée : Affichage des flux (éditables dans le tableau de bord)
288
289 Fichier : /config/flowsnapshotrepository.xml
290 )))
291 |formatrepository.xml|(((
292 Dictionnaire des formats de nombres et de dates
293
294 Portée : Configuration des modèles de données et des flux
295
296 Fichier : /config/formatrepository.xml
297 )))
298 |jsfunctionrepository.xml|(((
299 Dictionnaire des fonctions javascript utilisés dans les mesures dérivées, filtres, transformations de sources…
300
301 Portée : Configuration des modèles de données et des flux
302
303 Fichier : /config/jsfunctionrepository.xml
304 )))
305 |hierarchyrepository.xml|(((
306 Dictionnaire des hiérarchies partagées utilisées par les dimensions des modèles de données
307
308 Portée : Configuration des modèles de données
309
310 Fichier : /config/hierarchyrepository.xml
311 )))
312 |navigationsentencerepository.xml|(((
313 Dictionnaire des phrases créées pour la navigation vidéo et texte des flux de type Texte
314
315 Portée : Configuration des flux
316
317 Fichier : /config/navigationsentencerepository.xml
318 )))
319 |passwordrepository.xml|(((
320 Dictionnaire des mots de passe globaux. (Déprécié)
321
322 Fichier : /config/passwordrepository.xml
323 )))
324 |serverurlrepository.xml|(((
325 Dictionnaire des serveurs de documents utilisés dans DigDash Enterprise
326
327 Portée : Configuration des modèles de données
328
329 Fichier : /config/serverurlrepository.xml
330 )))
331 |vectoriconrepository.xml|(((
332 Dictionnaire des icônes vectorielles utilisées par les graphiques de type « Infographie »
333
334 Portée : Configuration des flux
335
336 Fichier : /config/vectoriconrepository.xml
337 )))
338 |vizmodelrepository.xml|(((
339 Dictionnaire des modèles de présentations partagés associés à des flux.
340
341 Portée : Configuration des flux
342
343 Fichier : /config/vizmodelrepository.xml
344 )))
345 |(% colspan="2" %)(((
346 __Fichiers communs du serveur / Fichiers de traductions__
347
348 Les dictionnaires de traductions regroupent les messages dans différentes langues.
349
350 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.
351 )))
352 |dashboard.properties|(((
353 Dictionnaire des traductions utilisées dans les éléments propres au tableau de bord :
354
355 * Nom des pages
356 * Nom des portlets
357
358 Fichier : /config/dashboard.properties
359
360 /config/dashboard_<lang>.properties
361 )))
362 |dm.properties|(((
363 Dictionnaires des traductions utilisées dans les modèles de données et les flux.
364
365 Portée : Affichage de flux et d’éléments des modèles de données
366
367 Fichiers : /config/dm.properties,
368
369 /config/dm_<lang>.properties
370 )))
371 |dmvoc.properties|(((
372 Dictionnaire des valeurs parlées pour les expressions des modèles de données.
373
374 Portée : Export vidéo de flux (option)
375
376 Fichiers : /config/dmvoc.properties,
377
378 /config/dmvoc_<lang>.properties
379 )))
380 |dmtag.properties|(((
381 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.
382
383 Portée : Recherche textuelle dans le tableau de bord
384
385 Fichiers : /config/dmtag.properties,
386
387 /config/dmtag_<lang>.properties
388 )))
389 |(((
390 dashboard<domain>.properties
391
392 //(Déprécié)//
393 )))|(((
394 Dictionnaire des éléments du tableau de bord (nom des pages, …).
395
396 (% class="box errormessage" %)
397 (((
398 //Ces fichiers sont dépréciés et n’ont pas à être sauvegardés/restaurés//
399 )))
400 )))
401 |(% colspan="2" %)(((
402 __Fichiers communs du serveur / Autres__
403
404 Autres fichiers liés à la configuration des tableaux de bord.
405 )))
406 |(((
407 Images
408
409 (*.png, *.jpg, *.gif...)
410 )))|(((
411 Liste des images ajoutées depuis l'éditeur de tableau de bord.
412
413 Dossier: /config/web/public/, /config/web/public/<Id_Role>/, /config/web/public/<utilisateur>/
414 )))
415 |(((
416 Styles
417
418 default.css
419
420 *.css
421 )))|(((
422 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.
423
424 Fichier: /config/web/public/default.css,
425
426 /config/web/public/*.css
427 )))
428 |js-const.js|(((
429 Constantes du serveur (propriétés figurant dans la page « Configuration du serveur > Avancé », section « Constantes » ) + paramètres d'export (section «Options d' export »)
430
431 Fichier: /config/web/session/js-const.js,
432 )))
433 |js-default.js|(((
434 Fichier de script custom du tableau de bord. Ce fichier peut directement être édité à partir de l’interface d’édition des tableaux de bord.
435
436 Fichier: /config/web/session/js-default.js
437 )))
438 |(% colspan="2" %)(((
439 __Fichiers communs du serveur / Sources de données__
440
441 Sources de données figurant dans le serveur de fichiers UserDocs. Les fichiers contenus dans ce serveur peuvent être intégrés au backup.
442 )))