Wiki source code of Guide de configuration
Last modified by jhurst on 2021/04/21 10:01
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{ddtoc/}} | ||
| 2 | |||
| 3 | = DIGDASH ENTERPRISE CONFIGURATION = | ||
| 4 | |||
| 5 | [[image:configuration_guide_en_html_62ddc5caf470c20d.gif]] | ||
| 6 | |||
| 7 | To configure DigDash Enterprise servers (DigDash server,LDAP server, proxy, …): | ||
| 8 | |||
| 9 | * 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/]] : | ||
| 10 | |||
| 11 | [[image:configuration_guide_en_html_9b500d9dfdca7872.jpg]] | ||
| 12 | |||
| 13 | * Click the **Configuration **link, then the **server settings** link. | ||
| 14 | * In the connection dialog box, enter the user name and password (the user must have the authorization //Manage servers//). | ||
| 15 | |||
| 16 | == Modify DigDash Enterprise supervisor == | ||
| 17 | |||
| 18 | In the **Enterprise Server **section, you can modify the supervisor of DigDash Enterprise. The supervisor can access all modules of DigDash Enterprise. If the LDAP server is down, the supervisor is the only user who can access DigDash Enterprise. By default, DigDash Enterprise creates a supervisor whose user name and password are admin/admin. | ||
| 19 | |||
| 20 | [[image:configuration_guide_en_html_f073572b7b31a0d5.jpg]] | ||
| 21 | |||
| 22 | == Configure the proxy == | ||
| 23 | |||
| 24 | Enter your proxy parameters under **Proxy settings**: | ||
| 25 | |||
| 26 | * If you don't use a proxy, select **Direct** **Connection.** | ||
| 27 | * If you use a proxy: | ||
| 28 | ** Select **Manual Settings** to enter the proxy parameters yourself (URL, Port, users and password ) | ||
| 29 | ** Select **Use IE proxy settings **to use your Internet browser parameters. | ||
| 30 | ** If you want to use a proxy auto config (PAC) file, select **Address of the automatic proxy configuration script **and then enter the address of the .pac file in the field **Address of the automatic proxy configuration script**. | ||
| 31 | ** If the proxy uses NTLM authentication, check the box. | ||
| 32 | * Click the **Validate button.** | ||
| 33 | |||
| 34 | [[image:configuration_guide_en_html_ccc779c9e9fd4ad9.jpg]] | ||
| 35 | |||
| 36 | == Configure the LDAP server == | ||
| 37 | |||
| 38 | In the **LDAP** server section, enter your LDAP server parameters. You can connect to an existing LDAP or Active Directory server or use the one provided by DigDash Enterprise: | ||
| 39 | |||
| 40 | * Enter the **LDAP server URL** | ||
| 41 | * In the **Port **field, enter the TCP port of the connection. The default port number is 389. | ||
| 42 | * Enter the **Administrator login **field. By default, the field contains the login used | ||
| 43 | |||
| 44 | to connect to the Apache Directory Studio provided with DigDash Enterprise. | ||
| 45 | |||
| 46 | * Enter the **connection **timeout in milliseconds | ||
| 47 | * The **DigDash** **reserved attribute **is an LDAP field used to store DigDash | ||
| 48 | |||
| 49 | Enterprise data (user email, password,...). This field must be available on your LDAP server but shouldn't be used (by default, DigDash Enterprise uses the | ||
| 50 | |||
| 51 | //Description// field) . | ||
| 52 | |||
| 53 | * Check **Ignore sub trees for user login **if you don't want to explore users sub trees at login | ||
| 54 | * Check **One level search **to only search elements at the first level and not in all the sub trees | ||
| 55 | * To visualize and modify LDAP queries, click the link **LDAP queries** | ||
| 56 | * You can test your server by clicking the **Test **button | ||
| 57 | * Click the **Validate button **to validate your changes | ||
| 58 | |||
| 59 | [[image:configuration_guide_en_html_a84b7b9ea06a584c.jpg]] | ||
| 60 | |||
| 61 | == configure the authentication LDAP == | ||
| 62 | |||
| 63 | If you want to use an external LDAP for authentication: | ||
| 64 | |||
| 65 | * Click the **Advanced **link | ||
| 66 | * In the **Authentication LDAP **section, check **Use an external authentication** | ||
| 67 | |||
| 68 | **LDAP** | ||
| 69 | |||
| 70 | * Enter parameters of the LDAP server used for users authentication | ||
| 71 | * Click **Test **to test the LDAP server then **Validate **to save your changes. | ||
| 72 | |||
| 73 | Open the users management page to import users from this authentication LDAP: | ||
| 74 | |||
| 75 | In the **Authentication LDAP users **section** **(which appears only if you use an external authentication LDAP): | ||
| 76 | |||
| 77 | * Type the name of the users you are looking for (or let the field blank to display all users), then click **Search** | ||
| 78 | * Select the users you want to import, then click **Import users** | ||
| 79 | |||
| 80 | [[image:configuration_guide_en_html_1726a7207ecdb6c5.jpg]] | ||
| 81 | |||
| 82 | == Modify the scheduler parameters == | ||
| 83 | |||
| 84 | In the server settings page, click the **Advanced **link to display the schedule parameters. In the **Schedule **section, you can modify schedule parameters: | ||
| 85 | |||
| 86 | * Enter the **scheduler name** | ||
| 87 | * Enter the **scheduler password** | ||
| 88 | * Enter your scheduler server URL in the **server URL **field. | ||
| 89 | * Enter the frequency with which the scheduler will check tasks to be executed in the **Scheduler polling **field (by default, the check is done every minute) | ||
| 90 | * Click the **Test **button to check your settings | ||
| 91 | * Click **Validate **to save your changes. | ||
| 92 | |||
| 93 | [[image:configuration_guide_en_html_73e7a4bc84bab532.jpg]] | ||
| 94 | |||
| 95 | == Configure the SMS service == | ||
| 96 | |||
| 97 | In the server settings page, click the **Advanced **link to display the SMS service parameters. | ||
| 98 | |||
| 99 | In the SMS service configuration, set the SMS service parameters (SMS can be used to send alerts on flow results for example) : | ||
| 100 | |||
| 101 | * Enter the **Service URL**. This URL must include %user%, %pass and % msg% parameters. ~(%user% and %pass% are the name and passwords used to connect to the SMS service, %msg% is the message that will be sent). | ||
| 102 | * In the **Login **field, enter the name of the user that will be used to connect to the SMS service. | ||
| 103 | * In the **Password** field, enter the password of the user that will be used to connect to the SMS service. | ||
| 104 | * Click the **Validate **button to save your changes | ||
| 105 | |||
| 106 | [[image:configuration_guide_en_html_459b88355a7285ef.jpg]] | ||
| 107 | |||
| 108 | == Configure the document search server == | ||
| 109 | |||
| 110 | Enter the server URL in the **Server URL **field in the section **Document search server** | ||
| 111 | |||
| 112 | == Configure available languages == | ||
| 113 | |||
| 114 | In the server settings page, click the **Advanced **link to display the languages settings. | ||
| 115 | |||
| 116 | If you want to use other languages than English, select these languages in the **Available languages **list then add them to the** selected languages list** by clicking the add icon [[image:configuration_guide_en_html_afebbb689099fa76.jpg]] . | ||
| 117 | |||
| 118 | These languages can be used to define user languages and translate DigDash Enterprise meta data (dashboard pages, dimension names, measure names, flow names,... ) . | ||
| 119 | |||
| 120 | [[image:configuration_guide_en_html_204a9144f2495f7a.jpg]] | ||
| 121 | |||
| 122 | == Modify server constants == | ||
| 123 | |||
| 124 | DigDash Enterprise stores cubes on the client or server depending on the size of the cube and the browser used. | ||
| 125 | |||
| 126 | You can modify parameters of client and server cubes in the **CONSTANTS **section. | ||
| 127 | |||
| 128 | * **LARGE_ROW_LIMITE**: limit between client and server cubes for Firefox, Chrome, Opera and Safari. If the number of lines of your cube is lower than LARGE_ROW_LIMIT, the cube will be stored on the client, else, executed on the server. | ||
| 129 | * **SMALL_ROW_LIMIT**: limit between client and server cubes for Internet explorer. If the number of lines of your cube is lower than SMALL_ROW_LIMIT, the cube will be stored on the client, else, executed on the server. | ||
| 130 | * **MOBILE_ROW_LIMIT**: limit between client and server cubes for mobiles . If the number of lines of your cube is lower than MOBILE_ROW_LIMIT, the cube will be stored on the client, else, executed on the server. | ||
| 131 | * **DIM_MAX_MEMBERS**: maximum number of members that can be loaded on a client cube. If the number of members is greater than DIM_MAX_MEMBERS, they are loaded by the server cube. | ||
| 132 | |||
| 133 | The following constants are used by interactive filters boxes displayed in the dashboard viewer: | ||
| 134 | |||
| 135 | * **LIMITSEARCHBOX**: defines whether filters displayed in the dashboard interactive filters bar are drop-down lists or search boxes. LIMITSEARCHBOX is the maximum number of items that can be displayed in drop-down lists. If the number of items is greater than LIMITSEARCHBOX, they are displayed as a search box. By default, LIMITSEARCHBOX is 50. | ||
| 136 | |||
| 137 | In the example below, the dimension “Product” has more than 50 items and is displayed as a search box: user must type the text he is looking for in the search field. “Product Family” and “Date” have less than 50 elements and are displayed as drop-down lists. | ||
| 138 | |||
| 139 | [[image:configuration_guide_en_html_466ea4746e727e77.jpg]] | ||
| 140 | |||
| 141 | * **LIMITINDEXATION**: If the dimension filter box is displayed as a search box, this limit defines whether the indexation is done on the browser (number of items lower than LIMITINDEXATION) or on the server. | ||
| 142 | * **LIMIT_RESULT_SEARCH_BOX**: defines the maximum number of items displayed in a search box. If the number of items to display is greater than LIMIT_RESULT_SEARCH_BOX, clicking the + sign allows you to display the following items. | ||
| 143 | |||
| 144 | In the example above, LIMIT_RESULT_SEARCH_BOX is 10. Typing the letter c in the “Product” search box returns more than 10 items. Only the first 10 items are displayed. To display the next ones, the user must click the + button. | ||
| 145 | |||
| 146 | * **PREVIEW_LIMIT_ROW** : limit defining the maximum number of lines displayed in dashboard editor (allow better performances in case of large volume of data) | ||
| 147 | |||
| 148 | == Modify export settings == | ||
| 149 | |||
| 150 | You can export flows as PPT, PDF, CSV or XLS files. Default settings are defined for export. You can modify some of them as described below. | ||
| 151 | |||
| 152 | [[image:configuration_guide_en_html_b18e74fc8a9cce3c.png]] | ||
| 153 | |||
| 154 | __Modifying PDF export settings:__ | ||
| 155 | |||
| 156 | * Show title in the header of PDF: displays the flow name in the header of the PDF file | ||
| 157 | * Show page number in footer of PDF | ||
| 158 | * Positioning filters summary: by default, list of filters applied on the flow is not displayed in the PDF. If you want to display it, choose the position of the summary in the drop-down list: **Before** or **After**. | ||
| 159 | * Select the page format: select the appropriate format in the drop-down list: A4 portrait, A4 landscape, US Letter Portrait, US Letter Landscape | ||
| 160 | |||
| 161 | __Modifying PPT export settings:__ | ||
| 162 | |||
| 163 | * Show title in header of PPT: displays the flow name in the header of the PPT file. | ||
| 164 | * Positioning filters summary: by default, list of filters applied on the flow is not displayed in the pdf. If you want to display it, choose the position of the summary in the drop-down list: **Before** or **After**. | ||
| 165 | |||
| 166 | __Modifying CSV export settings__: | ||
| 167 | |||
| 168 | * CSV export separator: specify the character used as column separator in CSV | ||
| 169 | |||
| 170 | export (by default:';') | ||
| 171 | |||
| 172 | * CSV export encoding: specify character encoding in CSV | ||
| 173 | * CSV export decimal separator; specify the character used as decimal separator in CSV export | ||
| 174 | |||
| 175 | = DIGDASH ENTERPRISE ADMINISTRATION = | ||
| 176 | |||
| 177 | [[image:configuration_guide_en_html_62ddc5caf470c20d.gif]] | ||
| 178 | |||
| 179 | == Manage users == | ||
| 180 | |||
| 181 | DigDash Enterprise lets you create users and assign them roles. Roles usually represent enterprise's functions (sales representative, sales manager, human resources manager,...). | ||
| 182 | |||
| 183 | 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. | ||
| 184 | |||
| 185 | To access users and roles management: | ||
| 186 | |||
| 187 | * 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/]] . | ||
| 188 | * Click the **Configuration **link, then the **user management** link | ||
| 189 | |||
| 190 | [[image:configuration_guide_en_html_9b500d9dfdca7872.jpg]] | ||
| 191 | |||
| 192 | * In the connection dialog box, enter the user name and password (by default admin/admin. The user must have the authorization //Manage users//. | ||
| 193 | |||
| 194 | === Manage roles === | ||
| 195 | |||
| 196 | * __Create a role:__ | ||
| 197 | |||
| 198 | Click the **New role **button and enter the role name. Click the **OK **button | ||
| 199 | |||
| 200 | [[image:configuration_guide_en_html_3dd61936475bb342.jpg]] | ||
| 201 | |||
| 202 | * __Search for a role__: | ||
| 203 | |||
| 204 | Type the text you are searching for, then click the **Search** button** **(enter * or let the field empty to display all the roles). | ||
| 205 | |||
| 206 | [[image:configuration_guide_en_html_5fc6901194e0bc33.jpg]] | ||
| 207 | |||
| 208 | * __Remove a role:__ | ||
| 209 | |||
| 210 | Click the **Remove **icon [[image: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. | ||
| 211 | |||
| 212 | * __Edit a role:__ | ||
| 213 | |||
| 214 | Click the **Edit** icon [[image:configuration_guide_en_html_4fa64fdb0da67a3a.jpg]] besides the role and then enter the new role name. Press **OK**. | ||
| 215 | |||
| 216 | * __Show members of a role__: | ||
| 217 | |||
| 218 | 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. | ||
| 219 | |||
| 220 | === Manage users === | ||
| 221 | |||
| 222 | Once you have created roles, you can create users and assign them roles and authorizations. | ||
| 223 | |||
| 224 | ==== Create a user: ==== | ||
| 225 | |||
| 226 | * Click the **New user **button. | ||
| 227 | * Fill in the fields (fields marked with a * are mandatory) | ||
| 228 | ** **LDAP login (uid)**: login used to connect to DigDash Enterprise ➢ **common name (cn) **: LDAP common name. | ||
| 229 | ** **Password**: password used to connect to DigDash Enterprise. | ||
| 230 | ** **Display name**: name displayed when the user connects to the dashboard or the administration console. | ||
| 231 | ** **Mobile phone**: the mobile phone is used to send SMS (for example, a SMS can contain an alert on a flow result). | ||
| 232 | ** **Email**: the email is used to send information through email (for example, information flows) | ||
| 233 | ** **Email password**: password associated to the email account. | ||
| 234 | ** **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. | ||
| 235 | ** **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 | ||
| 236 | ** **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). | ||
| 237 | |||
| 238 | To create a new theme for the dashboard, you must first create a CSS file: | ||
| 239 | |||
| 240 | **<DDE Install>/apache-tomcat/webapps/digdash_dashboard/** | ||
| 241 | |||
| 242 | **<theme>.css** | ||
| 243 | |||
| 244 | 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. | ||
| 245 | |||
| 246 | * | ||
| 247 | ** **User must change his password at next logon**: check this box if you want the user to change his password at first logon. | ||
| 248 | * Assign roles to the user: select the roles in the available roles list then click the add button [[image:configuration_guide_en_html_6298cfd09b0ee2b.jpg]] to assign them to the user | ||
| 249 | * Configure user authorizations: assign authorizations to the user by selecting them in the following list: | ||
| 250 | |||
| 251 | : | ||
| 252 | |||
| 253 | ((( | ||
| 254 | |**Authorization**|**Description** | ||
| 255 | |View Dashboard|User can view personal dashboards. | ||
| 256 | |Edit Dashboard|User can edit personal dashboards. | ||
| 257 | |Edit Dashboard for a role|User can create and edit roles dashboards. | ||
| 258 | |Load wallet for a role|User can open roles wallets. | ||
| 259 | |Save wallet for a role|User can save roles wallets. | ||
| 260 | |Add flow|User can add flows to personal wallets. | ||
| 261 | |Add a role flow|User can add flows to roles wallets | ||
| 262 | |Refresh flow|User can refresh personal flow | ||
| 263 | ))) | ||
| 264 | |||
| 265 | : | ||
| 266 | |||
| 267 | ((( | ||
| 268 | |Refresh a role flow|User can refresh roles flows. | ||
| 269 | |Manage servers|User can configure servers parameters (DigDash Enterprise server, LDAP server,...) | ||
| 270 | |Manage users|User can manage users and roles. | ||
| 271 | |Manage license|User can manage DigDash Enterprise licenses (for example, add or remove user to the licence). | ||
| 272 | |Manage users contents|User can manage documents servers and add contents to these server. | ||
| 273 | |Scheduler|User can schedule refresh of wallets, flows and data sources. | ||
| 274 | |Edit data source for a role|User can edit roles data sources. | ||
| 275 | |Edit data source|User can edit personal data sources. | ||
| 276 | |Save as PDF|User can export charts displayed in dashboard as PDF file. | ||
| 277 | |Save as PPT|User can export charts displayed in dashboard as PPT file. | ||
| 278 | |Save as XLS|User can export charts displayed in dashboard as XLS file. | ||
| 279 | |Save as CSV|User can export charts displayed in dashboard as CSV file. | ||
| 280 | |Navigate into chart|User can modify filters set on charts (using the interactive filters bar displayed in the dashboard viewer). | ||
| 281 | |Send SMS|User can send a SMS | ||
| 282 | |Upload Document|User can upload document (from the document portlet in the dashboard viewer) | ||
| 283 | |Update Document|User can update document (from the document portlet in the dashboard viewer) | ||
| 284 | |Refresh datasource|User can refresh personal data source | ||
| 285 | |View comments|User can view comments set on flows or data models (from the dashboard viewer) | ||
| 286 | |Add comments to data model|User can add comments on data models (from the dashboard viewer) | ||
| 287 | |Remove data model comment|User can remove comments set on data models (from the dashboard viewer) | ||
| 288 | |Add comment to flow|User can add comments on flow ( from the dashboard viewer) | ||
| 289 | |Remove flow comment|User can remove comments on flow ( from the dashboard viewer) | ||
| 290 | |Ignore data model revision|User doesn't have to enter a comment each time he modifies a data model | ||
| 291 | |Customize dashboard|User can modify the dashboard CSS | ||
| 292 | | |((( | ||
| 293 | (menu **Edit CSS **in the dashboard editor) | ||
| 294 | |||
| 295 | User can save images for all users | ||
| 296 | ))) | ||
| 297 | |Edit protected dashboard pages|User can edit protected dashboard pages (roles dashboard pages protected in the dashboard editor) | ||
| 298 | |Dashboard offline mode|User can save an offline version of the dashboard. | ||
| 299 | |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). | ||
| 300 | ))) | ||
| 301 | |||
| 302 | ==== Create authorization groups ==== | ||
| 303 | |||
| 304 | 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. | ||
| 305 | |||
| 306 | Predefined authorizations groups are provided by DigDash Enterprise: | ||
| 307 | |||
| 308 | * **System administrator**: user has the required authorizations to manage servers, users, licenses and user contents | ||
| 309 | * **KPI designer**: user has the required authorizations to create Key Performance Indicator (add flow, refresh flow, create visualizations,...) | ||
| 310 | * **Data modeler**: user has the required authorizations to create data models (add flow, add and refresh data sources,...) | ||
| 311 | * **Supervisor**: user has the full access to all DigDash Enterprise features | ||
| 312 | * **Final user **: user has the required authorization do display and use a dashboard | ||
| 313 | |||
| 314 | (view dashboard, save a dashboard as PDF,...) | ||
| 315 | |||
| 316 | 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: | ||
| 317 | |||
| 318 | [[image:configuration_guide_en_html_8ce4f26ea31ac2c0.jpg]] | ||
| 319 | |||
| 320 | ==== Create user parameter ==== | ||
| 321 | |||
| 322 | User parameter can be used to add specific information on users. | ||
| 323 | |||
| 324 | Example: you want to create a dashboard for sales representatives but only display sales for the regions in their responsibility: | ||
| 325 | |||
| 326 | * Create a user parameter named “region”. | ||
| 327 | * When creating user, a field “region” is displayed. Fill it up with the appropriate value. | ||
| 328 | * 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”)// | ||
| 329 | |||
| 330 | ==== Search for a user ==== | ||
| 331 | |||
| 332 | Type the text you are looking for, then click the **Search** button** **(enter * or let the field empty to display all the users). | ||
| 333 | |||
| 334 | [[image:configuration_guide_en_html_682a0836c2647abd.jpg]] | ||
| 335 | |||
| 336 | ==== Remove a user ==== | ||
| 337 | |||
| 338 | Click the **Remove** icon [[image: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. | ||
| 339 | |||
| 340 | ==== Edit a user ==== | ||
| 341 | |||
| 342 | Click the Edit icon [[image:configuration_guide_en_html_4fa64fdb0da67a3a.jpg]] besides the user, then enter the new parameters. Click **OK **to validate the changes. | ||
| 343 | |||
| 344 | ==== Apply a same action to several users ==== | ||
| 345 | |||
| 346 | 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,... | ||
| 347 | |||
| 348 | == Manage user content == | ||
| 349 | |||
| 350 | To manage user content: | ||
| 351 | |||
| 352 | * 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/]]. | ||
| 353 | * Click the **Configuration **link, then the **Document management** link. | ||
| 354 | |||
| 355 | [[image:configuration_guide_en_html_9b500d9dfdca7872.jpg]] | ||
| 356 | |||
| 357 | * In the connection dialog box, enter the user name and password (by default admin/admin). The user must have the authorization //Manage user content//. | ||
| 358 | |||
| 359 | === Manage documents servers === | ||
| 360 | |||
| 361 | List of available documents server is displayed at the bottom left of the page. DigDash Enterprise provides a subversion documents server called SVN. | ||
| 362 | |||
| 363 | [[image:configuration_guide_en_html_2e24f4cea6a116b2.jpg]] | ||
| 364 | |||
| 365 | To add a new documents server: | ||
| 366 | |||
| 367 | * click the **New server **button, then fill in the fields (fields marked up with a * are mandatory) | ||
| 368 | ** **Name**: Name of your documents server | ||
| 369 | ** **URL**: URL of your documents server. This address depends on your server type. | ||
| 370 | |||
| 371 | Examples: | ||
| 372 | |||
| 373 | * SubVersion : svn:~/~/localhost, svn:~/~/192.168.2.1/, svn : ~/~/29.37.12.12:8080/, svn:~/~/29.37.12.12/repo | ||
| 374 | * Samba : smb:~/~/192.168.1.1/documents | ||
| 375 | * FTP : 192.168.1.1 | ||
| 376 | * File System : c:/documents | ||
| 377 | * WebDav : http:~/~/192.168.1.1/webdav/www | ||
| 378 | |||
| 379 | * **Server** **type**: SubVersion, Samba or Alfresco, FTP, File system or WebDav | ||
| 380 | * **User document path**: path of your documents. | ||
| 381 | |||
| 382 | Examples: | ||
| 383 | |||
| 384 | * | ||
| 385 | ** SubVersion : Documents/Users/${user.uid}/.* | ||
| 386 | ** 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}) | ||
| 387 | * **Login**: Login used to connect to the documents server ➢ **Password**: password used to connect to the documents server | ||
| 388 | |||
| 389 | * Test the server by clicking the **Test server **button. | ||
| 390 | * Click **Ok **to validate the documents server creation | ||
| 391 | |||
| 392 | === Manage documents === | ||
| 393 | |||
| 394 | 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,...). | ||
| 395 | |||
| 396 | __To add a document:__ | ||
| 397 | |||
| 398 | * Click the **New document **button | ||
| 399 | * If you use several documents server, select the appropriate documents server in the **Server **drop down list. | ||
| 400 | * 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. | ||
| 401 | * Authorize users and roles to access the document: | ||
| 402 | ** 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:configuration_guide_en_html_c2f3d9757a951441.png]] or **Add a role **icon[[image:configuration_guide_en_html_a29d45e9ab927857.png]] to authorize user or role to access the document. | ||
| 403 | ** Click the **OK **button. | ||
| 404 | |||
| 405 | [[image:configuration_guide_en_html_3a78141780b237af.jpg]] | ||
| 406 | |||
| 407 | __Search for a document:__ | ||
| 408 | |||
| 409 | * If you use several documents servers, select the appropriate server in the drop down list. | ||
| 410 | * Type the text you are looking for, then click the **Search** button (enter * or let the field empty to display all the documents). | ||
| 411 | * The documents you are looking for are displayed. You can edit or download them. | ||
| 412 | |||
| 413 | [[image:configuration_guide_en_html_41910988c4f62ea2.gif]] | ||
| 414 | |||
| 415 | __Remove a document:__ | ||
| 416 | |||
| 417 | * Click the **Remove** icon [[image: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. | ||
| 418 | * If you want to delete several documents at once, select them (by checking the box at their left) and then click the **Delete **button. | ||
| 419 | |||
| 420 | __Edit a document:__ | ||
| 421 | |||
| 422 | Click the **Edit** icon [[image:configuration_guide_en_html_4fa64fdb0da67a3a.jpg]] besides the document you want to edit and then enter the new document parameters. Click **OK**. | ||
| 423 | |||
| 424 | === Manage applications === | ||
| 425 | |||
| 426 | 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//”//**) **. | ||
| 427 | |||
| 428 | __To add an application:__ | ||
| 429 | |||
| 430 | * Click the **New application **button | ||
| 431 | * If you use several documents server, select the appropriate documents server in the **Server **drop down list. | ||
| 432 | * Enter the name, URL and Description. You can add an icon by clicking the **Browse...** button and then selecting the appropriate image. | ||
| 433 | * Authorize users and roles to use the application: | ||
| 434 | |||
| 435 | ➢ 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:configuration_guide_en_html_c2f3d9757a951441.png]] or **Add a role **icon[[image:configuration_guide_en_html_a29d45e9ab927857.png]] to authorize users or roles to access the application. | ||
| 436 | |||
| 437 | * Click the **OK **button. | ||
| 438 | |||
| 439 | [[image:configuration_guide_en_html_1349b7f5340bea0e.jpg]] | ||
| 440 | |||
| 441 | __Search for an application:__ | ||
| 442 | |||
| 443 | * If you use several documents server, select the appropriate server in the drop down list. | ||
| 444 | * Type the text you are searching for, then click the Search button (enter * or let the field empty to display all the documents). | ||
| 445 | |||
| 446 | __Remove an application__: | ||
| 447 | |||
| 448 | * Click the **Remove** icon [[image: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. | ||
| 449 | * If you want to delete several applications at once, select them (by checking the box at their left) and then click the **Delete **button. | ||
| 450 | |||
| 451 | __Edit an application:__ | ||
| 452 | |||
| 453 | [[image:configuration_guide_en_html_70a62e33937491dd.jpg]] | ||
| 454 | |||
| 455 | * Click the **Edit** icon [[image: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. | ||
| 456 | |||
| 457 | == Configure the license == | ||
| 458 | |||
| 459 | To enter your license key or manage your license: | ||
| 460 | |||
| 461 | * 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/]] : | ||
| 462 | |||
| 463 | [[image:configuration_guide_en_html_9b500d9dfdca7872.jpg]] | ||
| 464 | |||
| 465 | * Click the **Configuration **link, then the **License** **management** link. | ||
| 466 | * In the connection dialog box, enter the user name and password(by default, admin/admin). The user must have the authorization //Manage licenses// | ||
| 467 | |||
| 468 | === Enter the license key === | ||
| 469 | |||
| 470 | 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: | ||
| 471 | |||
| 472 | * the maximum number of authorized users, | ||
| 473 | * the expiration date: in case you have a trial license. | ||
| 474 | |||
| 475 | To enter your license key: | ||
| 476 | |||
| 477 | * Enter your license key in the field **Please specify a key to activate your product**. | ||
| 478 | * 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. | ||
| 479 | |||
| 480 | 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). | ||
| 481 | |||
| 482 | * Click **Apply **to apply the license | ||
| 483 | |||
| 484 | [[image:configuration_guide_en_html_b4c0789b1751825c.jpg]] | ||
| 485 | |||
| 486 | === Add users to the license === | ||
| 487 | |||
| 488 | * 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**. | ||
| 489 | * List of matching users is displayed. | ||
| 490 | * Check the users you want to add to the license and then click **Add to the license**. | ||
| 491 | |||
| 492 | [[image:configuration_guide_en_html_caaaa55193906d67.jpg]] | ||
| 493 | |||
| 494 | * 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**. | ||
| 495 | |||
| 496 | [[image:configuration_guide_en_html_a137114e4af2f239.jpg]] | ||
| 497 | |||
| 498 | * You can also get information on DigDash Enterprise login: first connection, last connection and login count | ||
| 499 | |||
| 500 | [[image:configuration_guide_en_html_26a64086bcd53f07.jpg]] | ||
| 501 | |||
| 502 | == Manage backups == | ||
| 503 | |||
| 504 | You can backup then restore your DigDash Enterprise configuration. | ||
| 505 | |||
| 506 | To manage backups: | ||
| 507 | |||
| 508 | * 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/]]. | ||
| 509 | * Click the **Configuration **link, then the **Backup** **management** link. Click **Backup **or **Restore **depending on the action you want to perform. | ||
| 510 | |||
| 511 | [[image:configuration_guide_en_html_9b500d9dfdca7872.jpg]] | ||
| 512 | |||
| 513 | * In the connection dialog box, enter the user name and password (the user must have the authorization //Manage servers//). | ||
| 514 | |||
| 515 | === Backup data === | ||
| 516 | |||
| 517 | Select the items to backup. To do so, check the appropriate boxes. | ||
| 518 | |||
| 519 | In the example below, LDAP, wallets and Dashboards will be saved for user jsmith. | ||
| 520 | |||
| 521 | [[image:configuration_guide_en_html_5dc5e0eff023f71a.jpg]] | ||
| 522 | |||
| 523 | 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). | ||
| 524 | |||
| 525 | If you want to select/un-select all items of a line or a column at once, click the row or the column header. | ||
| 526 | |||
| 527 | 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. | ||
| 528 | |||
| 529 | You can find below the description of the items you can backup by category: users, roles, authorization groups and server files. | ||
| 530 | |||
| 531 | __Users__: | ||
| 532 | |||
| 533 | : | ||
| 534 | |||
| 535 | ((( | ||
| 536 | |**Item**|**Description** | ||
| 537 | |LDAP|User information stored in LDAP | ||
| 538 | |Wallets|User wallet and flows | ||
| 539 | |Dashboards|User dashboards | ||
| 540 | |Data models|User data models | ||
| 541 | |Passwords|User passwords | ||
| 542 | ))) | ||
| 543 | |||
| 544 | __Roles__: | ||
| 545 | |||
| 546 | : | ||
| 547 | |||
| 548 | ((( | ||
| 549 | |**Item**|**Description** | ||
| 550 | |LDAP|Role information stored in LDAP | ||
| 551 | |Wallet|Role wallets and flows. | ||
| 552 | |Dashboard|Role dashboards | ||
| 553 | |Data models|Role data models | ||
| 554 | |password|Role passwords | ||
| 555 | ))) | ||
| 556 | |||
| 557 | __Authorization groups:__ | ||
| 558 | |||
| 559 | Check the box on the same line as the authorization group you want to backup. | ||
| 560 | |||
| 561 | __Common server files__: | ||
| 562 | |||
| 563 | Files that you have modified are displayed in the list of common server files you can backup. | ||
| 564 | |||
| 565 | 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. | ||
| 566 | |||
| 567 | : | ||
| 568 | |||
| 569 | ((( | ||
| 570 | |**Item**|**Description** | ||
| 571 | |__System files:__| | ||
| 572 | |serversettings.xml|DigDash Enterprise Server parameters (proxy, LDAP,scheduler,...) | ||
| 573 | |system.xml|DigDash Enterprise system information | ||
| 574 | |Usersettings.xml|User settings information including user parameters you created. | ||
| 575 | |__Repository files:__| | ||
| 576 | ))) | ||
| 577 | |||
| 578 | : | ||
| 579 | |||
| 580 | ((( | ||
| 581 | |colortablerepository.xml|Color palettes repository | ||
| 582 | |cssrepository.xml|CSS repository | ||
| 583 | |clustersettings.xml|Cluster settings | ||
| 584 | |commentsrepository.xml|Comments repository (comments added in the dashboard on data models and flows) | ||
| 585 | |favoritedevicesrepository.xml|Favorite devices used for synchronization | ||
| 586 | |formatrepository.xml|Formats repository | ||
| 587 | |jsfunctionrepository.xml|Java scripts functions repository | ||
| 588 | |Hierarchyrepository.xml|Repository of shared hierarchy | ||
| 589 | |navigationsentencerepository.xml|Repository of sentences created for text document and video | ||
| 590 | |serverurlrepository.xml|Documents servers repository | ||
| 591 | |__Translation files:__| | ||
| 592 | |((( | ||
| 593 | dm.properties | ||
| 594 | |||
| 595 | + dm_language.properties | ||
| 596 | )))|((( | ||
| 597 | Repository of data models items (dimensions names, hierarchies names,...). | ||
| 598 | |||
| 599 | Translation are available in files dm_language.properties | ||
| 600 | |||
| 601 | (example:dm_en.properties for the english version). | ||
| 602 | ))) | ||
| 603 | |dmvoc.properties|Repository of data models items used for video and audio documents. | ||
| 604 | |dmtag.properties|Synonymous created for data models items (synonymous are used in Query text). | ||
| 605 | |dashboarddomain.properties|Repository of dashboards items (page names,...). | ||
| 606 | |__Other files:__| | ||
| 607 | |images|((( | ||
| 608 | List of images used in DigDash | ||
| 609 | |||
| 610 | Enterprise (added from the dashboard editor) | ||
| 611 | ))) | ||
| 612 | |Default.css|File containing personalized styles of the dashboard | ||
| 613 | |Js-const.js|Constants of DigDash Enterprise Server (properties modified from the «Server settings>Advanced» page, section « Constants » ) + export settings | ||
| 614 | ))) | ||
| 615 | |||
| 616 | === Restoring data === | ||
| 617 | |||
| 618 | * To restore data, select the backup file,and then click **Upload** | ||
| 619 | |||
| 620 | [[image:configuration_guide_en_html_3a8eb8d4e086279a.jpg]] | ||
| 621 | |||
| 622 | * 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. | ||
| 623 | * 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. | ||
| 624 | |||
| 625 | === Saving and restoring data automatically === | ||
| 626 | |||
| 627 | __Backuping data automatically:__ | ||
| 628 | |||
| 629 | You can automatically backup your data using the backup tool « backuptools.jar » provided with DigDash Enterprise. | ||
| 630 | |||
| 631 | 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) | ||
| 632 | |||
| 633 | You can use available options: | ||
| 634 | |||
| 635 | * -url server_url: DigDash Enterprise server URL (by default [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]][[)>>url:http://localhost:8080/]] | ||
| 636 | * -domain dd_domain: domain name of the DigDash Enterprise domain (by default ddenterpriseapi) | ||
| 637 | * -login user_login: DigDash Enterprise administrator login name | ||
| 638 | * -pass user_pass: DigDash Enterprise password | ||
| 639 | * -export or -backup: save DigDash Enterprise configuration in a zip file | ||
| 640 | * -import ou -restore: restore DigDash Enterprise configuration from a zip file | ||
| 641 | * -file zipfile: path of the backup file to restore | ||
| 642 | * -ldap: save or restore LDAP directory | ||
| 643 | * -noldap: no save or restore of LDAP directory | ||
| 644 | * -help: display help | ||
| 645 | * -debug: display error messages | ||
| 646 | |||
| 647 | __Usage examples:__ | ||
| 648 | |||
| 649 | java -jar backuptools.jar -login admin -pass admin -export -noldap | ||
| 650 | |||
| 651 | 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 | ||
| 652 | |||
| 653 | 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 | ||
| 654 | |||
| 655 | 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**. | ||
| 656 | |||
| 657 | For example on Windows 7 this folder is: | ||
| 658 | |||
| 659 | **C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config**. | ||
| 660 | |||
| 661 | 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). | ||
| 662 | |||
| 663 | When you run the file, you must indicate: | ||
| 664 | |||
| 665 | * The server URL: for example [[__http:~~/~~/localhost:8080__>>url:http://localhost:8080/]] | ||
| 666 | * the server domain: for example ddenterpriseapi | ||
| 667 | * The user login: for example, admin | ||
| 668 | * The user password: for example, admin | ||
| 669 | * Whether you want to save the LDAP directory (users and roles) or not: enter **y **to save it and **n **if you don't. | ||
| 670 | |||
| 671 | 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**. | ||
| 672 | |||
| 673 | For example on Windows 7 this folder is: | ||
| 674 | |||
| 675 | **C:\Users\<user>\AppData\Roaming\Enterprise Server\ddenterpriseapi\config**. | ||
| 676 | |||
| 677 | __Restoring a backup automatically:__ | ||
| 678 | |||
| 679 | 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. | ||
| 680 | |||
| 681 | You also need to enter the backup file name (the file must be located in the same folder as backup_import.bat). | ||
| 682 | |||
| 683 | |||
| 684 | |||
| 685 |