Code source wiki de Guide de mise à jour

Modifié par Aurelie Bertrand le 2024/04/18 15:22
Masquer les derniers auteurs
mperroud 2.1 1 {{ddtoc/}}
2
3 ----
4
5 (% class="box errormessage" %)
6 (((
7 **Attention : Avant toute migration, faire une sauvegarde intégrale de l’application depuis la page d’accueil => Configuration => Gestion des sauvegardes.**
8 )))
9
10 (% class="box warningmessage" %)
11 (((
12 **Important : Migration des développements spécifiques (toutes versions)**
13 \\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.
14 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.
15
16 **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 :
17
18 * dans l'adaptation de vos scripts d'import des utilisateurs,
19 * dans les formules de mesures dérivées qui utiliseraient ${user.langChoice} pour déterminer la valeur d'une mesure.
20 * dans les formules de filtrages de données qui utiliseraient ${user.langChoice}.
21 )))
22
23 (% class="box successmessage" %)
24 (((
25 **Nouveauté importante **: 
26 \\Le **Desktop Studio** a été **supprimé **définitivement dans la version 2021 R2.
27 Le Studio Web est donc devenu l'unique moyen de construire vos sources de données et vos graphiques.
28 Vous n'aurez plus à gérer les complications liées à l'installation et la mise à jour de Java sur les postes clients.
29
30 Attention : l'usage de l'ancien Desktop Studio dans un déploiement 2021 R2 ou supérieur n'est pas supporté.
31 )))
32
33 Les archives d’installation de DigDash Enterprise sont nommées sous le modèle **digdash_enterprise_2022R2_64.zip** ou **digdash_enterprise_2022R2_numpatch_64.zip.**
34 Après extraction, le dossier s’appellera **digdash_enterprise_2022R2_64** ou **digdash_enterprise_2022R2_numpatch_64**.
35
36 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.**
37 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** »).
38
39 **Prérequis minimum :**
40
41 * Serveur : Tomcat 8
42 * Serveur : Java 8
43 * Web Studio : aucun prérequis (accessible dans le navigateur web comme le tableau de bord)
44
45 **Recommendations :**
46
47 * Serveur : **Tomcat 9** (Windows et Linux)
48 * Serveur : **Java 11** (Windows)
49 * Web Studio : aucun prérequis (accessible dans le navigateur web comme le tableau de bord)
50
Aurelie Bertrand 3.1 51 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"]].
mperroud 2.1 52
53 = Premier déploiement de la 2022 R2 =
54
55 Ce paragraphe vous concerne si vous déployez pour la 1ère fois la version 2022 R2.
56 Dans le cas du déploiement d'un patch pour la 2022 R2, voir le chapitre [[Déploiement d'un patch sur une 2022 R2>>doc:||anchor="HDE9ploiementd27unpatchsurune2022R2"]].
57
58 (% class="box successmessage" %)
59 (((
60 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é.
61 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.
62 Le nouveau système de configuration vous fera gagner du temps par la suite.
63 )))
64
65 (% class="box errormessage" %)
66 (((
Aurelie Bertrand 3.1 67 Les drivers JDBC ont été mis à jour depuis 2022R1 et nécessitent pour certains d'être réinstallés. Merci de vérifier selon vos besoins dans le doc suivant : [[Ajout Pilote JDBC ~> Drivers préconfigurés non inclus>>doc:Digdash.deployment.Connectivity_Database.adding_jdbc_driver.WebHome||anchor="HDriversprE9configurE9snoninclus"]].
mperroud 2.1 68 )))
69
70 Le principe général est de n'avoir à modifier qu'un seul fichier : **digdash.properties**, qui sera préservé automatiquement lors d'une mise à jour.
71 Ce fichier est fourni dans l'archive d'installation et comporte déjà tous les paramètres succeptibles d'être personnalisés lors de l'installation.
72
73 On distinguera deux cas principaux : utilisation du serveur Tomcat fourni (windows ou linux) ou utilisation de votre propre Tomcat.
74
75 == Utilisation du Tomcat fourni ==
76
77 === Étape 1 : Sauvegarde ===
78
79 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.
80 Si vous aviez ajouté des fichiers à votre installation (modification de logos, imags, css, adjonction de JSP, ...) il faudra les reporter dans la nouvelle installation.
81
82 Voir documentation [[Sauvegarde et restauration>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
83
84 === Étape 2 : Arrêt du serveur ===
85
86 Arrêtez le serveur DigDash à l'aide de : **<install_dd_OLD>/stop_tomcat.bat**.
87 Ou sous Linux **<install_dd_OLD>/apache-tomcat/bin/shutdown.sh.**
88 Ou arrêtez le service correspondant.
89
90 === Étape 3 : Extraction ===
91
92 * Dézippez **digdash_enterprise_2022R2_numpatch_64.zip** à l'emplacement de votre choix grâce à un outils comme [[7Zip>>https://www.7-zip.org||rel="noopener noreferrer" target="_blank"]].
93 * Renommez le dossier contenant l'installation. L'idéal est un nom sans version, pour ne pas induire en erreur sur le contenu de l'installation lors des mises à jour à venir.
94 * Vérifiez que votre dossier d'installation contient le fichier **version.txt**. C'est lui qui indiquera de manière certaine la version du produit (sans avoir à démarrer le serveur).
95
96 === Étape 4 : Paramétrage ===
97
98 (% class="box infomessage" %)
99 (((
100 Si vous êtes sous Linux, copiez le fichier **<install_dd_NEW>/digdash.properties** dans le dossier **/etc/digdash.**
101 Il sera trouvé automatiquement par le serveur.
102 Veillez à ce que dossiers et fichiers aient les mêmes droits que l'utilisateur exécutant le service Tomcat.
103 )))
104
105 Editez le fichier **<install_dd_NEW>/digdash.properties**.
106
107 (% class="box infomessage" %)
108 (((
109 Les lignes commençant par un seul caractère **#** sont celles à modifier.
110 En supprimant le caractère **#** en début de ligne vous activez le paramètre.
111 )))
112
113 ==== Emplacement des données ====
114
115 (% class="box successmessage" %)
116 (((
117 Lors de la configuration portez une attention particulière aux paramètres **digdash.appdata** ou **<application>.AppDataPath**.
118 L'idéal est d'utiliser le paramètre global **digdash.appdata** : toutes les applications utiliserons alors le même dossier racine.
119 )))
120
121 Pour spécifier un emplacement commun à toutes les applications DigDash (ldap, serveur, studio, ...) il faut modifier le paramètre **digdash.appdata** :
122
123 (% class="box" %)
124 (((
125 #digdash.appdata=C:/appdata
126 )))
127
128 devient :
129
130 (% class="box" %)
131 (((
132 digdash.appdata=C:/appdata
133 )))
134
135 (% class="box warningmessage" %)
136 (((
137 Attention à n'utiliser que des slash "/", ou deux anti-slash "~\~\".
138 )))
139
140 Attention au dossier des données de l'annuaire LDAP. Il s'agit du dossier **ldapdigdash** (si vous ne l'aviez pas modifié).
141
142 * Si vous utilisez le paramètre global **digdash.appdata** alors il faudra déplacer votre ancien dossier **ldapdigdash **dans le dossier spécifié dans ce paramètre.
143 * Si vous voulez continuer à placer le dossier **ldapdigdash **dans un autre emplacement, utilisez le paramètre **adswrapper.ads.instance.name**.
144
145 (% class="box warningmessage" %)
146 (((
147 Toutes les applications dans le même dossier (même LDAP) :
148
149 * digdash.appdata=C:/data
150 )))
151
152 (% class="box warningmessage" %)
153 (((
154 Pour un dossier LDAP séparé :
155
156 * (((
157 adswrapper.ads.instance.name=D:/data/ldapdigdash
158 )))
159 )))
160
161 ==== Les autres paramètres ====
162
163 Tous les autres paramètres présents dans ce fichier sont préfixés du nom de l'application concernée :
164
165 (% class="box infomessage" %)
166 (((
167 <nom de l'application>.<nom du paramètre>=<valeur>
168 )))
169
170 Vous devez ainsi reporter tous les paramètres que vous aviez modifiés dans les fichiers **web.xml** de votre ancienne installation.
171
172 Par exemple, pour modifier la méthode d'authentification (**authMethod**) au Tableau de bord (**digdash_dashboard**.war) il faut modifier le paramètre **digdash_dashboard.authMethod**.
173
174 (% class="box" %)
175 (((
176 #digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom
177 )))
178
179 devient :
180
181 (% class="box" %)
182 (((
183 digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom
184 )))
185
186 === Etape 5 : Démarrage ===
187
188 Une fois que vous avez reporté tous les paramètres de votre ancienne installation dans le fichier **digdash.properties**, démarrez TOMCAT à l'aide de **<install_dd_NEW>/start_tomcat.bat** et laissez Tomcat redéployer les nouvelles applications.
189 Ou sous Linux **<install_dd_OLD>/apache-tomcat/bin/startup.sh.**
190
191 Pour une installation en tant que service sous Windows, utilisez le script **<install_dd_NEW>/configure/servers_install_service.bat** (attention au nom du service si vous l'aviez modifié lors de la précédente installation, référez vous au** **[[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||target="_blank"]] pour plus de détails).
192
193 Sous linux reportez vous au [[Guide d'installation Linux>>doc:Digdash.deployment.installation.install_guide_linux.WebHome||target="_blank"]].
194 Plus d'informations sur l'installation en tant que service dans le [[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||target="_blank"]].
195
196 === Étape 6 : Restauration ===
197
198 Si vous avez configuré votre nouvelle installation pour pointer sur votre ancien dossier des données (voir [[Etape 5>>doc:||anchor="HC9tape5A0:DossierdesdonnE9es"]]) la restauration n'est pas nécessaire.
199
200 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).
201
202 __**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.
203
204 //__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.//
205
206 === Étape 7 : Nettoyage du cache du navigateur ===
207
208 Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)
209
210 == Utilisation de votre Tomcat ==
211
212 Si vous utilisez votre propre serveur Tomcat (Windows ou linux), la procédure à suivre est la même que pour le[[ déploiement d'un patch>>doc:||anchor="HDE9ploiementd27unpatchsurune2021R1"]],
213 vous pouvez donc suivre la procédure du [[chapitre suivant>>doc:||anchor="HDE9ploiementd27unpatchsurune2021R1"]].
214
215 Seule l'**étape 6 : Récupération des add-ons** sera à adapter.
216 Vous n'aurez qu'à copier le dossier add-ons où cela vous convient (vous l'avez peut être déjà sur votre machine, mais il peut contenir des mises à jour).
217
218 = Déploiement d'un patch sur une 2022 R2 =
219
220 Ce paragraphe concerne la mise à jour d'une version 2022 R2 vers une autre 2022 R2 plus récente.
221
222 (% class="box infomessage" %)
223 (((
224 Cette procédure part du principe que votre configuration suit la recommandation d'utiliser le fichier **digdash.properties**. Si cela n'est pas fait, référez vous au [[premier chapitre>>doc:||anchor="HPremierdE9ploiementdela2021R1"]].
225 )))
226
227 (% class="box warningmessage" %)
228 (((
229 Si votre installation contient des développements spécifiques, qui se trouvent dans les dossiers des applications :
230 **<install_dd>/apache-tomcat/webapps/ddenterpriseapi** ou **<install_dd>/apache-tomcat/webapps/digdash_dashboard**
231 ils seront perdus lors de la mise à jour. Sauvegardez les avant toute autre opération, afin de pouvoir les reporter après mise à jour.
232 )))
233
234 == Étape 1 : Sauvegarde ==
235
236 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.
237
238 N'oubliez pas les éventuels développements spécifiques pouvant se trouver dans les applications (voir l'encadré jaune précédent).
239
240 Voir documentation [[Sauvegarde et restauration>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
241
242 == Étape 2 : Arrêt du serveur ==
243
244 Arrêtez le serveur DigDash à l'aide de : **<install_dd>/stop_tomcat.bat**
245 Ou arrêtez le service correspondant.
246
247 == Étape 3 : Suppression des anciennes applications ==
248
249 Sauvegardez puis effacez les fichiers et dossiers de **<install_dd>/apache-tomcat/webapps :**
250
251 (% border="0" style="width:450px" %)
252 |(((
253 Dossiers :
254
255 * adminconsole
256 * ddenterpriseapi
257 * digdash_dashboard
258 * studio
259 * adswrapper
260 )))|(((
261 Fichiers :
262
263 * adminconsole.war
264 * ddenterpriseapi.war
265 * digdash_dashboard.war
266 * studio.war
267 * adswrapper.war
268 )))
269
270 (% class="box warningmessage" %)
271 (((
272 Ne pas effacer le dossier **ROOT**.
273 )))
274
275 (% class="box warningmessage" %)
276 (((
277 Ne pas effacer le dossier **ldapdigdash**.
278 )))
279
280 == Étape 4 : Copie des nouvelles applications ==
281
282 Dézippez la nouvelle version du produit dans un emplacement temporaire.
283
284 Naviguez dans ce dossier temporaire jusque dans le dossier **apache-tomcat/webapps.**
285 Copiez les 5 fichiers suivants dans le même dossier de votre installation :
286
287 * adminconsole.war
288 * ddenterpriseapi.war
289 * digdash_dashboard.war
290 * studio.war
291 * adswrapper.war
292
293 Le dossier **webapps **doit maintenant contenir 5 fichiers .war et le dossier **ROOT**.
294
295 == Étape 5 : Fichier version.txt ==
296
297 Copiez le fichier **version.txt** dans votre dossier d'installation. Il remplacera celui de la précédente installation.
298
299 (% class="box infomessage" %)
300 (((
301 Ce fichier permet de connaître la version du produit sans démarrer le serveur ou si la page "Etat du serveur" n'est pas disponible.
302 )))
303
304 == Étape 6 : Récuparation des add-ons ==
305
306 Copiez le contenu du répertoire **add-ons** vers le même endroit dans votre installation.
307 Si vous aviez modifiés certains fichiers (**importtools**, **backtuptools**, ...) sauvegardés les avant la copie.
308
309 == Étape 7 : Démarrage ==
310
311 Démarrez Tomcat à l'aide de **start_tomcat.bat /startup.sh** et laissez Tomcat redéployer les nouvelles applications.
312
313 Si vous êtes en mode service relancez le manuellement.
314
315 == Étape 8 : Nettoyage du cache du navigateur ==
316
317 Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)
318
319 = Version 2018 R2 ou inférieure vers 2022 R2 =
320
321 (% class="wikigeneratedid" %)
Aurelie Bertrand 3.1 322 Contactez DigDash à l’adresse [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)__contact@digdash.com__>>path:mailto:contact@digdash.com]](%%).