Upgrade Guide

Last modified by Aurelie Bertrand on 2024/11/12 17:14

This guide describes the procedure and precautions to be taken to update your version of DigDash Enterprise to the new version 2024 R1.
It also describes the behavioural changes introduced in this version.

This guide ONLY applies to you if you comply with the best practices described in the dedicated paragraph.
If this is not the case, restart the installation from scratch by following the Linux or Windows installation guide.

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

❗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 for more details on the procedures to follow.

Important : Migration of specific developments (all versions)

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.
If specific developments have been made, make a backup copy of your current installation so that you can recover and migrate all these developments.

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 :

  • when adapting your user import scripts,
  • in derived measurement formulas that would use ${user.langChoice} to determine the value of a measurement.
  • data filter formulas that use ${user.langChoice}.

DigDash Enterprise installation archives are named digdash_enterprise_2024R1_64.zip or digdash_enterprise_2024R1_numpatch_64.zip.
After extraction, the folder will be called digdash_enterprise_2024R1_64 or digdash_enterprise_2024R1_numpatch_64.
 

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

Supported configuration :

  • Server : Tomcat 9 (Windows and Linux)
  • Server : Java 17 recommended (Windows et Linux)
                  Java 11 supported

Best practices for version 2024 R1

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

Updating DigDash Enterprise to version 2024 R1

This paragraph applies to you if you are upgrading DigDash Enterprise from version 2022 R2 or later to version 2024 R1.
If you are upgrading from earlier to version 2022 R2, please contact DigDash at contact@digdash.com.

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.

The DDAudit module has been modified in version 2023R1. To find out more about the related instructions, see Changes to the DDAudit module.

Update procedure

Step 1 : Backup the configuration

Make a full backup of your configuration: LDAP entries (users, roles, authorization groups), data models, dashboards, etc.
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.
See the Backup and restore documentation.

Step 2 : Stop the server

Stop the DigDash server:

  • On Windows : right-click on your service ("Tomcat 9" by default), then click Stop from your Windows Services application.
  • On Linux : use the command service tomcat9 stop

Step 3 : Backup and delete old applications

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
  • digdash_dashboard.war
  • studio.war
  • adswrapper.war (non recommandé)

❗Do not delete the ROOT folder.

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

Step 4 : Copy the new applications

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

Navigate in this temporary folder to the webapps folder.
Copy the following files to the same folder in your installation:

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war
  • studio.war
  • adswrapper.war (non recommandé)

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

Step 5 : Recovering the add-ons

Copy the contents of the add-ons directory to the same location in your installation.
If you have modified certain files (importtools, backtuptools, etc.), save them before copying.

Step 6 : Restart the server

Restart the DigDash server :

  • On Windows : right-click on your service ("Tomcat 9" by default), then click on Start from your Windows Services application.
  • On Linux : use the command service tomcat9 restart.

and let Tomcat redeploy the new applications.

Step 7 : Restore

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

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

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.

Step 8: Clearing the browser cache

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

Step 9: Regeneration of data models

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

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

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.

1699610581319-917.png

Changes to the DDAudit module

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

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

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

Deploying a patch on a 2024 R1

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

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

If your installation contains specific developments, which are located in the applications folders :
<install_dd>/apache-tomcat/webapps/ddenterpriseapi or <install_dd>/apache-tomcat/webapps/digdash_dashboard
they will be lost during the update. Save them before any other operation, so that you recover them after updating.

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