Upgrade Guide

Last modified by jhurst on 2022/04/28 16:42

This document describes the different steps needed to upgrade your existing DigDash Enterprise deployment to a newer version.

Please read the chapter corresponding to your current version:

Important: Before any migration, make a full backup of the application from the home page => Configuration => Backup Management.

Important: Tomcat 7 / adswrapper incompatibility (version 2018R2 and above)

In 2018 R2, the new version of adswrapper.war (LDAP directory) is incompatible with Tomcat 7. You must either upgrade your Tomcat or keep your adswrapper.war file during the procedure.

Important: Migration of specific developments (all versions)

This procedure does not take into account the migration of specific developments (modification of logos, addition of JSP, ...) that can be described in your internal procedures. If specific developments have been made, you should backup the old application in order to recover and migrate all these developments.

Important: Technological update in the dashboard application (2017 R2 and above)

In the 2017 R2 (2017B0929) and later versions, a change in the technology of the dashboard application leads to incompatibilities on some CSS styles. If you come from a version prior to 2017R2 and if you have customized dashboard styles, please refer to the documentation customization_en.pdf.

The installation folders for DigDash Enterprise are named under the template install_dd_numversion_64.zip ou digdash_enterprise_numversion_64.zip

After unzipping, the file will be called install_dd_numversion or digdash_enterprise_numversion.

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

DigDash Enterprise version is visible in the "Configuration/server Status" page ("DigDash Enterprise Version" at the top left in the "Global Status" section).

  1. UPGRADE TO THE 2019 R1 VERSION

This section is about updating all versions from 2017R1 to 2019R1.

Step 1 :

Make a full backup of your configuration: LDAP entries (users, roles, permission groups), data models, dashboards, and so on.

See documentation configuration_guide_fr.pdf, chapter "Save data".

Step 2 :

Stop the DigDash servers (TOMCAT, LDAP) using:

<install_dd_OLD>/stop_tomcat.bat or <install_dd_OLD>/stop_servers.bat

Step 3 :

Save and delete the files and folders of <install_dd_OLD>/apache-tomcat/webapps/

(Caution: Do not delete the ROOT folder) :

  • adminconsole (folder)
  • adminconsole.war (file)
  • ddenterpriseapi (folder)
  • ddenterpriseapi.war (file)
  • digdash_dashboard (folder)
  • digdash_dashboard.war (file)

Step 4:

If you want to upgrade adswrapper, use a version of Tomcat at least equal to version 8 (provided by DigDash from version 2018 R2) and delete the following files:

  • adswrapper.war (file)
  • adswrapper (folder)
  • ldapdigdash (save the file before deleting it).

Be sure to validate that your backup of step 1 contains the LDAP entries.

Step 5 :

Unzip digdash_enterprise_numversion_64.zip and navigate in <install_dd_NEW>/apache- tomcat/webapps/

Step 6 :

Copy the following 4 files from <install_dd_NEW>/apache-tomcat/webapps to <install_dd_OLD >/apache-tomcat/webapps/ :

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war
  • adswrapper.war (only if you deleted it at step 4).

The webapps folder now needs to contain 4 files .war and the ROOT folder.

Step 7 :

Delete the folders :

  • <install_dd_OLD>/documentation
  • <install_dd_OLD>/apache- tomcat/webapps/ROOT/documentation
  • <install_dd_OLD>/add-ons

Extract and copy the documentation and the add-ons :

  • Copy the directory <install_dd_NEW>/documentation vers <install_dd_OLD>
  • Copy the directory <install_dd_NEW>/apache-tomcat/webapps/ROOT/documentation vers <install_dd_OLD>/apache-tomcat/webapps/ROOT
  • Copy the directory <install_dd_NEW>/add-ons vers <install_dd_OLD>

You can rename the folder <install_dd_OLD> in <install_dd_AAAAMMJJ> where AAAAMMJJ corresponds to a date.

Step 8 :

Just start TOMCAT with the help of <install_dd_AAAAMMJJ>/start_tomcat.bat and let TOMCAT redeploy the new applications.

Step 9 :

Clean the browser cache.

Step 10 :

Use the backup from step 1 to restore the LDAP entries (users, roles, permission groups) if you upgraded adswrapper in step 4. See documentation configuration_guide_en.pdf, chapter "Backing Up Data."

Important : if you made changes in the ddenterpriseapi and digdash_dashboard folders on configuration files (web.xml, ...), images or css files, you will have to postpone them.

Note : If you update from a 2017R1 version and have customized the dashboard styles, please refer to the customization_en.pdf documentation to upgrade your CSS styles.

  1. UPGRADE TO A PATCHED VERSION

This paragraph is about upgrading the 2017 or 2018 versions to a patched version:

• 2019 R1 to 2019 R1 patched

• 2018 R2 to 2018 R2 patched

• 2018 R1 to 2018 R1 patched

• 2017 R2 (2017B0929) to 2017 R2 patched

• 2017 R1 (2017B0329) to 2017 R1 patched

Step 1 :

Make a full backup of your configuration: LDAP entries (users, roles, permission groups), data models, dashboards, and so on. See documentation configuration_guide_en.pdf, chapter "Save data".

Step 2 :

Stop the DigDash servers (TOMCAT, LDAP) using: <install_dd_OLD>/stop_tomcat.bat ou <install_dd_OLD>/stop_servers.bat

Step 3 :

Back up and then delete the files and folders from <install_dd_OLD>/apache-tomcat/webapps/

(Caution: Do not delete the ROOT folder):

  • adminconsole (folder)
  • adminconsole.war (file)
  • ddenterpriseapi (folder)
  • ddenterpriseapi.war (file)
  • digdash_dashboard (folder)
  • digdash_dashboard.war (file)

Do not delete the following files and folders if they are present on your server:

  • adswrapper (folder)
  • adswrapper.war (file)
  • ldapdigdash (folder)

Step 4 :

Unzip install_dd_NEW and navigate in <install_dd_NEW>/apache-tomcat/webapps/

Step 5 :

Copy the following 3 files from <install_dd_NEW>/apache-tomcat/webapps to <install_dd_OLD >/apache-tomcat/webapps/ :

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war

The webapps folders should now contain 4 .war files, an adswrapper folder, and the ROOT folder.

Step 6 :

Extract and copy the documentation and the add-ons:

  • Copy the contents of the directory <instal_dd_NEW>/documentation to <install_dd_OLD>/documentation
  • Copy the contents of the directory <install_dd_NEW>/apache-  tomcat/webapps/ROOT/documentation to <install_dd_OLD>/apache-  tomcat/webapps/ROOT/documentation
  • Copy the contents of the directory <install_dd_NEW>/add-ons to <install_dd_OLD>/add-ons

You can rename the folder <install_dd_OLD> in <install_dd_AAAAMMJJ> where AAAAMMJJ corresponds to a date.

Step 7 :

Just start TOMCAT using <install_dd_AAAAMMJJ>/start_tomcat.bat and let TOMCAT redeploy the new applications.

Step 8 :

Clear your browser cache.