Upgrade Guide

1

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

2

3

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

4

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

5

6

(% class="box warningmessage" %)

7

(((

8

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

9

)))

10

11

(% class="box warningmessage" %)

12

(((

13

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

14

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

15

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

16

\\Please note since version 2022R2, 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 :

17

18

* when adapting your user import scripts,

19

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

20

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

21

)))

22

23

DigDash Enterprise installation archives are named digdash_enterprise_2023R1_64.zip or digdash_enterprise_2023R1_numpatch_64.zip.

24

After extraction, the folder will be called digdash_enterprise_2023R1_64 or digdash_enterprise_2023R1_numpatch_64.

25

26

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.

27

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

28

29

**Supported configurations :**

30

\\Server : Tomcat 9 (Windows and Linux)

31

Server : Java 11 (Windows and Linux)

32

Under Linux you will need to install Java as a minimum, following the recommendations in the Installation Guide.

33

34

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

35

36

For DigDash Enterprise to work optimally, we recommend that you apply the following recommendations:

37

38

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

39

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

40

41

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

42

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

43

** [[Installation de MariaDB>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome||anchor="DB_windows"]] for Windows

44

** [[MariaDB (Préconisé)>>doc:Digdash.deployment.installation.install_guide_ubuntu_old.WebHome||anchor="DB_ubuntu"]] for Linux.

45

46

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

47

For more information on installing a separate Tomcat, see :

48

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

49

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

50

51

* Using OpenLDAP instead of adswrapper.

52

For more information on installing OpenLDAP, see :

53

** [[Installation de OpenLDAP>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome||anchor="OpenLDAP_windows"]] for Windows.

54

** [[Configuration de OpenLDAP>>doc:Digdash.deployment.installation.install_guide_ubuntu_old.WebHome||anchor="OpenLDAP_ubuntu"]] for Linux.

55

56

= Updating DigDash Enterprise to version 2023 R1 =

57

58

This paragraph applies to you if you are upgrading DigDash Enterprise from version 2021 R1 or later to version 2023 R1.

59

If you are upgrading from version 2021 R1 or earlier, please contact DigDash at contact@digdash.com.

60

61

(% class="box warningmessage" %)

62

(((

63

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

64

)))

65

66

(% class="box warningmessage" %)

67

(((

68

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

69

)))

70

71

== Update procedure ==

72

73

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

74

75

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

76

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.

77

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

78

79

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

80

81

Stop the DigDash server:

82

83

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

84

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

85

86

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

87

88

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

|(((

Dossiers :

* adminconsole

* ddenterpriseapi

* digdash_dashboard

* studio

)))|(((

Fichiers :

* adminconsole.war

* ddenterpriseapi.war

102

* digdash_dashboard.war

* studio.war

)))

(% class="box warningmessage" %)

107

(((

108

❗Ne pas effacer le dossier **ROOT**.

109

)))

110

111

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

112

113

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

114

115

Navigate in this temporary folder to the webapps folder.

116

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

117

118

* adminconsole.war

119

* ddenterpriseapi.war

120

* digdash_dashboard.war

121

* studio.war

122

123

Le dossier **webapps **doit maintenant contenir 4 fichiers .war et le dossier **ROOT**.

124

125

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

126

127

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

128

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

129

130

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

131

132

Restart the DigDash server :

133

134

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

135

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

136

137

et let Tomcat redeploy the new applications.

138

139

On Linux, refer to the [[Guide d'installation Linux>>doc:Digdash.deployment.installation.install_guide_ubuntu_old.WebHome]].

140

On Windows, refer to the [[Guide d'installation Windows>>doc:Digdash.deployment.installation.install_guide_windows_new.WebHome]].

141

142

=== Step 7 : Restore ===

143

144

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

145

146

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

147

148

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

149

150

=== Step 8: Clearing the browser cache ===

151

152

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

153

154

=== Step 9: Regeneration of data models ===

155

156

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

157

158

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

159

160

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

161

162

[[image:1699626888443-621.png]]

163

164

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

165

166

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

167

168

* 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 the <CMDR insert real name>

169

170

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

171

172

(% class="box warningmessage" %)

173

(((

174

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

175

)))

176

177

(% style="line-height: 1.38;" %)

178

= Behavioural changes in the 2023 R1 =

179

180

(% style="line-height:1.38" %)

181

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

(% class="box" %)

(((

💡 Items marked with an asterisk * are those for which it is possible, if necessary, to restore the previous behaviour. Please refer to the paragraph [[Restoring previous behaviour>>doc:||anchor="Previous_behaviour"]] for more information.

)))

== General ==

**Data detection***

Data type detection has been improved to automatically detect all data types.

**Optimisations***

Optimisations introduced in version 2022R2 caused potential regressions.These optimisations are now deactivated by default.

197

198

**Partial ES6 support***

199

200

Partial support for the ES6 (ECMAScript 6) version of the JavaScript language has been introduced. This provides a more modern syntax for scripts for calculated measures, column transformers, etc.

**User management**

CSV export of the user list now uses the comma separator instead of the semicolon separator.

205

CSV import of the user list now includes automatic detection of separators.

== Studio ==

**Chart and table settings**

210

211

Colour cycling on the Column or Bar axis is now enabled by default.

212

Line break on header is now enabled by default for tables.

**PDF/PPT builders**

Any picture inserted into a picture area of a PDF/PPT builder is now resized according to the size of this area and preserving its ratio. This was previously only the case for vector pictures.

217

218

(% class="box warningmessage" %)

219

(((

220

PDF/PPT templates created with a version prior to 2023 R1 must be edited to readjust the position of the pictures if necessary.

221

)))

222

223

**Non-modal translation**

224

225

When the **Use global dictionary** option is checked, the display name of an element (column, measure, flow, etc) is only saved in the global dictionary once the user has saved the data model, function, wallet or flow concerned (Apply button). Previously, the display name was saved automatically in the global dictionary .

226

227

228

**Crosstables : sorting***

229

230

In a crosstable, when a sort is applied to the dimension of a sub-column, the grouping of sub-columns under the parent column is now preserved. Previously, when this sort was applied, the sub-columns were each ungrouped under an individual parent column, as illustrated below with an ascending sort on the date.

231

232

[[image:1699867363308-155.png]]

233

234

This also applies to rows.

**Dashboard editor**

The private navigation of a dashboard page now includes variables by default in addition to the page filters. However, variables do not appear in the Navigation box. If private navigation is not defined for the entire page but only for certain filters, the variables are not included.

239

240

**Dashboard creation wizard**

241

242

The name of a calculated or derived measure can no longer be edited once it has been created.

**Dashboard**

Popup boxes displayed in the Dashboard (View comments, Edit comments, etc) can no longer be resized. They can still be repositioned.

**Documents**

When adding files to the **Documents** box in the Dashboard, it is no longer possible to upload several files simultaneously.

**Comments**

The Comment Editor box, used to add a comment, no longer includes the Filters section. This was used to modify the filters associated with the comment added.

255

256

A category can be assigned to a comment. The various available categories no longer have an associated icon.

257

258

== Restoring previous behaviour {{id name="Previous_behaviour"/}} ==

259

260

In some cases, it may be useful to restore previous behaviour.

261

For this, you need to edit the system.xml file located in <DD Install>\Enterprise Server\ddenterpriseapi\config\system.xml and add a property line specifying the behaviour.

262

This operation requires a restart of the DigDash server.

**Data detection**

Add the line:

between <SystemProperties> and </SystemProperties>.

**Optimisations**

Add the line:

between <SystemProperties> and </SystemProperties>.

275

276

**Partial ES6 support**

Add the line:

between <SystemProperties> and </SystemProperties>.

281

282

**Crosstabs: sorting**

Add the line:

between <SystemProperties> and </SystemProperties>.

287

288

= Deploying a patch on a 2023 R1 =

289

290

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

291

292

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 2023 R1>>doc:||anchor="Bonnes_pratiques"]] paragraph.

293

294

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

295

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

296

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

Wiki source code of Guide de mise à jour

Sommaire