Upgrade guide

Last modified by Aurelie Bertrand on 2024/12/13 15:33


Introduction

Once you have upgraded to version 2024 R2, you cannot revert to an earlier version.

This guide describes the procedure and precautions to be taken to update your DigDash Enterprise version to the new 2024 R2 version.
Please consult page Behaviour changes to know about the behavioural changes introduced in this version.

This guide is relevant to you ONLY if you follow the good practices described in the dedicated paragraph.
If this is not the case, start the installation from scratch according to the Linux or Windows.

❗If you are using adswrapper (not recommended), an update has been made to version 2024 R1. Among other things, it corrects security problems.

❗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 document for details of the procedures to be followed.

Please noteMigration 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.

There are different DigDash Enterprise installation archives for Tomcat 9 and Tomcat 10. They are named as follows:

  • For Tomcat 9: digdash_enterprise_2024R2_64.zip or digdash_enterprise_2024R2_numpatch_64.zip.
  • For Tomcat 10: digdash_enterprise_2024R2_t10_64.zip or digdash_enterprise_2024R2_numpatch_t10_64.zip.

After extraction, the folder will be called :

  • For Tomcat 9: digdash_enterprise_2024R2_64 or digdash_enterprise_2024R2_numpatch_64.
  • For Tomcat 10: digdash_enterprise_2024R2_t10_64 or digdash_enterprise_2024R2_numpatch_t10_64.

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.
The version number can be seen at the bottom of the DigDash home page (or in the version.txt file in the archive).

Supported configuration :

  • Server: Tomcat 9 (Windows and Linux: Ubuntu 20.02 and 22.02)
     Tomcat 10 (Windows and Linux: Ubuntu 24.04).
  • Server: Java 17 only (Windows and Linux)

Best practices for version 2024 R2

For optimum performance of DigDash Enterprise, we recommend that you apply the following recommendations:

  • Use the digdash.properties file to store the configuration of the environments.
    For more information on setting the parameters of the file, see the page Configuring the digdash.properties file.
  • Use of an external database system for the DDAudit, Comments and DDDataEntry databases.
    For more information on installing an external database system, see :
  • Use of a Tomcat separate from the Digdash installation (installation via the OS package manager).
    For more information on installing a separate Tomcat, see the section :
  • Using OpenDJ instead of adswrapper.
    For more information on installing OpenDJ, see :

Upgrading DigDash Enterprise to version 2024 R2

This paragraph applies to you if you are upgrading DigDash Enterprise from version 2023 R1 or later to version 2024 R2.
If you are upgrading from a version earlier than 2023 R1, please contact DigDash at the following address contact@digdash.com.

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.

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.

Upgrade procedure

Step 1: Check the Java version used

Java 17 is mandatory for DigDash 2024 R2. To check the version currently used by tomcat, you can :

  • Open the page Server Status: the Java version in use is indicated in the General Status section (in this case Java 17).
    Java version
  • Check the version by going to the Java directory:
    1. In a terminal, enter the following command:
cd /usr/lib/jvm
ll
  1. Look at which version the default-java symbolic link is currently pointing to.
    In the example below, it is pointing to java 11.
    version Java

If the version used is not Java 17, consult the page Changing the Java version page to find out how to change version.

Step 2: Back up your configuration

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

Step 3: Stop the server

Stop the DigDash server:

  • Windows: right-click on your service, then click on Stop from your Windows Services application.
  • Linux: use the command sudo service tomcat9 stop or sudo service tomcat10 stop
    (depending on the version of tomcat installed)

Step 4: Backup and delete old applications

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

Folders :

  • adminconsole
  • ddenterpriseapi
  • digdash_dashboard
  • studio
  • adswrapper (not recommended)

Files :

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war
  • studio.war
  • adswrapper.war (not recommended)

❗ Do not delete the ROOT folder.

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

Step 5: 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 (not recommended)

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

Step 6: Recover 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 7: Modify the JAVA_OPTS variable

A parameter must be added to the JAVA_OPTS variable.

On Linux

  1. Edit the following file:

sudo vi /etc/default/tomcat9or sudo vi /etc/default/tomcat10

depending on your version of tomcat.

  1. Add the parameter --add-opens=java.base/java.nio=ALL-UNNAMED to the JAVA_OPTS variable to obtain the following result:
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"

On Windows

  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.
  2. Go to the Java tab.
  3. Add the parameter --add-opens=java.base/java.nio=ALL-UNNAMED in Java 9 options as follows:
    Java9_options_FR.png

Step 8: Restart the server

Restart the DigDash server:

  • On Windows: right-click on your service, then click on Start from your Windows Services application.
  • Linux: use the command sudo service tomcat9 start or sudo service tomcat10 start
    (depending on the version of tomcat installed)

and let Tomcat redeploy the new applications.

On Linux, refer to the Linux Installation Guide.
On Windows, refer to the Windows Installation Guide.

Step 9: Restore

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

If you are pointing to a new data folder, use the backup from step 2 to restore the data files (templates, portfolios, dashboards, etc).
Similarly, if you are pointing to a new LDAP folder, 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 10: Clean the browser cache

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

Step 11: Regenerate data models

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

The EVENT_REFRESHFLOW_FORCEALL event refreshes all flows in the system (except disabled flows) and forces regeneration of all cubes.

  • Enter the URL in the following form in the browser to call this event via fireevent.
    http://localhost:8080/ddenterpriseapi/fireevent?eventid=EVENT_REFRESHFLOW_FORCEALL

ℹ Replace http://localhost:8080/ with the address of your DigDash environment and ddenterpriseapi with the name of your domain.

Step 12: Modify the Dashboard theme

Several changes have been made to the Dashboard theme:

  • A new digdash_2024 theme is now available.
  • 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.
  • The digdash theme has been removed.

Follow the instructions according to your situation.

Changing to the new digdash_2024 theme

If you wish to use the new digdash_2024 theme as your server theme:

  1. Go to Configuration -> Server settings -> Additional settings -> Miscellaneous.
  2. In the Theme drop-down list, select digdash_2024.

Using the digdash_2019 theme

If you are using the digdash_2019 theme (without customisation), you need to reset the theme. To do this

  1. From the Studio, open the Styles Manager.
  2. Right-click on the digdash_2019 theme and then click on Reset.
    Reinitialize_theme_EN.png
  3. Click on OK.
  4. Go to Configuration -> Server settings -> Additional settings -> Miscellaneous to check that the digdash_2019 theme is selected as the server theme.

Using a custom digdash_2019 theme

If you are using a custom digdash_2019 theme:

  1. Retrieve the changes/additions made inside the stylesheet and save them separately.
  2. Reset the digdash_2019 theme as described in the previous paragraph.
  3. Create a new custom theme by following the theme variabilisation best practice. See page Customising the dashboard theme for a detailed description.
  4. Re-apply the changes/additions to the style sheet.
  5. Go to Configuration -> Server settings -> Additional settings -> Miscellaneous to select the new custom theme as your server theme.

Using the digdash theme

The digdash theme has been removed. If you were using the digdash theme you can:

Changes to the DDAudit module

The DDAudit module has been modified to version 2023 R1. If you 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 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.
  • 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 are using H2 as the database for DDAudit (not recommended), you will need to migrate your old database (see the document H2 database migration) before you can make these changes.

Behavioural changes

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.

Deploying a patch on a 2024 R2

This paragraph concerns updating a 2024 R2 version to a more recent 2024 R2 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 paragraph Best practices for version 2024 R2.

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

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