Wiki source code of Sauvegarde et restauration

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