Code source wiki de Guide de mise à jour

Modifié par Aurelie Bertrand le 2024/04/18 15:17
Afficher les derniers auteurs
1 {{ddtoc/}}
2
3 ----
4
5 = Introduction =
6
7 Ce guide décrit la procédure et les précautions à prendre pour mettre à jour votre version DigDash Enterprise vers la nouvelle version 2023R1.
8 Il présente également les modifications de comportement introduits dans cette version.
9
10
11 (% class="box errormessage" %)
12 (((
13 **Attention : Avant toute migration, faire une sauvegarde intégrale de l’application depuis la page d’accueil => Configuration => Gestion des sauvegardes.**
14 )))
15
16 (% class="box warningmessage" %)
17 (((
18 **Important : Migration des développements spécifiques (toutes versions)**
19 \\Cette procédure ne prend pas en compte la migration de développements spécifiques (modification de logos, adjonction de JSP, scripts d'import utilisateurs...) qui peut être décrite dans vos procédures internes.
20 Si des développements spécifiques ont été faits, procédez à une copie de sauvegarde de votre installation actuelle afin de pouvoir récupérer et migrer tous ces développements.
21
22 **Important **: Depuis la version 2022R2, la valeur du paramètre utilisateur **langChoice **est maintenant un code langue et non plus un index. Par exemple 0 est devenu "en", 1 est devenu "fr". Il faut prendre en compte ce changement :
23
24 * dans l'adaptation de vos scripts d'import des utilisateurs,
25 * dans les formules de mesures dérivées qui utiliseraient ${user.langChoice} pour déterminer la valeur d'une mesure.
26 * dans les formules de filtrages de données qui utiliseraient ${user.langChoice}.
27 )))
28
29 (% class="box successmessage" %)
30 (((
31 **Nouveauté importante **: 
32 \\Le **Desktop Studio** a été **supprimé **définitivement dans la version 2021 R2.
33 Le Studio Web est donc devenu l'unique moyen de construire vos sources de données et vos graphiques.
34 Vous n'aurez plus à gérer les complications liées à l'installation et la mise à jour de Java sur les postes clients.
35
36 Attention : l'usage de l'ancien Desktop Studio dans un déploiement 2021 R2 ou supérieur n'est pas supporté.
37 )))
38
39 Les archives d’installation de DigDash Enterprise sont nommées sous le modèle **digdash_enterprise_2023R1_64.zip** ou **digdash_enterprise_2023R1_numpatch_64.zip.**
40 Après extraction, le dossier s’appellera **digdash_enterprise_2023R1_64** ou **digdash_enterprise_2023R1_numpatch_64**.
41
42 Pour expliciter la procédure, le dossier d’installation de la plus ancienne des versions sera nommé **install_dd_OLD** et le dossier d’installation de la plus récente des versions **install_dd_NEW.**
43 Le numéro de version est visible dans le fichier version.txt de l'archive ou depuis la page « **Configuration **/ **État du serveur** » (« Version DigDash Enterprise » en haut à gauche dans la rubrique « **État général** »).
44
45 **Configuration recommandée :**
46
47 * Serveur : **Tomcat 9** (Windows et Linux)
48 * Serveur : **Java 11** (Windows)
49
50 Sous linux vous devrez au minimum installer Java en suivant les recommandations du [[Guide d'installation>>doc:Digdash.deployment.installation.install_guide_linux.WebHome||target="_blank"]].
51
52 = Bonnes pratiques pour la version 2023 R1{{id name="Bonnes_pratiques"/}} =
53
54 Pour un fonctionnement optimal de DigDash Enterprise, il est recommandé d'appliquer les préconisations suivantes :
55
56 * Utilisation du fichier **digdash.properties** pour stocker la configuration des environnements.
57 Pour plus d'informations sur le paramétrage du fichier, consultez la page [[Paramétrage du fichier digdash.properties>>doc:.DigDash\.properties.WebHome]].
58
59 * Utilisation d'un système de base de données externe pour les bases DDAudit, Comments et DDDataEntry.
60 Pour plus d'informations sur l'installation d'un système de base de données externe, consultez le paragraphe :
61 ** [[Installation de MariaDB>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome||anchor="DB_windows"]] pour un environnement de production Windows.
62 ** [[MariaDB (Préconisé)>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="DB_ubuntu"]] pour un environnement de production Ubuntu.
63
64 * Utilisation d'un Tomcat séparé de l'installation Digdash (installation par le gestionnaire de package de l'OS).
65 Pour plus d'informations sur l'installation d'un Tomcat séparé, consultez le paragraphe :
66 ** [[Installation de Tomcat 9>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome||anchor="Tomcat_windows"]] pour un environnement de production Windows.
67 ** [[Tomcat 9>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="Tomcat_ubuntu"]] pour un environnement de production Ubuntu.
68
69 * Utilisation de OpenLDAP à la place de adswrapper.
70 Pour plus d'informations sur l'installation de OpenLDAP, consultez le paragraphe :
71 ** [[Installation de OpenLDAP>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome||anchor="OpenLDAP_windows"]] pour un environnement de production Windows.
72 ** [[Configuration de OpenLDAP>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="OpenLDAP_ubuntu"]] pour un environnement de production Ubuntu.
73
74 = Mise à jour de DigDash Enterprise vers la version 2023 R1{{id name="Premier_deploiement"/}} =
75
76 Ce paragraphe vous concerne si vous mettez à jour DigDash Enterprise depuis une version 2021R1 ou ultérieure vers la version 2023 R1.
77
78 (% class="box successmessage" %)
79 (((
80 Depuis la version 2021 R1 le processus d'installation, de configuration et de maintenance (installation d'un patch ou intervention du support) a été simplifié.
81 Si vous n'avez pas déjà suivi cette procédure de configuration il est intéressant et vivement recommandé de reprendre de zéro l'installation.
82 Le nouveau système de configuration vous fera gagner du temps par la suite.
83 )))
84
85 (% class="box errormessage" %)
86 (((
87 Les drivers JDBC ont été mis à jour et nécessite pour certains d'être réinstallés. Merci de vérifier selon vos besoins dans le document suivant : [[Ajout Pilote JDBC ~> Drivers préconfigurés non inclus>>doc:Digdash.deployment.Connectivity_Database.adding_jdbc_driver.WebHome||anchor="HDriversprE9configurE9snoninclus"]].
88 )))
89
90 (% class="box errormessage" %)
91 (((
92 **Nouvelle version de la base données H2**
93 \\La base de données H2 a été mise à jour. Les anciennes versions de base de données H2 (**DDAudit**, **Comments **et **DDDataEntry**) ne sont pas compatibles avec cette version.
94 Veuillez consulter le document [[Migration base de données H2>>doc:.H2_database.WebHome]]  pour le détail des procédures à suivre.
95
96 Les utilisateurs qui n'utilisent pas la base de données H2 pour ces données mais une base de données alternative, comme mysql, mariadb ou postgresql, ne sont pas concernés.
97 )))
98
99 (% class="box errormessage" %)
100 (((
101 Le **module DDAudit **a été modifié. Pour en savoir plus sur les instructions relatives, veuillez consulter le paragraphe [[Modification du module DDAudit>>path:#DDAudit]].
102 )))
103
104 == Procédure de mise à jour ==
105
106 === Étape 1 : Sauvegarde ===
107
108 Effectuez une sauvegarde complète de votre configuration : entrées LDAP (utilisateurs, rôles, groupes d'autorisations), modèles de données, tableaux de bord, etc.
109 Si vous aviez ajouté des fichiers à votre installation (modification de logos, imags, css, adjonction de JSP, ...) il faudra les reporter dans la nouvelle installation.
110
111 Voir la documentation [[Sauvegarde et restauration>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
112
113 === Étape 2 : Arrêt du serveur ===
114
115 Arrêtez le serveur DigDash :
116
117 * **Sous Windows :**
118 ** Si Digdash Enterprise n'est pas installé en tant que service Windows : lancez le fichier **<install_dd_OLD>/stop_tomcat.bat**.
119 ** Si Digdash Enterprise est installé en tant que service Windows : cliquez-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur **Arrêter **depuis votre application **Services** de Windows.
120 * **Sous Linux : **utilisez la commande** **##{{code}}service tomcat9 stop{{/code}}##
121
122 === Étape 3 : Sauvegarde et suppression des anciennes applications ===
123
124 Sauvegardez puis effacez les fichiers et dossiers de **<install_dd>/webapps :**
125
126 (% style="width:478px" %)
127 |(% style="width:235px" %)(((
128 Dossiers :
129
130 * adminconsole
131 * ddenterpriseapi
132 * digdash_dashboard
133 * studio
134 * adswrapper*
135 )))|(% style="width:239px" %)(((
136 Fichiers :
137
138 * adminconsole.war
139 * ddenterpriseapi.war
140 * digdash_dashboard.war
141 * studio.war
142 * adswrapper.war*
143 )))
144
145 (% class="box errormessage" %)
146 (((
147 ~* À noter que **adswrapper n'est pas recommandé**.
148 )))
149
150 (% class="box warningmessage" %)
151 (((
152 * Ne pas effacer le dossier **ROOT**.
153 * Ne pas effacer le dossier **ldapdigdash** si utilisé. Le répertoire ldapdigdash est lié à adswrapper qui n'est pas recommandé.
154 )))
155
156 === Étape 4 : Copie des nouvelles applications ===
157
158 Dézippez la nouvelle version du produit dans un emplacement temporaire.
159
160 Naviguez dans ce dossier temporaire jusque dans le dossier **webapps.**
161 Copiez les fichiers suivants dans le même dossier de votre installation :
162
163 * adminconsole.war
164 * ddenterpriseapi.war
165 * digdash_dashboard.war
166 * studio.war
167
168 Le dossier **webapps **doit maintenant contenir 4 fichiers .war et le dossier **ROOT**.
169
170 === Étape 5 : Récupération des add-ons ===
171
172 Copiez le contenu du répertoire **add-ons** vers le même endroit dans votre installation.
173 Si vous aviez modifié certains fichiers (**importtools**, **backtuptools**, ...) sauvegardez-les avant la copie.
174
175 === Étape 6 : Redémarrage du serveur ===
176
177 Redémarrez le serveur DigDash :
178
179 * **Sous Windows :**
180 ** Si Digdash Enterprise n'est pas installé en tant que service Windows : lancez le fichier **<install_dd>/start_tomcat.bat**.
181 ** Si Digdash Enterprise est installé en tant que service Windows : cliquez-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur **Démarrer **depuis votre application **Services** de Windows.
182 * **Sous Linux : utilisez la commande **##{{code}}service tomcat9 restart{{/code}}##
183
184 et laissez Tomcat redéployer les nouvelles applications.
185
186 Sous Linux, reportez vous au [[Guide d'installation Linux>>doc:Digdash.deployment.installation.install_guide_linux.WebHome]].
187 Plus d'informations sur l'installation en tant que service dans le [[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome]].
188
189 === Étape 7 : Restauration ===
190
191 Si vous avez configuré votre nouvelle installation pour pointer sur votre ancien dossier des données, la restauration n'est pas nécessaire.
192
193 Sinon (nouveau dossier des données), utilisez la sauvegarde de l’étape 1 pour restaurer les entrées LDAP (utilisateurs, rôles, groupes d'autorisations).
194
195 __**Important**__** :** si vous aviez fait des modifications dans les dossiers **ddenterpriseapi** et **digdash_dashboard** sur des fichiers de configuration (web.xml, ...), des images ou des fichiers css, vous devrez les reporter.
196
197 //__Note__ : Si vous venez d’une version 2017 R1 et si vous avez customisé les styles du tableau de bord, veuillez vous référer à la documentation [[Personnalisation>>doc:Digdash.customization.customization_DDE.WebHome]] pour mettre à jour vos styles CSS.//
198
199 === Étape 8 : Nettoyage du cache du navigateur ===
200
201 Supprimez le cache du navigateur (raccourcis sur la plupart des navigateurs : Ctrl + Shift + Suppr).
202
203 === Étape 9 : Régénération des modèles de données ===
204
205 (% class="box infomessage" %)
206 (((
207 La régénération des modèles de données est recommandée dans le cas d'une montée de version majeure.
208 )))
209
210 Dans l'onglet **Flux** du Studio, cliquez-droit sur chaque portefeuille de flux puis cliquez sur **Synchroniser pour tous les utilisateurs**.
211
212 Dans la boite **Confirmer la synchronisation du portefeuille de rôle**, cochez la caseForcer la génération des cubes des données des flux sélectionnés puis, l**a case Forcer la génération de tous les cubes dépendants**.
213
214 (% style="text-align:center" %)
215 [[image:Confirmer_synchro_portefeuille.png||queryString="width=489&height=320" height="320" width="489"]]
216
217 == Modification du module DDAudit{{id name="DDAudit"/}} ==
218
219 Le module DDAudit a été modifié en version 2023R1. Si vous avez déployé DDAudit dans une version précédente :
220
221 * Si vous n'avez pas modifié les modèles et les flux de DDAudit, et si vous n'avez pas créé de nouveaux modèles et flux, alors il est conseillé de désinstaller le module DDAudit, en supprimant le rôle et ses données puis de le réinstaller depuis le zip d'installation de cette nouvelle version, ou via le gestionnaire Digdash Metadata Service depuis le Studio.
222
223 * Si vous avez créé vos propres modèles et flux pour DDAudit, ou si vous avez modifié les modèles de données, vous devez modifier les requêtes SQL des modèles de données modifiés ou créés afin qu'ils n'utilisent plus le champ **user** mais **dd_user **(les noms des dimensions et mesures restent inchangés).
224
225 (% class="box warningmessage" %)
226 (((
227 **Note** : Si vous utilisez H2 comme base de donnée pour DDAudit, il vous faudra migrer votre ancienne base de données (voir le document [[Migration base de données H2>>https://doc.digdash.com/xwiki/wiki/dd2023r1/view/Digdash/deployment/installation/upgrade_dde/H2_database/]]) avant de pouvoir effectuer ces modifications.
228 )))
229
230 = Modifications de comportement dans la 2023 R1 =
231
232 De nouvelles fonctionnalités ou la résolution de bugs dans la 2023 R1 sont à l'origine de modifications de comportement susceptibles d'avoir un impact. Il est donc recommandé de consulter la liste des modifications de comportement ci-dessous.
233
234 Les éléments marqués d'une astérisque** *** sont ceux pour lesquels il est possible, si nécessaire, de rétablir le comportement antérieur. Veuillez consulter le paragraphe [[Rétablissement des comportements antérieurs>>url:https://doc.digdash.com/xwiki/wiki/dev/view/Digdash/deployment/installation/upgrade_dde/#]] pour plus d'informations.
235
236 == Générales ==
237
238 **Détection des données***
239
240 La détection des types de données a été améliorée afin de détecter automatiquement tous les types de données.
241 \\**Optimisations***
242
243 Des optimisations introduites dans la version 2022R2 sont à l'origine de potentielles régressions.
244 Ces optimisations sont désormais désactivées par défaut.
245
246 **Support partiel ES6***
247
248 Un support partiel de la version ES6 (ECMAScript 6)** **du langage JavaScript a été introduit. Celle-ci permet une syntaxe plus moderne dans les scripts des mesures dérivées, transformateurs de colonnes, etc.
249
250 == Gestion des utilisateurs ==
251
252 L'export au format CSV de la liste des utilisateurs utilise désormais le séparateur **virgule **en lieu et place du séparateur **point virgule**.
253 L'import au format CSV de la liste des utilisateurs intègre à présent la détection automatique des séparateurs.
254
255 == Studio ==
256
257 **Paramètres des graphiques et tableaux**
258
259 Le cyclage des couleurs sur l'axe Colonne ou Barre est désormais activé par défaut.
260 L'option **Retour à la ligne sur en-tête** est désormais activée par défaut pour les tableaux.
261
262 **Fabriques de PDF/PPT**
263
264 Toute image insérée dans une zone image d'une Fabrique PDF/PPT est désormais redimensionnée en fonction de la taille de cette zone et en conservant son ratio. Cela était auparavant le cas seulement pour les images vectorielles.
265
266 (% class="box warningmessage" %)
267 (((
268 Les Fabriques PDF/PPT créées avec une version antérieure à la version 2023 R1 doivent être éditées afin de réajuster la position des images si nécessaire.
269 )))
270
271 **Traduction non modale**
272
273 Quand l'option **Inclure dans le dictionnaire global **est cochée, la **Valeur affichée **d'un élément (colonne, mesure, flux, etc)** **n'est sauvegardée dans le dictionnaire global qu'une fois que l'utilisateur a enregistré le modèle de donnée, la fonction, le portefeuille ou le flux concerné (bouton **Appliquer**). Auparavant, la sauvegarde de la valeur affichée dans le dictionnaire global était effectuée automatiquement.
274
275 **Tableaux croisés : tri***
276
277 Dans un tableau croisé, lorsqu'un tri est appliqué sur la dimension d'une sous-colonne, le regroupement des sous-colonnes sous la colonne parent est désormais conservé. Auparavant, lorsque ce tri était appliqué, les sous-colonnes étaient dégroupées chacune sous une colonne parent individuelle, comme illustré ci-dessous avec un tri ascendant sur la date.
278 [[image:Tri_sous_colonnes4.png||alt="Tri_sous_colonnes"]]
279 Ceci s'applique également aux lignes.
280
281 == Éditeur de tableau de bord ==
282
283 La navigation privée d'une page de tableau de bord intègre désormais par défaut les variables en plus des filtres de la page. Les variables n'apparaissent cependant pas dans la boite **Navigation**. Dans le cas où la navigation privée n'est pas définie pour l'ensemble de la page mais seulement pour certains filtres, les variables n'y sont pas intégrées.
284
285 == Assistant de création de tableau de bord ==
286
287 Le nom d'une mesure calculée ou dérivée ne peut plus être éditée après sa création.
288
289 == Dashboard ==
290
291 Toutes les boites popup affichées dans le Dashboard (Voir les commentaires, Éditeur de commentaires, Détails des données, etc) ne sont plus redimensionnables. Elles restent repositionnables.
292
293 **Documents**
294
295 Lors de l'ajout de fichiers dans la boite **Documents** du tableau de bord, il n'est plus possible de charger plusieurs fichiers simultanément.
296
297 **Commentaires**
298
299 La boite **Éditeur de commentaires**, utilisée pour ajouter un commentaire, ne comporte plus la section **Filtres**. Celle-ci permettait de modifier les filtres associés au commentaire ajouté.
300 Une catégorie peut être attribuée à un commentaire. Les différents catégories disponibles ne disposent plus d'une icône associée.
301
302 == Rétablissement des comportements antérieurs ==
303
304 Il peut être intéressant dans certains cas de rétablir le comportement antérieur. 
305 Pour cela, il faut éditer le fichier system.xml situé dans **<DD Install>\Enterprise Server\ddenterpriseapi\config\system.xml **et ajouter une ligne de propriété spécifiant le comportement.
306 Cette opération nécessite un redémarrage du serveur DigDash.
307
308 **Détection des données**
309
310 Ajoutez la ligne :
311 <Property key="PROP_OPTIM_NO_FORMAT_DETECTION_CUBEGEN" value="true"/>
312 entre <SystemProperties> et </SystemProperties>
313
314 **Optimisations**
315
316 Ajoutez la ligne :
317 <Property key="PROP_JS_OPTIM_LEVEL" value="1"/>
318 entre <SystemProperties> et </SystemProperties>
319
320 **Support partiel ES6**
321
322 Ajoutez la ligne :
323 <Property key="PROP_JS_ES6_SUPPORT" value="false"/>
324 entre <SystemProperties> et </SystemProperties>
325
326 **Tableaux croisés : tri**
327
328 Ajoutez la ligne :
329 <Property key="PROP_CROSSTABLE_AXIS_SORT_LEGACY" value="true"/>
330 entre <SystemProperties> et </SystemProperties>
331
332 = Déploiement d'un patch sur une 2023 R1{{id name="Deploiement_patch"/}} =
333
334 Ce paragraphe concerne la mise à jour d'une version 2023 R1 vers une autre 2023 R1 plus récente.
335
336 (% class="box infomessage" %)
337 (((
338 On considère ici que votre configuration suit la recommandation d'utiliser le fichier **digdash.properties**. Si cela n'est pas fait, référez-vous au chapitre [[Bonnes pratiques pour la version 2023 R1>>path:#Bonnes_pratiques]].
339 )))
340
341 (% class="box warningmessage" %)
342 (((
343 Si votre installation contient des développements spécifiques, qui se trouvent dans les dossiers des applications :
344 **<install_dd>/apache-tomcat/webapps/ddenterpriseapi** ou **<install_dd>/apache-tomcat/webapps/digdash_dashboard**
345 ils seront perdus lors de la mise à jour. Sauvegardez-les avant toute autre opération, afin de pouvoir les reporter après mise à jour.
346 )))
347
348 La procédure de déploiement d'un patch est désormais identique à la mise à jour de version. Vous pouvez donc suivre la procédure détaillée ci-dessus.
349
350 = Version 2021 R1 ou inférieure vers 2023 R1 =
351
352 Contactez DigDash à l’adresse [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__contact@digdash.com__>>path:mailto:contact@digdash.com]](%%).