Wiki source code of Administration

Last modified by jhurst on 2021/04/21 10:01
Show last authors
1 Summary : 
2
3 {{toc/}}
4
5 (% style="text-align:center" %)
6 [[image:Digdash.deployment.configuration.configuration_guide.WebHome@configuration_guide_fr_html_772c33b9e2bfdfe5.gif]]
7
8 = DIGDASH ENTERPRISE ADMINISTRATION =
9
10 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_62ddc5caf470c20d.gif?rev=1.1||alt="configuration_guide_en_html_62ddc5caf470c20d.gif"]]
11
12 == Manage users ==
13
14 DigDash Enterprise lets you create users and assign them roles. Roles usually represent enterprise's functions (sales representative, sales manager, human resources manager,...).
15
16 You can create dashboards for users and roles. When connecting to the dashboard viewer, users can see their own dashboards as well as dashboards created for their roles.
17
18 To access users and roles management:
19
20 * Open DigDash Enterprise welcome page in your internet browser : [[__http:~~/~~/serverName/serverPort__>>url:http://servername/serverPort]][[ >>url:http://servername/serverPort]](example: [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]] .
21 * Click the **Configuration **link, then the **user management** link
22
23 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_9b500d9dfdca7872.jpg?rev=1.1||alt="configuration_guide_en_html_9b500d9dfdca7872.jpg"]]
24
25 * In the connection dialog box, enter the user name and password (by default admin/admin. The user must have the authorization //Manage users//.
26
27 === Manage roles ===
28
29 * __Create a role:__
30
31 Click the **New role **button and enter the role name. Click the **OK **button
32
33 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_3dd61936475bb342.jpg?rev=1.1||alt="configuration_guide_en_html_3dd61936475bb342.jpg"]]
34
35 * __Search for a role__:
36
37 Type the text you are searching for, then click the **Search** button** **(enter * or let the field empty to display all the roles).
38
39 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_5fc6901194e0bc33.jpg?rev=1.1||alt="configuration_guide_en_html_5fc6901194e0bc33.jpg"]]
40
41 * __Remove a role:__
42
43 Click the **Remove **icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_608b1249615f58e9.jpg?rev=1.1||alt="configuration_guide_en_html_608b1249615f58e9.jpg"]] besides the role you want to remove or check the roles you want to remove and then click the **Delete **button. Confirm the deletion by clicking the **Yes **button in the Question dialog box.
44
45 * __Edit a role:__
46
47 Click the **Edit** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_4fa64fdb0da67a3a.jpg?rev=1.1||alt="configuration_guide_en_html_4fa64fdb0da67a3a.jpg"]] besides the role and then enter the new role name. Press **OK**.
48
49 * __Show members of a role__:
50
51 Click the **Show members **link to display the list of users assigned to a role. The list of users is displayed in the Users section at the top left of the page.
52
53 === Manage users ===
54
55 Once you have created roles, you can create users and assign them roles and authorizations.
56
57 ==== Create a user: ====
58
59 * Click the **New user **button.
60 * Fill in the fields (fields marked with a * are mandatory)
61 ** **LDAP login (uid)**: login used to connect to DigDash Enterprise ➢ **common name (cn) **: LDAP common name.
62 ** **Password**: password used to connect to DigDash Enterprise.
63 ** **Display name**: name displayed when the user connects to the dashboard or the administration console.
64 ** **Mobile phone**: the mobile phone is used to send SMS (for example, a SMS can contain an alert on a flow result).
65 ** **Email**: the email is used to send information through email (for example, information flows)
66 ** **Email password**: password associated to the email account.
67 ** **Language**: the language is used to display DigDash enterprise user interface and translated meta data (flow names, dashboard names,...). If your license includes video, the language is also used when reading audio and video documents.
68 ** **Time zone**: enter the time zone of the user. The hour displayed on flow will take into account this time zone if it is different from the data source time zone
69 ** **User theme**: you can specify a specific theme for each user. DigDash Enterprise provides two themes: “DigDash” which is the default theme and Black Ninja (with a dark background).
70
71 To create a new theme for the dashboard, you must first create a CSS file:
72
73 **<DDE Install>/apache-tomcat/webapps/digdash_dashboard/**
74
75 **<theme>.css**
76
77 The CSS file must have the same name as the theme: for example, **Black Ninja.css**. The file must contain the CSS styles to apply to the dashboard items. You must then assign this theme to the user by typing the theme name in the **User theme **field. Finally, you must apply this theme to the chart visualization by selecting **User theme **in the drop down list (refer to the administration console guide for more information). The theme will be applied after the flow synchronization.
78
79 *
80 ** **User must change his password at next logon**: check this box if you want the user to change his password at first logon.
81 * Assign roles to the user: select the roles in the available roles list then click the add button [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_6298cfd09b0ee2b.jpg?rev=1.1||alt="configuration_guide_en_html_6298cfd09b0ee2b.jpg"]] to assign them to the user
82 * Configure user authorizations: assign authorizations to the user by selecting them in the following list:
83
84 :
85
86 |**Authorization**|**Description**
87 |View Dashboard|User can view personal dashboards.
88 |Edit Dashboard|User can edit personal dashboards.
89 |Edit Dashboard for a role|User can create and edit roles dashboards.
90 |Load wallet for a role|User can open roles wallets.
91 |Save wallet for a role|User can save roles wallets.
92 |Add flow|User can add flows to personal wallets.
93 |Add a role flow|User can add flows to roles wallets
94 |Refresh flow|User can refresh personal flow
95
96 :
97
98 |Refresh a role flow|User can refresh roles flows.
99 |Manage servers|User can configure servers parameters (DigDash Enterprise server, LDAP server,...)
100 |Manage users|User can manage users and roles.
101 |Manage license|User can manage DigDash Enterprise licenses (for example, add or remove user to the licence).
102 |Manage users contents|User can manage documents servers and add contents to these server.
103 |Scheduler|User can schedule refresh of wallets, flows and data sources.
104 |Edit data source for a role|User can edit roles data sources.
105 |Edit data source|User can edit personal data sources.
106 |Save as PDF|User can export charts displayed in dashboard as PDF file.
107 |Save as PPT|User can export charts displayed in dashboard as PPT file.
108 |Save as XLS|User can export charts displayed in dashboard as XLS file.
109 |Save as CSV|User can export charts displayed in dashboard as CSV file.
110 |Navigate into chart|User can modify filters set on charts (using the interactive filters bar displayed in the dashboard viewer).
111 |Send SMS|User can send a SMS
112 |Upload Document|User can upload document (from the document portlet in the dashboard viewer)
113 |Update Document|User can update document (from the document portlet in the dashboard viewer)
114 |Refresh datasource|User can refresh personal data source
115 |View comments|User can view comments set on flows or data models (from the dashboard viewer)
116 |Add comments to data model|User can add comments on data models (from the dashboard viewer)
117 |Remove data model comment|User can remove comments set on data models (from the dashboard viewer)
118 |Add comment to flow|User can add comments on flow ( from the dashboard viewer)
119 |Remove flow comment|User can remove comments on flow ( from the dashboard viewer)
120 |Ignore data model revision|User doesn't have to enter a comment each time he modifies a data model
121 |Customize dashboard|User can modify the dashboard CSS
122 | |(((
123 (menu **Edit CSS **in the dashboard editor)
124
125 User can save images for all users
126 )))
127 |Edit protected dashboard pages|User can edit protected dashboard pages (roles dashboard pages protected in the dashboard editor)
128 |Dashboard offline mode|User can save an offline version of the dashboard.
129 |Dashboard navigation menu|The selection menu is displayed in the dashboard (allowing the user to display the previous or next page or to display a registered state for the dashboard).
130
131 ==== Create authorization groups ====
132
133 Authorizations groups let you put several authorizations into one single group. It can be useful if you want to grant the same authorizations to several users: Instead of assigning each authorization one by one, you can create an authorizations group and assign it to the users.
134
135 Predefined authorizations groups are provided by DigDash Enterprise:
136
137 * **System administrator**: user has the required authorizations to manage servers, users, licenses and user contents
138 * **KPI designer**: user has the required authorizations to create Key Performance Indicator (add flow, refresh flow, create visualizations,...)
139 * **Data modeler**: user has the required authorizations to create data models (add flow, add and refresh data sources,...)
140 * **Supervisor**: user has the full access to all DigDash Enterprise features
141 * **Final user **: user has the required authorization do display and use a dashboard
142
143 (view dashboard, save a dashboard as PDF,...)
144
145 To create an authorization group, click the **New authorization group **button and select the authorizations in the available authorizations list. Enter the group name in **Authorization group name **field:
146
147 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_8ce4f26ea31ac2c0.jpg?rev=1.1||alt="configuration_guide_en_html_8ce4f26ea31ac2c0.jpg"]]
148
149 ==== Create user parameter ====
150
151 User parameter can be used to add specific information on users.
152
153 Example: you want to create a dashboard for sales representatives but only display sales for the regions in their responsibility:
154
155 * Create a user parameter named “region”.
156 * When creating user, a field “region” is displayed. Fill it up with the appropriate value.
157 * You can then use this parameter to filter the result of your flows using a condition like ”region equals to //${user.Region}”. (For more information on how to use variable, refer to the documentation “wallet_editor_guide_en.pdf”)//
158
159 ==== Search for a user ====
160
161 Type the text you are looking for, then click the **Search** button** **(enter * or let the field empty to display all the users).
162
163 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_682a0836c2647abd.jpg?rev=1.1||alt="configuration_guide_en_html_682a0836c2647abd.jpg"]]
164
165 ==== Remove a user ====
166
167 Click the **Remove** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_608b1249615f58e9.jpg?rev=1.1||alt="configuration_guide_en_html_608b1249615f58e9.jpg"]] besides the user or check the users you want to remove and then click the **Delete **button. Confirm the deletion by clicking the **Yes **button in the Question dialog box.
168
169 ==== Edit a user ====
170
171 Click the Edit icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_4fa64fdb0da67a3a.jpg?rev=1.1||alt="configuration_guide_en_html_4fa64fdb0da67a3a.jpg"]] besides the user, then enter the new parameters. Click **OK **to validate the changes.
172
173 ==== Apply a same action to several users ====
174
175 To apply the same action to several users, check the users then in the drop down list **Other actions **select the action you want to perform: assign an authorisationn, assign a role,...
176
177 == Manage user content ==
178
179 To manage user content:
180
181 * Open DigDash Enterprise welcome page in your internet browser : [[__http:~~/~~/serverName/serverPort__>>url:http://servername/serverPort]][[ >>url:http://servername/serverPort]](example: [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]].
182 * Click the **Configuration **link, then the **Document management** link.
183
184 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_9b500d9dfdca7872.jpg?rev=1.1||alt="configuration_guide_en_html_9b500d9dfdca7872.jpg"]]
185
186 * In the connection dialog box, enter the user name and password (by default admin/admin). The user must have the authorization //Manage user content//.
187
188 === Manage documents servers ===
189
190 List of available documents server is displayed at the bottom left of the page. DigDash Enterprise provides a subversion documents server called SVN.
191
192 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_2e24f4cea6a116b2.jpg?rev=1.1||alt="configuration_guide_en_html_2e24f4cea6a116b2.jpg"]]
193
194 To add a new documents server:
195
196 * click the **New server **button, then fill in the fields (fields marked up with a * are mandatory)
197 ** **Name**: Name of your documents server
198 ** **URL**: URL of your documents server. This address depends on your server type.
199
200 Examples:
201
202 * SubVersion : svn:~/~/localhost, svn:~/~/192.168.2.1/, svn : ~/~/29.37.12.12:8080/, svn:~/~/29.37.12.12/repo
203 * Samba : smb:~/~/192.168.1.1/documents
204 * FTP : 192.168.1.1
205 * File System : c:/documents
206 * WebDav : http:~/~/192.168.1.1/webdav/www
207
208 * **Server** **type**: SubVersion, Samba or Alfresco, FTP, File system or WebDav
209 * **User document path**: path of your documents.
210
211 Examples:
212
213 *
214 ** SubVersion : Documents/Users/${user.uid}/.*
215 ** other files servers: /.* (all the documents available on the server will be retrieved), doc/.* (all the documents available in the doc folder will be retrieved), ${user.uid}/.* (documents available in ${user.uid})
216 * **Login**: Login used to connect to the documents server ➢ **Password**: password used to connect to the documents server
217
218 * Test the server by clicking the **Test server **button.
219 * Click **Ok **to validate the documents server creation
220
221 === Manage documents ===
222
223 You can add documents to a documents server. These documents can be displayed in dashboards (by adding the “documents//” //widget) or can be used as data sources (excel files, Business Intelligence reports,...).
224
225 __To add a document:__
226
227 * Click the **New document **button
228 * If you use several documents server, select the appropriate documents server in the **Server **drop down list.
229 * Click the **Browse...** button, then select the file that you want to add. Document can be used by the user who added it to the documents server.
230 * Authorize users and roles to access the document:
231 ** Type the text you are searching for in the **search users** or **search roles **field, then click the **OK** button (enter * or let the field empty to display all users or roles). The users or roles list is displayed. Click the **Add a user **icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_c2f3d9757a951441.png?rev=1.1||alt="configuration_guide_en_html_c2f3d9757a951441.png"]] or **Add a role **icon[[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_a29d45e9ab927857.png?rev=1.1||alt="configuration_guide_en_html_a29d45e9ab927857.png"]] to authorize user or role to access the document.
232 ** Click the **OK **button.
233
234 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_3a78141780b237af.jpg?rev=1.1||alt="configuration_guide_en_html_3a78141780b237af.jpg"]]
235
236 __Search for a document:__
237
238 * If you use several documents servers, select the appropriate server in the drop down list.
239 * Type the text you are looking for, then click the **Search** button (enter * or let the field empty to display all the documents).
240 * The documents you are looking for are displayed. You can edit or download them.
241
242 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_41910988c4f62ea2.gif?rev=1.1||alt="configuration_guide_en_html_41910988c4f62ea2.gif"]]
243
244 __Remove a document:__
245
246 * Click the **Remove** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_608b1249615f58e9.jpg?rev=1.1||alt="configuration_guide_en_html_608b1249615f58e9.jpg"]] besides the document you want to remove. Confirm the deletion by clicking the **Yes **button in the Question dialog box.
247 * If you want to delete several documents at once, select them (by checking the box at their left) and then click the **Delete **button.
248
249 __Edit a document:__
250
251 Click the **Edit** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_4fa64fdb0da67a3a.jpg?rev=1.1||alt="configuration_guide_en_html_4fa64fdb0da67a3a.jpg"]] besides the document you want to edit and then enter the new document parameters. Click **OK**.
252
253 === Manage applications ===
254
255 You can add applications in documents servers so that users can get links to these applications from their dashboards (by adding the static content “Web Applications//”//**) **.
256
257 __To add an application:__
258
259 * Click the **New application **button
260 * If you use several documents server, select the appropriate documents server in the **Server **drop down list.
261 * Enter the name, URL and Description. You can add an icon by clicking the **Browse...** button and then selecting the appropriate image.
262 * Authorize users and roles to use the application:
263
264 ➢ Type the text you are looking for in the **search users** or **search roles **field, then click the **OK** button (enter * or let the field empty to display all users or roles). The users or roles list is displayed. Click the **Add a user **icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_c2f3d9757a951441.png?rev=1.1||alt="configuration_guide_en_html_c2f3d9757a951441.png"]] or **Add a role **icon[[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_a29d45e9ab927857.png?rev=1.1||alt="configuration_guide_en_html_a29d45e9ab927857.png"]] to authorize users or roles to access the application.
265
266 * Click the **OK **button.
267
268 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_1349b7f5340bea0e.jpg?rev=1.1||alt="configuration_guide_en_html_1349b7f5340bea0e.jpg"]]
269
270 __Search for an application:__
271
272 * If you use several documents server, select the appropriate server in the drop down list.
273 * Type the text you are searching for, then click the Search button (enter * or let the field empty to display all the documents).
274
275 __Remove an application__:
276
277 * Click the **Remove** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_608b1249615f58e9.jpg?rev=1.1||alt="configuration_guide_en_html_608b1249615f58e9.jpg"]] besides the application you want to remove. Confirm the deletion by clicking the **Yes **button in the Question dialog box.
278 * If you want to delete several applications at once, select them (by checking the box at their left) and then click the **Delete **button.
279
280 __Edit an application:__
281
282 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_70a62e33937491dd.jpg?rev=1.1||alt="configuration_guide_en_html_70a62e33937491dd.jpg"]]
283
284 * Click the **Edit** icon [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_4fa64fdb0da67a3a.jpg?rev=1.1||alt="configuration_guide_en_html_4fa64fdb0da67a3a.jpg"]] besides the application you want to edit and then enter the new application parameters. Click **OK **to validate your changes.
285
286 == Configure the license ==
287
288 To enter your license key or manage your license:
289
290 * Open DigDash Enterprise welcome page in your internet browser : [[__http:~~/~~/serverName/serverPort__>>url:http://servername/serverPort]][[ >>url:http://servername/serverPort]](example: [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]] :
291
292 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_9b500d9dfdca7872.jpg?rev=1.1||alt="configuration_guide_en_html_9b500d9dfdca7872.jpg"]]
293
294 * Click the **Configuration **link, then the **License** **management** link.
295 * In the connection dialog box, enter the user name and password(by default, admin/admin). The user must have the authorization //Manage licenses//
296
297 === Enter the license key ===
298
299 If this is the first time you are installing DigDash Enterprise or if your license has expired, you must enter the license key provided to you. This license key contains several information:
300
301 * the maximum number of authorized users,
302 * the expiration date: in case you have a trial license.
303
304 To enter your license key:
305
306 * Enter your license key in the field **Please specify a key to activate your product**.
307 * Click **Test**:**  **details on the license are displayed (maximum number of users, expiration date, text to speech,...). If the test fails, please verify you have correctly copied the license text from the license email. Do not include new line characters neither leading or trailing spaces.
308
309 By default, users who connect to DigDash Enterprise are automatically added to the license (if the number of users doesn't exceed the maximum of authorized users). You can modify this setting by un-checking the box **Auto add on first login**. You can also select the type of users you wan to add (named, concurrent, extranet or public).
310
311 * Click **Apply **to apply the license
312
313 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_b4c0789b1751825c.jpg?rev=1.1||alt="configuration_guide_en_html_b4c0789b1751825c.jpg"]]
314
315 === Add users to the license ===
316
317 * In the users section, type the name you are looking for or let the field blank to display all the users in your dictionary, then click **Search**.
318 * List of matching users is displayed.
319 * Check the users you want to add to the license and then click **Add to the license**.
320
321 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_caaaa55193906d67.jpg?rev=1.1||alt="configuration_guide_en_html_caaaa55193906d67.jpg"]]
322
323 * Users authorized to use DigDash enterprise are displayed in the **Users in license **section on the right. From this section, you can directly add a user in the license (user present in your users directory or not yet) or remove the authorization to a user by un-checking the box **allowed**.
324
325 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_a137114e4af2f239.jpg?rev=1.1||alt="configuration_guide_en_html_a137114e4af2f239.jpg"]]
326
327 * You can also get information on DigDash Enterprise login: first connection, last connection and login count
328
329 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_26a64086bcd53f07.jpg?rev=1.1||alt="configuration_guide_en_html_26a64086bcd53f07.jpg"]]
330
331 == Manage backups ==
332
333 You can backup then restore your DigDash Enterprise configuration.
334
335 To manage backups:
336
337 * Open DigDash Enterprise welcome page in your internet browser : [[__http:~~/~~/serverName/serverPort__>>url:http://servername/serverPort]][[ >>url:http://servername/serverPort]](example: [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]].
338 * Click the **Configuration **link, then the **Backup** **management** link. Click **Backup **or **Restore **depending on the action you want to perform.
339
340 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_9b500d9dfdca7872.jpg?rev=1.1||alt="configuration_guide_en_html_9b500d9dfdca7872.jpg"]]
341
342 * In the connection dialog box, enter the user name and password (the user must have the authorization //Manage servers//).
343
344 === Backup data ===
345
346 Select the items to backup. To do so, check the appropriate boxes.
347
348 In the example below, LDAP, wallets and Dashboards will be saved for user jsmith.
349
350 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_5dc5e0eff023f71a.jpg?rev=1.1||alt="configuration_guide_en_html_5dc5e0eff023f71a.jpg"]]
351
352 The boxes are grayed out if there is no item to backup (in the example above, there is no Data model and no password for the user jsmith).
353
354 If you want to select/un-select all items of a line or a column at once, click the row or the column header.
355
356 Once you have selected the items you want to backup, click the **Export **button, and then click the **download the backup file** link to get the backup zip file.
357
358 You can find below the description of the items you can backup by category: users, roles, authorization groups and server files.
359
360 __Users__:
361
362 :
363
364 |**Item**|**Description**
365 |LDAP|User information stored in LDAP
366 |Wallets|User wallet and flows
367 |Dashboards|User dashboards
368 |Data models|User data models
369 |Passwords|User passwords
370
371 __Roles__:
372
373 :
374
375 |**Item**|**Description**
376 |LDAP|Role information stored in LDAP
377 |Wallet|Role wallets and flows.
378 |Dashboard|Role dashboards
379 |Data models|Role data models
380 |password|Role passwords
381
382 __Authorization groups:__
383
384 Check the box on the same line as the authorization group you want to backup.
385
386 __Common server files__:
387
388 Files that you have modified are displayed in the list of common server files you can backup.
389
390 For example, if you have modified colors and formats, “colortablerepository.xml” and “formatrepository.xml” will be displayed in the list of files you can backup.
391
392 :
393
394 |**Item**|**Description**
395 |__System files:__|
396 |serversettings.xml|DigDash Enterprise Server parameters (proxy, LDAP,scheduler,...)
397 |system.xml|DigDash Enterprise system information
398 |Usersettings.xml|User settings information including user parameters you created.
399 |__Repository files:__|
400
401 :
402
403 |colortablerepository.xml|Color palettes repository
404 |cssrepository.xml|CSS repository
405 |clustersettings.xml|Cluster settings
406 |commentsrepository.xml|Comments repository (comments added in the dashboard on data models and flows)
407 |favoritedevicesrepository.xml|Favorite devices used for synchronization
408 |formatrepository.xml|Formats repository
409 |jsfunctionrepository.xml|Java scripts functions repository
410 |Hierarchyrepository.xml|Repository of shared hierarchy
411 |navigationsentencerepository.xml|Repository of sentences created for text document and video
412 |serverurlrepository.xml|Documents servers repository
413 |__Translation files:__|
414 |(((
415 dm.properties
416
417 + dm_language.properties
418 )))|(((
419 Repository of data models items (dimensions names, hierarchies names,...).
420
421 Translation are available in files dm_language.properties
422
423 (example:dm_en.properties for the english version).
424 )))
425 |dmvoc.properties|Repository of data models items used for video and audio documents.
426 |dmtag.properties|Synonymous created for data models items (synonymous are used in Query text).
427 |dashboarddomain.properties|Repository of dashboards items (page names,...).
428 |__Other files:__|
429 |images|(((
430 List of images used in DigDash
431
432 Enterprise (added from the dashboard editor)
433 )))
434 |Default.css|File containing personalized styles of the dashboard
435 |Js-const.js|Constants of DigDash Enterprise Server (properties modified from the «Server settings>Advanced» page, section « Constants » ) + export settings
436
437 === Restoring data ===
438
439 * To restore data, select the backup file,and then click **Upload**
440
441 [[image:https://doc.digdash.com/xwiki/bin/download/Digdash/deployment/configuration/configuration_guide/WebHome/configuration_guide_en_html_3a8eb8d4e086279a.jpg?rev=1.1||alt="configuration_guide_en_html_3a8eb8d4e086279a.jpg"]]
442
443 * select the items you want to restore (see the description of the items above in the backup section). By default, all boxes are checked meaning that everything you have saved will be restored.
444 * If you want to modify database connections, click the **advanced **link at the bottom of the page and then update the connections in the **database configuration **section.
445
446 === Saving and restoring data automatically ===
447
448 __Backuping data automatically:__
449
450 You can automatically backup your data using the backup tool « backuptools.jar » provided with DigDash Enterprise.
451
452 This file is located in the <tomcat webapps>/ddenterpriseapi/WEB-INF/lib directory and must be used from this place (as it uses other jar files located in the same folder)
453
454 You can use available options:
455
456 * -url server_url: DigDash Enterprise server URL (by default [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]]
457 * -domain dd_domain: domain name of the DigDash Enterprise domain (by default ddenterpriseapi)
458 * -login user_login: DigDash Enterprise administrator login name
459 * -pass user_pass: DigDash Enterprise password
460 * -export or -backup: save DigDash Enterprise configuration in a zip file
461 * -import ou -restore: restore DigDash Enterprise configuration from a zip file
462 * -file zipfile: path of the backup file to restore
463 * -ldap: save or restore LDAP directory
464 * -noldap: no save or restore of LDAP directory
465 * -help: display help
466 * -debug: display error messages
467
468 __Usage examples:__
469
470 java -jar backuptools.jar -login admin -pass admin -export -noldap
471
472 java -jar backuptools.jar -url [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[ >>url:http://localhost:8080/]]-domain ddenterpriseapi -login admin -pass admin -export -ldap -file C:~\~\backup.zip
473
474 java -jar backuptools.jar -url [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[ >>url:http://localhost:8080/]]-domain ddenterpriseapi -login admin -pass admin -import -ldap -file C:~\~\backup.zip
475
476 if you export your environment, a backup file is created. This file is called currentdate_backup.zip (for example, 20141219_backup.zip if the backup has been done on December 19 2014) and is located in the folder containing DigDash Enterprise data. By default, **Application Data/Enterprise Server/<domain>/config**.
477
478 For example on Windows 7 this folder is:
479
480 **C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config**.
481
482 You can also backup DigDash Enterprise environment using the batch file « backup_export.bat » provided with digDash enterprise (in the installation folder of DigDash Enterprise).
483
484 When you run the file, you must indicate:
485
486 * The server URL: for example [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]]
487 * the server domain: for example ddenterpriseapi
488 * The user login: for example, admin
489 * The user password: for example, admin
490 * Whether you want to save the LDAP directory (users and roles) or not: enter **y **to save it and **n **if you don't.
491
492 A backup file is created. This file is called currentdate_backup.zip (for example, 20130710_backup.zip if the backup has been done on July 10 2013) and is located in the folder containing DigDash Enterprise data. By default, **Application Data/Enterprise Server/<domain>/config**.
493
494 For example on Windows 7 this folder is:
495
496 **C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config**.
497
498 __Restoring a backup automatically:__
499
500 To restore a backup automatically, run backup_import.bat located in your installation folder. You must provide the same information as in the backup process: server URL, server domain, login, pass and whether you want to restore the LDAP directory or not.
501
502 You also need to enter the backup file name (the file must be located in the same folder as backup_import.bat).