Upgrade guide

1

This guide describes the procedure and precautions to be taken to update your version of DigDash Enterprise to the new version 2024 R1.

2

It also describes the behavioural changes introduced in this version.

3

4

This guide ONLY applies to you if you comply with the [[best practices>>doc:||anchor="Bonnes_pratiques"]] described in the dedicated paragraph.

5

If this is not the case, restart the installation from scratch by following the [[Linux>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome]] or [[Windows>>doc:Digdash.deployment.installation.install_guide_windows.WebHome]] installation guide.

6

7

(% class="box warningmessage" %)

8

(((

9

❗If you use **adswrapper** (not recommended), an update has been made in version 2024 R1. It notably addresses security issues.

10

11

❗If you are using an **H2 database** (not recommended), it has been updated in version 2023 R1. Older versions of the H2 database (DDAudit, Comments and DDDataEntry) are not compatible with this version. Please refer to the topic [[Migrating H2 database>>doc:.H2_database.WebHome]] for more details on the procedures to follow.

12

)))

13

14

(% class="box warningmessage" %)

15

(((

16

**Important : Migration of specific developments (all versions)**

17

\\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.

18

If specific developments have been made, make a backup copy of your current installation so that you can recover and migrate all these developments.

19

\\Please note since version 2022 R2, the value of the langChoice user parameter is now a language code rather than an index. For example, 0 has become "en" and 1 has become "fr". This change must be taken into account :

20

21

* when adapting your user import scripts,

22

* in derived measurement formulas that would use ${user.langChoice} to determine the value of a measurement.

23

* data filter formulas that use ${user.langChoice}.

24

)))

25

26

DigDash Enterprise installation archives are named digdash_enterprise_2024R1_64.zip or digdash_enterprise_2024R1_numpatch_64.zip.

27

After extraction, the folder will be called digdash_enterprise_2024R1_64 or digdash_enterprise_2024R1_numpatch_64.

28

29

30

To clarify the procedure, the installation folder for the older version will be named install_dd_OLD and the installation folder for the most recent version will be named install_dd_NEW.

31

The version number can be seen in the archive's version.txt file or from the "**Configuration / Server Status**" page ("DigDash Enterprise Version" in the top left-hand corner of the "**General Status**" section).

32

33

**Supported configuration :**

34

35

* Server : **Tomcat 9 **(Windows and Linux)

36

* Server : **Java 17 **recommended (Windows et Linux)

37

Java 11** **supported

38

39

= Best practices for version 2024 R1{{id name="Bonnes_pratiques"/}}{{id name="Bonnes_pratiques"/}} =

40

41

For optimal operation of DigDash Enterprise, it is recommended to apply the following guidelines:

42

43

* Use of the digdash.properties file to store the configuration of environments.

44

For more information on how to set up the file, see the page [[Configuring the digdash.properties file>>doc:.DigDash\.properties.WebHome]]

45

46

* Use of an external database system for the DDAudit, Comments and DDDataEntry databases.

47

For more information on installing an external database system, see :

48

** [[Installing MariaDB>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="DB_windows"]] for Windows

49

** [[Installing MariaDB>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="DB_ubuntu"]] for Linux.

50

51

* Use of a Tomcat separate from the Digdash installation (installation via the OS package manager).

52

For more information on installing a separate Tomcat, see :

53

** [[Installing Tomcat 9>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="Tomcat_windows"]] for Windows.

54

** [[Installing Tomcat 9>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="Tomcat_ubuntu"]] for Linux.

55

56

* Use of OpenDJ instead of adswrapper.

57

For more information on installing OpenLDAP, see :

58

** [[Installing OpenDJ>>doc:Digdash.deployment.installation.install_guide_windows.WebHome||anchor="OpenDJ"]] for Windows.

59

** [[Installing OpenDJ>>doc:Digdash.deployment.installation.install_guide_ubuntu.WebHome||anchor="OpenDJ"]] for Linux.

60

61

= Updating DigDash Enterprise to version 2024 R1 =

62

63

This paragraph applies to you if you are upgrading DigDash Enterprise from version 2022 R2 or later to version 2024 R1.

64

If you are upgrading from earlier to version 2022 R2, please contact DigDash at contact@digdash.com.

65

66

(% class="box warningmessage" %)

67

(((

68

The JDBC drivers have been updated and some of them need to be reinstalled. Please check your requirements in the following page [[Adding a JDBC driver ~> Pre-configured drivers, not included>>doc:Digdash.deployment.Connectivity_Database.adding_jdbc_driver.WebHome||anchor="Drivers"]].

69

)))

70

71

(% class="box warningmessage" %)

72

(((

73

The DDAudit module has been modified in version 2023R1. To find out more about the related instructions, see [[Changes to the DDAudit module>>doc:||anchor="DDAudit"]].

74

)))

75

76

== Update procedure ==

77

78

=== Step 1 : Backup the configuration ===

79

80

Make a full backup of your configuration: LDAP entries (users, roles, authorization groups), data models, dashboards, etc.

81

If you have added files to your installation (modified logos, images, css, added JSPs, etc.), you will need to carry them over to the new installation.

82

See the [[Backup and restore>>doc:Digdash.deployment.configuration.backup_restore.WebHome]] documentation.

83

84

=== Step 2 : Stop the server ===

85

86

Stop the DigDash server:

87

88

* **On Windows** : right-click on your service ("Tomcat 9" by default), then click **Stop** from your Windows **Services** application.

89

* **On Linux** : use the command ##{{code}}service tomcat9 stop{{/code}}##

90

91

=== Step 3 : Backup and delete old applications ===

92

93

Back up and then delete the files and folders in <install_dd>/webapps :

|(((

Dossiers :

* adminconsole

* ddenterpriseapi

* digdash_dashboard

* studio

* adswrapper (not recommend)

)))|(((

Fichiers :

* adminconsole.war

* ddenterpriseapi.war

108

* digdash_dashboard.war

109

* studio.war

110

* adswrapper.war (non recommandé)

111

)))

112

113

(% class="box warningmessage" %)

114

(((

115

❗Do not delete the **ROOT **folder.

116

117

Do not delete the **ldapdigdash** folder if used. The ldapdigdash directory is related to adswrapper (not recommended).

118

)))

119

120

=== Step 4 : Copy the new applications ===

121

122

Unzip the new version of the product into a temporary location.

123

124

Navigate in this temporary folder to the webapps folder.

125

Copy the following files to the same folder in your installation:

126

127

* adminconsole.war

128

* ddenterpriseapi.war

129

* digdash_dashboard.war

130

* studio.war

131

* adswrapper.war (non recommandé)

132

133

The **webapps** folder should now contain 4 .war files (5 if you are using adswrapper) and the **ROOT** directory.

134

135

=== Step 5 : Recover the add-ons ===

136

137

Copy the contents of the **add-ons** directory to the same location in your installation.

138

If you have modified certain files (**importtools**, **backtuptools**, etc.), save them before copying.

139

140

=== Step 6 : Restart the server ===

141

142

Restart the DigDash server :

143

144

* **On Windows** : right-click on your service ("Tomcat 9" by default), then click on **Start** from your Windows **Services** application.

145

* **On Linux **: use the command ##{{code}}service tomcat9 restart{{/code}}.##

146

147

and let Tomcat redeploy the new applications.

148

149

=== Step 7 : Restore ===

150

151

If you have configured your new installation to point to your old data folder, restoration is not necessary.

152

153

Otherwise (new data folder) use the backup from step 1 to restore the LDAP entries (users, roles, authorisation groups).

154

155

(% class="box warningmessage" %)

156

(((

157

**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.

158

)))

159

160

=== Step 8 : Clear the browser cache ===

161

162

Delete the browser cache (shortcut on most browsers: Ctrl + Shift + Delete).

163

164

=== Step 9 : Regenerate the data models ===

165

166

Regeneration of data models is recommended in the case of a major version upgrade.

167

168

In the Studio **Flows **tab, right-click on each flow wallet and then click **Synchronise for users**.

169

170

In the **Confirm role wallet synchronization **box, check the **Force data cubes generation of the selected flows** box and then the **Force generation of all the dependent cubes** box.

171

172

[[image:1699610581319-917.png||queryString="width=442&height=269" height="269" width="442"]]

173

174

== Changes to the DDAudit module{{id name="DDAudit"/}} ==

175

176

The DDAudit module has been modified in version 2023 R1. If you have deployed DDAudit in a previous version, please follow the instructions below:

177

178

* If you have not modified the DDAudit templates and flows, and if you have not created new templates and flows, then it is recommended to uninstall the DDAudit module, delete the role and its data and then reinstall it from the installation zip for this new version, or via Digdash Metadate Service.

179

180

* 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).

181

182

(% class="box warningmessage" %)

183

(((

184

❗If you use H2 as your database for DDAudit (not recommended), you will need to migrate your old database (see topic [[Migrating H2 database>>doc:.H2_database.WebHome]]) before you can make these changes.

185

)))

186

187

= Behavioural changes in 2024 R1 =

188

189

New features or bug fixes in 2024 R1 have resulted in behavioural changes that may have an impact. We therefore recommend that you consult the following list of behavioural changes.

== Security ==

**IODS**

IODS configuration must now be done in the digdash.properties file or in the command line settings instead of the Server settings page.

**File Server**

A user with authorization (ACL) //Upload document// who does not have write permissions on a role, no longer has the ability to upload a document to a file server shared with this role.

200

201

**Authorizations (ACL)**

202

203

New //Content > List documents// and //Content > List document servers// authorizations may impact behavior. When you add the //Admin > Manage users content// authorization to a user, you must also add the //Content > List documents// and //Content > List document servers// permissions to them, otherwise they will not be able to manage the user's content. The opposite is not true, you may want to add //Content > List documents// and //Content > List document servers// without Admin > //Manage users content//. The user could list the documents and servers to which he has access.

**Configuration**

The js and css files of the "adminconsole" part (home and administration pages) are now versioned. It is no longer necessary to clear the cache during a version upgrade.

== Studio ==

**Data Models**

It is now possible to use columns with different names as key columns for data model union.

214

215

**Label (legend) of a dimension**

216

217

The term **Label** replaces the term Legend.

**Managers**

Access to **Managers** is now done from a dedicated button on the left of the Studio window.

**PDF Builder**

The **Always start at end of table** option has been removed.

**Filters**

The add filter window now automatically selects the same hierarchical level as the dimension used in the chart and no longer the root level.

**Format**

The **Area (acre)** format now uses a thousands separator.

== Charts ==

**Targets in tables**

238

239

Targets used in tables are now displayed in the legend.

**Bar chart labels**

The display of stacked bar content labels differs depending on whether they contain fixed or variable data:

244

245

* In the case the label contains data that varies dynamically depending on the bar on which it is located (for example, for the keywords Value, Member, Absolute Value and Percentage Value), a label is displayed for each stacking bar.

246

* In the case the label contains only fixed data per bar (for keywords other than those mentioned above), a single label is displayed at the top of the stacked bars (to the right of the stacked bars in the case the data are positive or combination of positive/negative data, to the left when the values are only negative).

247

248

Note that if the user does not choose to display the label at the top, the label is displayed from the zero axis only once if it contains only fixed data, and within each bar if it contains variable data.

**Map charts**

The //Others// value does not impact the color gradient.

== Dashboard ==

**Comments**

Comments are now updated every 30 seconds.

259

260

**Dashboard objects**

261

262

Display on click is now selected by default for retractable objects.

**Sorting tables**

It is now possible to sort tables (simple and tree) on several dimensions.

**Mobile**

The old interface dedicated to mobile has been deprecated. If the user tries to access it with the link as [[http:~~/~~/localhost:8080/ddenterpriseapi/mobile>>http://localhost:8080/ddenterpriseapi/mobile]], an error message is displayed.

271

272

= Deploying a patch on a 2024 R1 =

273

274

This paragraph is about updating a 2024 R1 version to a more recent 2024 R1 version.

275

276

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 [[Best practices for version 2024 R1>>doc:||anchor="Bonnes_pratiques"]] paragraph.

277

278

(% class="box warningmessage" %)

279

(((

280

If your installation contains specific developments, which are located in the applications folders :

281

**<install_dd>/apache-tomcat/webapps/ddenterpriseapi or <install_dd>/apache-tomcat/webapps/digdash_dashboard**

282

they will be lost during the update. Save them before any other operation, so that you recover them after updating.

283

)))

284

285

The procedure for deploying a patch is now identical to updating the version. You can therefore follow the procedure detailed above.

Wiki source code of Guide de mise à jour

Sommaire