Upgrade Guide

1

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

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>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/install_guide_ubuntu/]] or [[Windows>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/install_guide_windows_new/]] installation guide.

6

7

(% class="box warningmessage" %)

8

(((

9

❗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>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/upgrade_dde/H2_database/]] for more details on the procedures to follow.

10

)))

11

12

(% class="box warningmessage" %)

13

(((

14

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

15

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

16

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

17

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

18

19

* when adapting your user import scripts,

20

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

21

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

22

)))

23

24

DigDash Enterprise installation archives are named digdash_enterprise_2023R2_64.zip or digdash_enterprise_2023R2_numpatch_64.zip.

25

After extraction, the folder will be called digdash_enterprise_2023R2_64 or digdash_enterprise_2023R2_numpatch_64.

26

27

28

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.

29

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

30

31

32

**Supported configurations :**

33

\\Server : Tomcat 9 (Windows and Linux)

34

Server : Java 11 (Windows and Linux)

35

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

36

37

38

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

39

40

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

41

42

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

43

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

44

45

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

46

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

47

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

48

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

49

50

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

51

For more information on installing a separate Tomcat, see :

52

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

53

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

54

55

* Using OpenLDAP instead of adswrapper.

56

For more information on installing OpenLDAP, see :

57

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

58

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

59

60

=

61

Updating DigDash Enterprise to version 2023 R2 =

62

63

64

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

65

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

66

67

(% class="box warningmessage" %)

68

(((

69

The JDBC drivers have been updated and some of them need to be reinstalled. Please check your requirements in the following document : [[Ajout Pilote JDBC ~> Drivers préconfigurés non inclus>>path:/xwiki/wiki/dev/view/Digdash/deployment/Connectivity_Database/adding_jdbc_driver/#HDriversprE9configurE9snoninclus]]

70

)))

71

72

(% class="box warningmessage" %)

73

(((

74

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"]].

75

)))

76

77

== Update procedure ==

78

79

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

80

81

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

82

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.

83

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

84

85

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

86

87

Stop the DigDash server:

88

89

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

90

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

91

92

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

93

94

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

|(((

Dossiers :

* adminconsole

* ddenterpriseapi

* digdash_dashboard

* studio

)))|(((

Fichiers :

* adminconsole.war

* ddenterpriseapi.war

108

* digdash_dashboard.war

* studio.war

)))

(% class="box warningmessage" %)

113

(((

114

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

115

)))

116

117

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

118

119

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

120

121

Navigate in this temporary folder to the webapps folder.

122

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

123

124

* adminconsole.war

125

* ddenterpriseapi.war

126

* digdash_dashboard.war

127

* studio.war

128

129

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

130

131

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

132

133

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

134

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

135

136

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

137

138

Restart the DigDash server :

139

140

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

141

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

142

143

et let Tomcat redeploy the new applications.

144

145

On Linux, refer to the [[Guide d'installation Linux>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/install_guide_ubuntu/]].

146

On Windows, refer to the [[Guide d'installation Windows>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/install_guide_windows_new/]].

147

148

=== Step 7 : Restore ===

149

150

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

151

152

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

153

154

(% class="box warningmessage" %)

155

(((

156

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

157

)))

158

159

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

160

161

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

162

163

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

164

165

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

166

167

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

168

169

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.

170

171

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

172

173

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

174

175

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

176

177

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

178

179

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

180

181

(% class="box warningmessage" %)

182

(((

183

❗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>>path:/xwiki/wiki/dev/view/Digdash/deployment/installation/upgrade_dde/H2_database/]]) before you can make these changes.

184

)))

185

186

= Behavioural changes in 2023 R2 =

187

188

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

(% 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 for more information.

)))

== Security ==

**Cube display**

The user must now have //**Manage Servers**// authorization and add the parameter **showCubes=true** to the url in order to display cubes on the Backup page.

200

201

**Importing files into the Dashboard Creation Wizard**

202

203

The user must now have the //**Upload a document **//authorization to import files into the Dashboard Creation Wizard.

== Datasources ==

**Postgreqsl**

The AUTO_COMMIT property is now disabled by default for queries on data sources.

210

211

== User management ==

212

213

For Accessible dashboard pages and Accessible dashboard portlets, the user's value is now concatenated with the values of the profiles assigned to them.

214

215

== Server parameters ==

216

217

Changing settings for the Audit and Comments databases no longer requires a server restart.

== Backup ==

When making a backup, when you check **Export dependent files (data files from Common Datasources server, customs icons, style sheets, etc.)**, pictures referenced in the dashboards are now included.

== Studio ==

The chart editing interface has been redesigned to improve the user experience.

226

A set of features/properties has been moved. See topic [[Changements édition des graphiques>>path:/xwiki/wiki/dev/view/Digdash/user_guide/studio/Find_items/]] for help.

227

228

== Document builders ==

229

230

The page numbering mechanism has changed.

231

Document builders for which page numbering was previously activated will now have a text box generated in the footer in the bottom right-hand corner containing ${builder.pageIndex}/${builder.pageCount} (page number/number of pages).

232

233

== Dashboard editor ==

**Background**

If a background is defined in the **Settings -> Properties -> Dashboard** interface, it will now be applied by default to all newly added roles.

**Styles**

The default CSS file "default.css" is no longer automatically loaded.

242

For users using default.css, no CSS will be loaded. To continue using it, you need to define it in Dashboard Editor -> Properties > Styles.

== Charts ==

**Sorting in tables**

247

248

The sorting arrow is now placed to the left of the cell (to avoid overlapping with the text).

**Table pagination**

A new pagination method for very large tables avoids excessive loading times.

253

By default, pagination is activated with 100 lines per page and virtual scrolling is deactivated.

254

The pagination buttons are disabled if the number of rows on the current page is less than the total number of rows on the page defined in the user interface (100 by default).

== Export ==

**File name**

The name of the exported file is now the name of the flow without hyphen. For example, "My flow" is exported in the file "My flow". Previously, "My flow" was exported to the "My_flow" file.

**Crosstables**

When exporting a crosstable in Excel without styles, the header cells are now merged.

**Excel export**

Excel export without styles is now only authorized for tables.

271

272

273

**Font size proportional to chart size**

274

275

The **Font size proportional to chart size** option is no longer available for charts of the Table, HTML Report and Text Report types. If this option was activated in a previous version, it will no longer work.

== DDAudit ==

**List of cubes***

The list of cubes refreshed in the audit database is no longer cleaned every day. It is now kept in the database for 6 months (default setting).

**Memory**

In DDAudit, the **Memory** field now corresponds to the actual size of the cube in memory.

== Miscellaneous ==

**Cube memory size**

The cube memory size now includes the size of the attached data. This means that the size changes after the cube is loaded, depending on how data is loaded and used.

**Scripts and date**

The getFullYear() method is now available to get the date. It returns the year of the date entered, based on local time.

296

Previously, you had to use getYear() + 1900. This method canstill be used but is not recommended.

297

298

== Restoring previous behaviour ==

299

300

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

301

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.

302

This operation requires a restart of the DigDash server.

**Cube list**

Change the value of the following property to// false// :

307

308

309

= Deploying a patch on a 2023 R2 =

310

311

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

312

313

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

314

315

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

316

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

317

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