Wiki source code of Guide de mise à jour

Last modified by Aurelie Bertrand on 2025/10/09 14:40
Show last authors
1 {{ddtoc/}}
2
3 ----
4
5 = Introduction =
6
7 (% class="box warningmessage" %)
8 (((
9 **⚠ ONCE YOU HAVE UPDGRADED TO VERSION 2025 R2, YOU __CANNOT REVERT__ TO AN EARLIER VERSION.**
10 )))
11
12 This guide describes the procedure and precautions to be taken to update your DigDash Enterprise version to the new 2025 R2 version.
13 Please consult page [[Behaviour changes>>doc:Digdash.deployment.installation.behaviour_changes.WebHome]] to know about the behavioural changes introduced in this version.
14
15 This guide is relevant to you ONLY if you follow the [[good practices>>doc:||anchor="Bonnes_pratiques"]] described in the dedicated paragraph.
16 If this is not the case, start the installation from scratch according to the [[Linux>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome]] or [[Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome]].
17
18 (% class="box warningmessage" %)
19 (((
20 **⚠ Migration of specific developments (all versions)**
21 \\This procedure does not take into account the migration of specific developments (modification of logos, addition of JSPs, user import scripts, etc.), which may be described in your internal procedures.
22 If specific developments have been made, make a backup copy of your current installation so that you can recover and migrate all these developments.
23 )))
24
25 There are different DigDash Enterprise installation archives for Tomcat 9 and Tomcat 10. They are named as follows:
26
27 * For Tomcat 9: **digdash_enterprise_2025R2_64.zip** or **digdash_enterprise_2025R2_numpatch_64.zip**.
28 * For Tomcat 10: **digdash_enterprise_2025R2_t10_64.zip** or **digdash_enterprise_2025R2_numpatch_t10_64.zip**.
29
30 After extraction, the folder will be called :
31
32 * For Tomcat 9: **digdash_enterprise_2025R2_64** or **digdash_enterprise_2025R2_numpatch_64**.
33 * For Tomcat 10: **digdash_enterprise_2025R2_t10_64** or **digdash_enterprise_2025R2_numpatch_t10_64**.
34
35 To clarify the procedure, the installation folder for the oldest version will be named **install_dd_OLD** and the installation folder for the most recent version will be named **install_dd_NEW.**
36 The version number can be seen at the bottom of the DigDash home page (or in the version.txt file in the archive).
37
38 **Supported configuration :**
39
40 * Server: **Tomcat 9** (Windows and Linux: Ubuntu 22.02)
41 **~ Tomcat 10** (Windows and Linux: Ubuntu 24.04).
42 * Server: **Java 17 only **(Windows and Linux)
43
44 = Best practices for version 2025 R2{{id name="Bonnes_pratiques"/}}{{id name="Bonnes_pratiques"/}} =
45
46 For optimum performance of DigDash Enterprise, we recommend that you apply the following recommendations:
47
48 * Use the **digdash.properties** file to store the configuration of the environments.
49 For more information on setting the parameters of the file, see the page [[Configuring the digdash.properties file>>doc:.DigDash\.properties.WebHome]].
50 * Use of an external database system for the DDAudit, Comments and DDDataEntry databases.
51 For more information on installing an external database system, see :
52 ** [[Installing MariaDB>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="DB_windows"]] for a **Windows** production environment.
53 ** [[Installing MariaDB>>doc:Digdash.deployment.installation.install_guide_ubuntu.Ubuntu22.WebHome||anchor="DB_ubuntu"]] for an** Ubuntu** production environment.
54 * Use of a Tomcat separate from the Digdash installation (installation via the OS package manager).
55 For more information on installing a separate Tomcat, see the section :
56 ** [[Installing Tomcat 9>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="Tomcat_windows"]] or Tomcat 10 for a **Windows** production environment.
57 ** [[Installing Tomcat 9>>doc:Digdash.deployment.installation.install_guide_ubuntu.Ubuntu22.WebHome||anchor="Tomcat_ubuntu"]] for an **Ubuntu 22.02** production environment.
58 ** [[Installing Tomcat 10>>doc:Digdash.deployment.installation.install_guide_ubuntu.Ubuntu24.WebHome||anchor="Tomcat_ubuntu"]] for an **Ubuntu 24.04** production environment.
59 * Using OpenDJ instead of adswrapper.
60 For more information on installing OpenDJ, see :
61 ** [[Installing OpenDJ>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="OpenDJ_Windows"]] for a **Windows** production environment.
62 ** [[Installing OpenDJ>>doc:Digdash.deployment.installation.install_guide_ubuntu.Ubuntu22.WebHome||anchor="OpenDJ"]] for an Ubuntu production environment.
63
64 = Upgrading DigDash Enterprise to version 2025 R2{{id name="Premier_deploiement"/}} =
65
66 This paragraph applies to you if you are upgrading DigDash Enterprise from version 2024 R1 or later to version 2025 R2.
67 If you are upgrading from a version earlier than 2024 R1, please contact DigDash at the following address [[(% 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 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 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 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 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 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 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 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 wikiinternallink" %)__contact@digdash.com__>>path:mailto:contact@digdash.com]](%%).
68
69 (% class="box warningmessage" %)
70 (((
71 The **JDBC drivers** have been updated and some of them need to be reinstalled. Please check your requirements in the following document: [[Add JDBC Driver ~> Pre-configured drivers not included>>doc:Digdash.deployment.Connectivity_Database.adding_jdbc_driver.WebHome||anchor="HDriversprE9configurE9snoninclus"]].
72 )))
73
74 == Upgrade procedure ==
75
76 === Step 1: Check the Java version used ===
77
78 (% class="box infomessage" %)
79 (((
80 ℹ Only when upgrading from a version prior to 2024 R2.
81 )))
82
83 Java 17 is mandatory from DigDash 2024 R2. To check the version currently used by tomcat, you can :
84
85 * Open the** **page **[[Server Status>>doc:Digdash.deployment.configuration.server_status.WebHome]]: the Java version in use is indicated in the General Status** section (in this case Java 17).
86 [[image:Java_server_status_EN.png||alt="Java version"]]
87 * Check the version by going to the Java directory:
88 *1. In a terminal, enter the following command:
89
90 {{code language="shell"}}
91 cd /usr/lib/jvm
92 ll
93 {{/code}}
94
95 (% start="2" %)
96 1. Look at which version the default-java symbolic link is currently pointing to.
97 In the example below, it is pointing to java 11.
98 [[image:Check_java_version_FR.png||alt="version Java"]]
99
100 If the version used is not Java 17, consult the page [[Changing the Java version>>doc:.changeJava.WebHome]] page to find out how to change version.
101
102 === Step 2: Back up your configuration ===
103
104 Make a full backup of your configuration: LDAP entries (users, roles, authorisation groups), data models, dashboards, etc.
105 If you have added files to your installation (modification of logos, images, css, addition of JSPs, etc.), you will need to carry them over to the new installation.
106 Consult the documentation [[Backup and restore>>doc:Digdash.deployment.configuration.backup_restore.WebHome]].
107
108 === Step 3: Stop the server{{id name="Stop_server"/}} ===
109
110 Stop the DigDash server:
111
112 * **Windows:** right-click on your service, then click on **Stop **from your Windows **Services** application.
113 * **Linux: **use the** command **##{{code language="shell"}}sudo service tomcat9 stop{{/code}} or {{code language="shell"}}sudo service tomcat10 stop{{/code}}
114 (depending on the version of tomcat installed)##
115
116 === Step 4: Backup and delete old applications ===
117
118 Back up and then delete the files and folders in **<install_dd>/webapps:**
119
120 (% border="0" style="width:563px" %)
121 |(% style="width:286px" %)(((
122 Folders :
123
124 * adminconsole
125 * ddenterpriseapi
126 * digdash_dashboard
127 * studio
128 )))|(% style="width:317px" %)(((
129 Files :
130
131 * adminconsole.war
132 * ddenterpriseapi.war
133 * digdash_dashboard.war
134 * studio.war
135 )))
136
137 (% class="box warningmessage" %)
138 (((
139 ❗ Do not delete the **ROOT** folder.
140 )))
141
142 === Step 5: Copy the new applications ===
143
144 Unzip the new version of the product into a temporary location.
145
146 Navigate in this temporary folder to the **webapps** folder **.**
147 Copy the following files to the same folder in your installation:
148
149 * adminconsole.war
150 * ddenterpriseapi.war
151 * digdash_dashboard.war
152 * studio.war
153
154 The **webapps **folder should now contain 4 .war files and the **ROOT** folder.
155
156 === Step 6: Recover the add-ons ===
157
158 Copy the contents of the **add-ons** directory to the same location in your installation.
159 If you have modified certain files **(importtools**, **backtuptools**, etc.), save them before copying.
160
161 === Step 7: Modify the JAVA_OPTS variable ===
162
163 A parameter must be added to the JAVA_OPTS variable.
164
165 ==== On Linux ====
166
167 1. Edit the following file:
168
169 {{code language="shell"}}sudo vi /etc/default/tomcat9{{/code}}or {{code language="shell"}}sudo vi /etc/default/tomcat10{{/code}}
170
171 depending on your version of tomcat.
172
173 (% start="2" %)
174 1. Add the parameter **~-~-add-opens=java.base/java.nio=ALL-UNNAMED** to the JAVA_OPTS variable to obtain the following result:
175
176 {{code language="shell"}}
177 JAVA_OPTS="-Djava.awt.headless=true -Xms6G -Xmx6G -Djava.security.egd=file:/dev/urandom -DPROP_MAX_CONCURRENT_TOTAL=5000 -DPROP_MAX_CONCURRENT_CON_PER_HOST=5000 --add-opens=java.base/java.nio=ALL-UNNAMED"
178 {{/code}}
179
180 ==== On Windows ====
181
182 1. Go to the Tomcat installation directory, then to the bin directory and run **tomcat9w.exe** or **tomcat10w.exe** depending on your version of Tomcat.
183 1. Go to the **Java** tab.
184 1. Add the parameter **~-~-add-opens=java.base/java.nio=ALL-UNNAMED** in Java 9 options as follows:
185 [[image:Java9_options_FR.png]]
186
187 === Step 8: Restart the server{{id name="Start_server"/}} ===
188
189 Restart the DigDash server:
190
191 * **On Windows:** right-click on your service, then click on **Start **from your Windows **Services** application.
192 * (((
193 **Linux: **use the** command **##{{code language="shell"}}sudo service tomcat9 start{{/code}} or {{code language="shell"}}sudo service tomcat10 start{{/code}}
194 (depending on the version of tomcat installed)##
195 )))
196
197 and let Tomcat redeploy the new applications.
198
199 On Linux, refer to the [[Linux Installation Guide>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||target="_blank"]].
200 On Windows, refer to the [[Windows Installation Guide>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||target="_blank"]].
201
202 === Step 9: Restore ===
203
204 If you have configured your new installation to point to your old data folder AND your old LDAP, restoration is not necessary.
205
206 If you are pointing to a new data folder, use the backup from step 2 to restore the data files (templates, portfolios, dashboards, etc).
207 Similarly, if you are pointing to a new LDAP folder, restore the LDAP entries (users, roles, authorisation groups),
208
209 (% class="box warningmessage" %)
210 (((
211 **Important:** if you have made changes to configuration files (web.xml, etc.), images or css files in the **ddenterpriseapi** and **digdash_dashboard** folders, you will need to carry them over.
212 )))
213
214 === Step 10: Clean the browser cache ===
215
216 Delete the browser cache (shortcut on most browsers: Ctrl + Shift + Delete).
217
218 === Step 11: Regenerate data models ===
219
220 (% class="box infomessage" %)
221 (((
222 (% id="cke_bm_413S" style="display:none" %)💡 (%%)Regeneration of data models is recommended in the case of a major version upgrade.
223 )))
224
225 The //EVENT_REFRESHFLOW_FORCEALL// event refreshes all flows in the system (except disabled flows) and forces regeneration of all cubes.
226
227 * Enter the URL in the following form in the browser to call this event** **via** **fireevent.
228 __http:~/~/localhost:8080/ddenterpriseapi/fireevent?eventid=EVENT_REFRESHFLOW_FORCEALL__
229
230 (% class="box infomessage" %)
231 (((
232 ℹ Replace //http:~/~/localhost:8080/ with //the address of your DigDash environment and //ddenterpriseapi //with the name of your domain.
233 )))
234
235
236
237 === Step 12: Reset default Authorization groups ===
238
239 New authorizations have been added. It is necessary to reset the authorizations groups provided by DigDash for them to be properly implemented.
240
241 (% class="box warningmessage" %)
242 (((
243 ⚠ If you have modified the authorizations groups, coreesponding changes will be lost.
244 )))
245
246
247
248 To do this:
249
250 1. Go to **Settings > User Management > Authorization Groups**: all authorization groups are listed there.
251 1. Click the **Reset Authorization Groups to Default** link.
252 ➡ A confirmation message will appear.
253 1. Click **OK**.
254
255 === Step 13: Modify the Dashboard theme{{id name="Dashboard_theme"/}} ===
256
257 (% class="box infomessage" %)
258 (((
259 ℹ Only when updating from a version prior to 2024 R2.
260 )))
261
262 Several changes have been made to the Dashboard theme in version 2024 R2:
263
264 * A new //digdash_2024// theme is now available.
265 * The //digdash_2019// theme has been modified following internal changes to the Dashboard and must be reset to avoid any problems displaying graphs and dashboards.
266 * The //digdash// theme has been removed.
267
268 Follow the instructions according to your situation.
269
270 ==== Changing to the new digdash_2024 theme{{id name="2024"/}} ====
271
272 If you wish to use the new //digdash_2024// theme as your server theme:
273
274 1. Go to **Configuration **-> **Server settings** -> **Additional settings** -> **Miscellaneous.**
275 1. In the **Theme** drop-down list, select** digdash_2024**.
276
277 ==== Using the digdash_2019 theme{{id name="2019"/}} ====
278
279 If you are using the //digdash_2019// theme (without customisation), you need to reset the theme. To do this
280
281 1. From the Studio, open the** Styles Manager.**
282 1. Right-click on the digdash_2019 theme and then click **Reset**.
283 [[image:Reinitialize_theme_EN.png]]
284 1. Click on** OK**.
285 1. Go to **Configuration **-> **Server settings** -> **Additional settings** -> **Miscellaneous **to check that the digdash_2019 theme is selected as the server theme.
286
287 ==== Using a custom digdash_2019 theme{{id name="2019_custom"/}} ====
288
289 If you use a custom //digdash_2019// theme:
290
291 1. Retrieve the changes/additions made inside the stylesheet and save them separately.
292 1. Reset the digdash_2019 theme as described in the previous paragraph.
293 1. Create a new custom theme using the Theme Editor.
294 1. Re-apply the changes/additions to the style sheet.
295 1. Go to **Configuration **-> **Server settings** -> **Additional settings** -> **Miscellaneous** to select the new custom theme as your server theme.
296
297 ==== Using the digdash theme ====
298
299 The //digdash// theme has been removed. If you were using the //digdash //theme //, //you can:
300
301 * select the //digdash_2024 //theme //: //see the paragraph [[Switching to the new digdash_2024 theme>>doc:||anchor="2024"]].
302 * select the //digdash_2019 //theme: see the paragraph [[Using the digdash_2019 theme>>doc:||anchor="2019"]].
303 * create a new custom theme: see [[Customising the dashboard theme>>doc:Digdash.customization.customization_DDE.custom_style.WebHome]].
304
305 == Step 13: Modify the Dashboard theme ==
306
307 The digdash_2024 and digdash_2024 themes have been modified to include the new Tiles chart and other options. They must therefore be reset.
308
309 (% class="box warningmessage" %)
310 (((
311 ⚠ If you have customized one of these themes, follow the steps described in the section //Using a Customized digdash_2019 Theme// above to recover your changes.
312 )))
313
314 To do this:
315
316 1. From the Studio, open the **Styles Manager**.
317 1. Right-click the **digdash_2024** and **digdash_2019** themes, respectively, then click **Reset**.
318 1. Click **OK**.
319
320 == Behavioural changes ==
321
322 New features or bug fixes in 2024 R2 can lead to changes in behaviour that are likely to have an impact. We therefore recommend that you consult the list of behavioural changes available on the dedicated page: [[Behaviour changes>>doc:Digdash.deployment.installation.behaviour_changes.WebHome]].
323
324 = Deploying a patch on a 2024 R2{{id name="Deploiement_patch"/}} =
325
326 This paragraph concerns updating a 2025 R2 version to a more recent 2025 R2 version.
327
328 It is assumed that your configuration follows the recommendation to use the **digdash.properties** file. If you have not done so, please refer to the paragraph [[Best practices for version 2025 R2>>doc:||anchor="Bonnes_pratiques"]].
329
330 (% class="box warningmessage" %)
331 (((
332 If your installation contains specific developments, which are located in the application folders:
333 **<install_dd>/apache-tomcat/webapps/ddenterpriseapi** or **<install_dd>/apache-tomcat/webapps/digdash_dashboard**
334 they will be lost during the upgrade. Save them before any other operation, so that you can carry them over after updating.
335 )))
336
337 (% class="wikigeneratedid" %)
338 The procedure for deploying a patch is now the same as for updating a version. You can therefore follow the procedure detailed above.