Wiki source code of Guide de mise à jour

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