Wiki source code of Sauvegarde et restauration

Last modified by Aurelie Bertrand on 2025/02/07 10:18
Show last authors
1 {{ddtoc/}}
2
3 ----
4
5 = MANUAL BACKUP / RESTORATION =
6
7 [[Edit>>url:http://rack-lure:8585/bin/edit/Digdash_2019R2/deployment/configuration/backup_restore/WebHome?section=1]]
8
9 If you want to install a new version of DigDash Enterprise or migrate to a new environment (transition from a test environment to a production environment, modification of the server machine, ...), you can backup and restore the data of your current environment:
10
11 1. Users, roles and use groups,
12 1. Dashboards,
13 1. Information portfolios and data models,
14 1. Images, data dictionaries (translations, formats, connections, color palettes ...), etc.
15 1. Data sources: Data sources in the UserDocs user data directory can be saved.
16
17 First select the items you want to save. This creates a zip file which you must then restore to the new environment or the new version.
18
19 Please note that the files in the DigDash Enterprise installation directory are not saved or restored by our tool, so you must copy them manually if you have made any changes:
20
21 1. dashboard styles: if you have modified the dashboard styles from the dashboard.css file in the webapps / digdash_dashboard directory, this must be manually copied to the new environment.(((
22 (% class="box infomessage" %)
23 (((
24 Note: we recommend modifying the styles of the dashboard from the CSS editor of the dashboard. This creates a default.css file in the user data directory. This file can be saved and then restored by DigDash Enterprise.
25 )))
26 )))
27 1. images, logos and icons: if you have modified the files located in the webapps / digdash_dashboard / icons directory, you will have to copy them to re-apply them on your new version.
28
29 == Save data ==
30
31 [[Edit>>url:http://rack-lure:8585/bin/edit/Digdash_2019R2/deployment/configuration/backup_restore/WebHome?section=2]]
32
33 1. Display the home page:
34
35 Start the Internet browser of your choice, then type the URL http: ~/~/ ServerName: Server Port (example: [[http: ~~/~~/ localhost: 8080>>url:http://localhost:8080/]] ). The DigDash Enterprise home page appears.
36
37 1. Click on the **Configuration ** link then **Backup management** . Click on **Save ** to save your current configuration
38 1. In the login box, enter the user name and password
39 1. Check in each section the items you want to save: //See the definition of each item in the appendix// .
40 1. Click on **Generate** then on **Download the restoration file ** to obtain the backup file (.zip file)
41
42 (% class="box infomessage" %)
43 (((
44 Note: The backup format changed in November 2015 (version 2015B1124). If you want to save for a version before this date, check the **Generate for a version before 2015B1124** check box .
45 )))
46
47 == Restore data ==
48
49 [[Edit>>url:http://rack-lure:8585/bin/edit/Digdash_2019R2/deployment/configuration/backup_restore/WebHome?section=3]]
50
51 1. Display the home page:
52
53 Start the Internet browser of your choice, then type the URL http: ~/~/ ServerName: Server Port (example: [[http: ~~/~~/ localhost: 8080>>url:http://localhost:8080/]] ). The DigDash Enterprise home page appears.
54
55 1. Click on the **Configuration ** link then **Backup management** . Click **Restore ** to restore a configuration.
56 1. Click on **Browse ** to select the zip file corresponding to your backup then click on **Load**
57 1. The list of database connections present in the backup file is displayed so that you can update them if necessary.
58
59 __Migration of connections and document servers:__
60
61 In order to facilitate the migration of these elements, it is possible to modify their identifiers so that they are identical between the development and production servers.
62
63 During the first migration between a development server and a production server:
64
65 1. Perform a full backup of the development environment
66 1. Restore the backup to the production environment
67 1. Modify connection strings to databases and file servers on the production environment (from the connection manager and the document server manager in Enterprise Studio).
68
69 During the following migrations to production environments:
70
71 * Selectively backup data: data models, portfolios, modified or new dashboards, ...
72
73 Do not save the file containing the connections (dbcnxrepository.xml) as well as the file containing the document servers (serverurlrepository.xml) even if these contain modifications
74
75 1. Restore the backup to the production environment
76 1. If changes have been made to connections or file servers in the development environment, post them manually to the production environment.
77
78 For new connections or new document servers, report the identifier used on the development environment.
79
80 To report the connection identifier, open the connection managers ( **Tools** menu **\ database connections manager ** in Enterprise Studio). Edit the connection to modify then click on **Edit ** to modify the identifier:
81
82 To report the identifier of a document server, open the connection managers ( **Tools** menu **\ document servers manager ** in Enterprise Studio). Edit the document server to modify, then click **Edit ** to modify the identifier:
83
84 = AUTOMATION =
85
86 [[Edit>>url:http://rack-lure:8585/bin/edit/Digdash_2019R2/deployment/configuration/backup_restore/WebHome?section=4]]
87
88 You can automatically backup your environment. For this, DigDash Enterprise provides a backuptools.jar backup tool to run on the server.
89
90 This jar file is located in the <tomcat webapps> / ddenterpriseapi / WEB-INF / lib directory and must be used from this location (because it uses other jar files located in the same directory).
91
92 The options are:
93
94 1. -url server_url: DigDash Enterprise server URL (default [[http: ~~/~~/ localhost: 8080>>url:http://localhost:8080/]] )
95 1. -domain dd_domain: domain name of the DigDash Enterprise application (by default ddenterpriseapi)
96 1. -login user_login: DigDash Enterprise administrator login
97 1. -pass user_pass: DigDash Enterprise administrator password
98 -export or -backup: save the DigDash Enterprise configuration in a zip file
99 1. -import or -restore: restore the configuration of DigDash Enterprise from a zip file
100 1. -file zipfile: path of the backup file to restore
101 1. -ldap: backup or restore of the LDAP directory
102 1. -noldap: no backup or restore of the LDAP directory
103 1. -help: display help
104 1. -debug: display error messages
105
106
107 __Examples of use:__
108
109 java - jar backuptools . jar - admin login - admin pass - export - noldap
110 java - jar backuptools . jar - url http : ~/~/ localhost: 8080 -domain ddenterpriseapi -login admin -pass admin -export -ldap -file C: ~\~\ backup.zip
111 java - jar backuptools . jar - url http : ~/~/ localhost: 8080 -domain ddenterpriseapi -login admin -pass admin -import -ldap -file C: ~\~\ backup.zip
112
113 If you make a backup of your environment a backup file is created. This file has the name datedujour_backup.zip (for example 20141219_backup.zip if the backup was performed on December 19, 2014) and is located in the directory containing the DigDash Enterprise data (By default, **Application Data / Enterprise Server / <domain> / config** .)
114
115 DigDash Enterprise also provides a file “backup_export.bat” (interactive file with prompts) allowing you to save your environment:
116
117 1. This file is located in the DigDash Enterprise installation directory. When executing the file, you must indicate:
118 1. the URL of your server: by default, [[http: ~~/~~/ localhost: 8080>>url:http://localhost:8080/]]
119 1. the DigDash Enterprise domain: by default, ddenterpriseapi
120 1. user login: by default, admin
121 1. the user's password: by default, admin
122 1. whether or not to save the LDAP dictionary (users and roles): enter **y** to save and **n** not to save.
123
124 A backup file is created. This file has the name <datedujour> _backup.zip (for example 20130710_backup.zip if the backup was performed on July 10, 2013) and is located in a directory containing the DigDash Enterprise data. By default, **Application Data / Enterprise Server / <domain> / config** .
125
126 For example on Windows 7:
127
128 **C: \ Users \ <user> \ AppData \ Roaming \ Enterprise Server \ ddenterpriseapi \ config**
129
130 To restore a backup automatically, you can also use the backup_import.bat file. You must enter the same parameters as for backup_export (instead of indicating if you want to save the LDAP directory, indicate if you want to restore it). Also specify the name of the backup file (by default, it must be in the directory where the backup_import.bat file is included).
131
132 = APPENDIX - LIST OF ELEMENTS OF A BACKUP =
133
134 [[Edit>>url:http://rack-lure:8585/bin/edit/Digdash_2019R2/deployment/configuration/backup_restore/WebHome?section=5]]
135
136 Here is the list of elements that can be saved / restored as well as their description.
137
138 When the element corresponds to a file, it is located in the data directory of the DigDash domain. For example: <AppData> / Enterprise Server / ddenterpriseapi. The file paths mentioned below are relative to this directory.
139
140 |**Element**|**Description**
141 |(% colspan="2" %)(((
142 __Users__
143
144 Data relating to each user.
145 )))
146 |LDAP|User information stored in LDAP:(((
147 * User attributes (name, username, password, variables ...)
148 * User roles
149 * User permissions and permission groups
150 )))
151 |Wallets|(((
152 Information portfolio and user flow
153
154 File: /server/<user>/config/wallet.iwt
155 )))
156 |Dashboards|(((
157 User dashboards
158
159 File: /server/<user>/config/dashboard.xml
160 )))
161 |Data models|(((
162 User data models
163
164 File: /server/<user>/config/tabledatamodelrepository.xml
165 )))
166 |Passwords|(((
167 User passwords
168
169 File: /server/<user>/config/passwordrepository.xml
170 )))
171 |(% colspan="2" %)(((
172 __Roles__
173
174 Data relating to each role.
175 )))
176 |LDAP|Role information stored in LDAP:(((
177 * Role attributes (name, identifier)
178 * role users
179 )))
180 |Wallets|(((
181 Information portfolio and role flow
182
183 File: /config/wallet_<Id_Role>.xml
184 )))
185 |Dashboards|(((
186 Role dashboards
187
188 File: /config/dashboard_<Id_Role>.xml
189 )))
190 |Data models|(((
191 Role data models
192
193 File: /config/tabledatamodelrepository_<Id_Role>.xml
194 )))
195 |Passwords|(((
196 Role passwords
197
198 File: /config/passwordrepository_<Id_Role>.xml
199 )))
200 |(% colspan="2" %)(((
201 __Authorization groups__
202
203 Definition of authorization groups provided by DigDash or added by the user. Authorization groups are only stored in LDAP.
204 )))
205 |<Name of authorization group>|Definition of the authorization group:(((
206 * List of group unit authorizations
207 )))
208 |(% colspan="2" %)(((
209 __Server common files__
210
211 List of files common to all users and roles.
212 )))
213 |(% colspan="2" %)__Server common files / System files__
214 |serversettings.xml|(((
215 DigDash Enterprise server settings:
216
217 * HTTP proxy
218 * LDAP connection
219 * Scheduler parameters
220 * Performance settings
221 * And all the parameters of the server configuration page
222
223 File: /config/serversettings.xml
224
225 Recommendations: Do not carry this file between several different configurations
226 )))
227 |system.xml|(((
228 System information and certain hidden parameters described in the document [[**guide_avance_systeme**>>doc:Digdash.deployment.configuration.advanced_system_guide.WebHome]]
229
230 File: /config/system.xml
231
232 Recommendations: Do not carry this file between several different configurations
233 )))
234 |userssettings.xml|(((
235 User settings including the settings you have created.
236
237 File: /config/userssettings.xml
238 )))
239 |(% colspan="2" %)(((
240
241
242 __Server common files / Dictionaries__
243
244 Settings common to all users and roles. These files may or may not be present depending on the parameters used by the flows or the data models.
245 )))
246 |colortablerepository.xml|(((
247 Dictionary of color palettes
248
249 Scope: {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} configuration
250
251 File: /config/colortablerepository.xml
252 )))
253 |cssrepository.xml|(((
254 Dictionary of CSS styles
255
256 Scope: {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} configuration
257
258 File: /config/cssrepository.xml
259 )))
260 |clustersettings.xml|(((
261 Configuration of cluster mode (advanced)
262
263 Scope: System configuration
264
265 File: /config/clustersettings.xml
266 )))
267 |DDComments.h2.db|(((
268 Database of comments on dashboard data streams and models.
269
270 Scope: Display of dashboards and flows
271
272 File: /config/DDComments.h2.db
273 )))
274 |dbcnxrepository.xml|(((
275 Dictionary of database connections (advanced)
276
277 Scope: Configuration of data models (connections to data sources)
278
279 File: /config/dbcnxrepository.xml
280 )))
281 |favoritedevicesrepository.xml|(((
282 Dictionary of devices used for synchronizing flows
283
284 Scope: Export of flows
285
286 File: /config/favoritedevicesrepository.xml
287 )))
288 |flowsnapshotrepository.xml|(((
289 Dictionary of user views of flows used in BI self-service
290
291 Scope: Display of flows (editable in the dashboard)
292
293 File: /config/flowsnapshotrepository.xml
294 )))
295 |formatrepository.xml|(((
296 Dictionary of number and date formats
297
298 Scope: Configuration of data models and flows
299
300 File: /config/formatrepository.xml
301 )))
302 |jsfunctionrepository.xml|(((
303 Dictionary of javascript functions used in derived measurements, filters, source transformations…
304
305 Scope: Configuration of data models and flows
306
307 File: /config/jsfunctionrepository.xml
308 )))
309 |hierarchyrepository.xml|(((
310 Dictionary of shared hierarchies used by data model dimensions
311
312 Scope: Configuration of data models
313
314 File: /config/hierarchyrepository.xml
315 )))
316 |navigationsentencerepository.xml|(((
317 Dictionary of phrases created for video and text navigation of text streams
318
319 Scope: {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} configuration
320
321 File: /config/navigationsentencerepository.xml
322 )))
323 |passwordrepository.xml|(((
324 Dictionary of global passwords. (Deprecated)
325
326 File: /config/passwordrepository.xml
327 )))
328 |serverurlrepository.xml|(((
329 Dictionary of document servers used in DigDash Enterprise
330
331 Scope: Configuration of data models
332
333 File: /config/serverurlrepository.xml
334 )))
335 |vectoriconrepository.xml|(((
336 Dictionary of vector icons used by "Infographic" graphics
337
338 Scope: {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} configuration
339
340 File: /config/vectoriconrepository.xml
341 )))
342 |vizmodelrepository.xml|(((
343 Dictionary of shared presentation models associated with flows.
344
345 Scope: {{glossaryReference glossaryId="Glossary" entryId="Flux"}}Flow{{/glossaryReference}} configuration
346
347 File: /config/vizmodelrepository.xml
348 )))
349 |(% colspan="2" %)(((
350 __Server common files / Translation files__
351
352 Translation dictionaries group messages in different languages.
353
354 Each following translation file can be accompanied by a file corresponding to the chosen language. For example, the files **dm.properties, dm_fr.properties, dm_es.properties** are the translations of messages corresponding to the English language (default), French and Spanish.
355 )))
356 |dashboard.properties|(((
357 Dictionary of translations used in the elements specific to the dashboard:
358
359 * Name of pages
360 * Portlet name
361
362 File: /config/dashboard.properties
363
364 /config/dashboard_<lang>.properties
365 )))
366 |dm.properties|(((
367 Translation dictionaries used in data models and flows.
368
369 Scope: Display of data model elements and streams
370
371 Files: /config/dm.properties,
372
373 /config/dm_<lang>.properties
374 )))
375 |dmvoc.properties|(((
376 Dictionary of spoken values ​​for expressions of data models.
377
378 Scope: Export video stream (optional)
379
380 Files: /config/dmvoc.properties,
381
382 /config/dmvoc_<lang>.properties
383 )))
384 |dmtag.properties|(((
385 Dictionary of synonyms created in data models. These dictionaries are used by the search function of the dashboard: query in natural language.
386
387 Scope: Text search in the dashboard
388
389 Files: /config/dmtag.properties,
390
391 /config/dmtag_<lang>.properties
392 )))
393 |(((
394 <domain> .properties dashboard
395
396 //(Deprecated)//
397 )))|(((
398 Dictionary of dashboard elements (name of pages,…).
399
400 //These files are deprecated and do not have to be backed up / restored//
401 )))
402 |(% colspan="2" %)(((
403 __Server common files / Others__
404
405 Other files related to the configuration of dashboards.
406 )))
407 |(((
408 Pictures
409
410 (* .png, * .jpg, * .gif ...)
411 )))|(((
412 List of images added from the dashboard editor.
413
414 Folder: / config / web / public /, / config / web / public / <Id_Role> /, / config / web / public / <user> /
415 )))
416 |(((
417 Styles
418
419 default.css
420
421 ~* .css
422 )))|(((
423 Files containing the custom styles of the dashboard. CSS style sheets can be edited in the dashboard editing interface.
424
425 File: /config/web/public/default.css,
426
427 /config/web/public/*.css
428 )))
429 |js-const.js|(((
430 Constants of the DigDash Enterprise server (properties listed on the "Server configuration> Advanced" page, "Constants" section) + export parameters ("Export options" section)
431
432 File: /config/web/session/js-const.js,
433 )))
434 |js-default.js|(((
435 Dashboard custom script file. This file can be directly edited from the dashboard editing interface.
436
437 File: /config/web/session/js-default.js
438 )))
439 |(% colspan="2" %)(((
440 __Server common files / Data sources__
441
442 Data sources in the UserDocs file server. The files contained in this server can be integrated into the backup
443 )))