Guide de mise à jour

Modifié par mperroud le 2021/11/10 10:19

Ce document explique les différentes étapes à suivre pour mettre à jour votre déploiement DigDash Enterprise vers une nouvelle version.

Attention : Avant toute migration, faire une sauvegarde intégrale de l’application depuis la page d’accueil => Configuration => Gestion des sauvegardes.

Important : Migration des développements spécifiques (toutes versions)
Cette procédure ne prend pas en compte la migration de développements spécifiques (modification de logos, adjonction de JSP,...) qui peut être décrite dans vos procédures internes.
Si des développements spécifiques ont été faits, procédez à une copie de sauvegarde de votre installation actuelle afin de pouvoir récupérer et migrer tous ces développements.

Les archives d’installation de DigDash Enterprise sont nommées sous le modèle digdash_enterprise_2021R1_numpatch_64.zip.
Après extraction, le dossier s’appellera digdash_enterprise_2021R1_numpatch.

Pour expliciter la procédure, le dossier d’installation de la plus ancienne des versions sera nommé install_dd_OLD et le dossier d’installation de la plus récente des versions install_dd_NEW.
Le numéro de version est visible dans le fichier version.txt de l'archive ou depuis la page « Configuration / État du serveur » (« Version DigDash Enterprise » en haut à gauche dans la rubrique « État général »).

Prérequis minimum :

Recommendations :

  • Serveur : Tomcat 9 (Windows et Linux)
  • Serveur : Java 11 (Windows)
  • Desktop Studio : Java 8 à la dernière mise à jour (sécurité)
  • Web Studio : aucun prérequis (accessible dans le navigateur web comme le tableau de bord)

Sous linux vous devrez au minimum installer Java en suivant les recommendations.

Premier déploiement de la 2021 R1

Ce paragraphe vous concerne si vous déployez pour la 1ère fois la version 2021 R1.
Dans le cas du déploiement d'un patch pour la 2021 R1, voir le chapitre Déploiement d'un patch sur une 2021 R1.

Cette version permet de simplifier les processus d'installation, de configuration et de maintenance (installation d'un patch ou intervention du support).
Il est intéressant et vivement recommandé de reprendre de zéro l'installation pour cette mise à jour.
Le nouveau système de configuration vous fera gagner du temps par la suite.

Le principe général est de n'avoir à modifier qu'un seul fichier : digdash.properties, qui sera préservé automatiquement lors d'une prochaine mise à jour.
Ce fichier est fourni dans l'archive d'installation et comporte déjà tous les paramètres succeptibles d'être personnalisés lors de l'installation.

On distinguera deux cas principaux : utilisation du serveur Tomcat fourni (windows ou linux) ou utilisation de votre propre Tomcat.

Utilisation du Tomcat fourni

Étape 1 : Sauvegarde

Effectuez une sauvegarde complète de votre configuration : entrées LDAP (utilisateurs, rôles, groupes d'autorisations), modèles de données, tableaux de bord, etc.
Si vous aviez ajouté des fichiers à votre installation (modification de logos, imags, css, adjonction de JSP, ...) il faudra les reporter dans la nouvelle installation.

Voir documentation Sauvegarde et restauration.

Étape 2 : Arrêt du serveur

Arrêtez le serveur DigDash à l'aide de : <install_dd_OLD>/stop_tomcat.bat.
Ou sous Linux <install_dd_OLD>/apache-tomcat/bin/shutdown.sh.
Ou arrêtez le service correspondant.

Étape 3 : Extraction

  • Dézippez digdash_enterprise_2021R1_numpatch_64.zip à l'emplacement de votre choix grâce à un outils comme 7Zip.
  • Renommez le dossier contenant l'installation. L'idéal est un nom sans version, pour ne pas induire en erreur sur le contenu de l'installation lors des mises à jour à venir.
  • Vérifiez que votre dossier d'installation contient le fichier version.txt. C'est lui qui indiquera de manière certaine la version du produit (sans avoir à démarrer le serveur).

Étape 4 : Paramétrage

Si vous êtes sous Linux, copiez le fichier <install_dd_NEW>/digdash.properties dans le dossier /etc/digdash.
Il sera trouvé automatiquement par le serveur.
Veillez à ce que dossiers et fichiers aient les mêmes droits que l'utilisateur exécutant le service Tomcat.

Editez le fichier <install_dd_NEW>/digdash.properties.

Les lignes commençant par un seul caractère # sont celles à modifier.
En supprimant le caractère # en début de ligne vous activez le paramètre.

Emplacement des données

Lors de la configuration portez une attention particulière aux paramètres digdash.appdata ou <application>.AppDataPath.
L'idéal est d'utiliser le paramètre global digdash.appdata : toutes les applications utiliserons alors le même dossier racine.

Pour spécifier un emplacement commun à toutes les applications DigDash (ldap, serveur, studio, ...) il faut modifier le paramètre digdash.appdata :

#digdash.appdata=C:/appdata

devient :

digdash.appdata=C:/appdata

Attention à n'utiliser que des slash "/", ou deux anti-slash "\\".

Attention au dossier des données de l'annuaire LDAP. Il s'agit du dossier ldapdigdash (si vous ne l'aviez pas modifié).

  • Si vous utilisez le paramètre global digdash.appdata alors il faudra déplacer votre ancien dossier ldapdigdash dans le dossier spécifié dans ce paramètre.
  • Si vous voulez continuer à placer le dossier ldapdigdash dans un autre emplacement, utilisez le paramètre adswrapper.ads.instance.name.

Toutes les applications dans le même dossier (même LDAP) :

  • digdash.appdata=C:/data

Pour un dossier LDAP séparé :

  • adswrapper.ads.instance.name=D:/data/ldapdigdash

Les autres paramètres

Tous les autres paramètres présents dans ce fichier sont préfixés du nom de l'application concernée :

<nom de l'application>.<nom du paramètre>=<valeur>

Vous devez ainsi reporter tous les paramètres que vous aviez modifiés dans les fichiers web.xml de votre ancienne installation.

Par exemple, pour modifier la méthode d'authentification (authMethod) au Tableau de bord (digdash_dashboard.war) il faut modifier le paramètre digdash_dashboard.authMethod.

#digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom

devient : 

digdash_dashboard.authMethod=default/NTUser/NTUserOrLDAP/NTUserOrLDAP,loginForm/Custom

Etape 5 : Démarrage

Une fois que vous avez reporté tous les paramètres de votre ancienne installation dans le fichier digdash.properties, démarrez TOMCAT à l'aide de <install_dd_NEW>/start_tomcat.bat et laissez Tomcat redéployer les nouvelles applications.
Ou sous Linux <install_dd_OLD>/apache-tomcat/bin/startup.sh.

Pour une installation en tant que service sous Windows, utilisez le script <install_dd_NEW>/configure/servers_install_service.bat (attention au nom du service si vous l'aviez modifié lors de la précédente installation, référez vous au Guide d'installation Windows pour plus de détails).

Sous linux reportez vous au Guide d'installation Linux.
Plus d'informations sur l'installation en tant que service dans le Guide d'installation Windows.

Étape 6 : Restauration

Si vous avez configuré votre nouvelle installation pour pointer sur votre ancien dossier des données (voir Etape 5) la restauration n'est pas nécessaire.

Sinon (nouveau dossier des données) utilisez la sauvegarde de l’étape 1 pour restaurer les entrées LDAP (utilisateurs, rôles, groupes d'autorisations).

Important : si vous aviez fait des modifications dans les dossiers ddenterpriseapi et digdash_dashboard sur des fichiers de configuration (web.xml, ...), des images ou des fichiers css, vous devrez les reporter.

Note : Si vous venez d’une version 2017 R1 et si vous avez customisé les styles du tableau de bord, veuillez vous référer à la documentation Personnalisation pour mettre à jour vos styles CSS.

Étape 7 : Nettoyage du cache du navigateur

Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)

Utilisation de votre Tomcat

Si vous utilisez votre propre serveur Tomcat (Windows ou linux), la procédure à suivre est la même que pour le déploiement d'un patch,
vous pouvez donc suivre la procédure du chapitre suivant.

Seule l'étape 6 : Récupération des add-ons sera à adapter.
Vous n'aurez qu'à copier le dossier add-ons où cela vous convient (vous l'avez peut être déjà sur votre machine, mais il peut contenir des mises à jour).

Déploiement d'un patch sur une 2021 R1

Ce paragraphe concerne la mise à jour d'une version 2021 R1 vers une autre 2021 R1 plus récente.

La procédure qui suit part du principe que votre configuration suit la recommandation d'utiliser le fichier digdash.properties. Si cela n'est pas fait, référez vous au premier chapitre.

Si votre installation contient des développements spécifiques, qui se trouvent dans les dossiers des applications :
<install_dd>/apache-tomcat/webapps/ddenterpriseapi ou <install_dd>/apache-tomcat/webapps/digdash_dashboard
ils seront perdus lors de la mise à jour. Sauvegardez les avant toute autre opération, afin de pouvoir les reporter après mise à jour.

Étape 1 : Sauvegarde

Effectuez une sauvegarde complète de votre configuration : entrées LDAP (utilisateurs, rôles, groupes d'autorisations), modèles de données, tableaux de bord, etc.

N'oubliez pas les éventuels développements spécifiques pouvant se trouver dans les applications (voir l'encadré jaune précédent).

Voir documentation Sauvegarde et restauration.

Étape 2 : Arrêt du serveur

Arrêtez le serveur DigDash à l'aide de : <install_dd>/stop_tomcat.bat
Ou arrêtez le service correspondant.

Étape 3 : Suppression des anciennes applications

Sauvegardez puis effacez les fichiers et dossiers de <install_dd>/apache-tomcat/webapps :

Dossiers :

  • adminconsole
  • ddenterpriseapi
  • digdash_dashboard
  • studio
  • adswrapper

Fichiers :

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war
  • studio.war
  • adswrapper.war

Ne pas effacer le dossier ROOT.

Ne pas effacer le dossier ldapdigdash.

Étape 4 : Copie des nouvelles applications

Dézippez la nouvelle version du produit dans un emplacement temporaire.

Naviguez dans ce dossier temporaire jusque dans le dossier apache-tomcat/webapps.
Copiez les 5 fichiers suivants dans le même dossier de votre installation :

  • adminconsole.war
  • ddenterpriseapi.war
  • digdash_dashboard.war
  • studio.war
  • adswrapper.war

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

Étape 5 : Fichier version.txt

Copiez le fichier version.txt dans votre dossier d'installation. Il remplacera celui de la précédente installation.

Ce fichier permet de connaître la version du produit sans démarrer le serveur ou si la page "Etat du serveur" n'est pas disponible.

Étape 6 : Récuparation des add-ons

Copiez le contenu du répertoire add-ons vers le même endroit dans votre installation.
Si vous aviez modifiés certains fichiers (importtools, backtuptools, ...) sauvegardés les avant la copie.

Étape 7 : Démarrage

Démarrez Tomcat à l'aide de start_tomcat.bat /startup.sh et laissez Tomcat redéployer les nouvelles applications.

Si vous êtes en mode service relancez le manuellement.

Étape 8 : Nettoyage du cache du navigateur

Supprimez le cache du navigateur (raccourcis sur la pluspart des navigateurs : Ctrl + Shift + Suppr)

Version 2018 R2 ou inférieure vers 2021 R1

Contactez DigDash à l’adresse contact@digdash.com.