Wiki source code of Guide de mise à jour

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