Guide de mise à jour

Modifié par Aurelie Bertrand le 2024/06/06 17:02

Introduction

Ce guide décrit la procédure et les précautions à prendre pour mettre à jour votre version DigDash Enterprise vers la nouvelle version 2024R1.
Il présente également les modifications de comportement introduites dans cette version.

Ce guide vous concerne UNIQUEMENT si vous respectez les bonnes pratiques décrites dans le paragraphe dédié.
Si ce n'est pas le cas, reprenez l'installation de zéro selon le guide d'installation Linux ou Windows.

❗Si vous utilisez adswrapper (non recommandée), une mise à jour a été effectuée dans la version 2024R1. Elle permet notamment de corriger des problèmes de sécurité.

❗Si vous utilisez une base de données H2 (non recommandé), une mise à jour a été effectuée dans la version 2023 R1. Les anciennes versions de base de données H2 (DDAudit, Comments et DDDataEntry) ne sont pas compatibles avec cette version. Veuillez consulter le document Migration base de données H2  pour le détail des procédures à suivre.

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, scripts d'import utilisateurs...) 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.

Important : Depuis la version 2022R2, la valeur du paramètre utilisateur langChoice est maintenant un code langue et non plus un index. Par exemple 0 est devenu "en", 1 est devenu "fr". Il faut prendre en compte ce changement :

  • dans l'adaptation de vos scripts d'import des utilisateurs,
  • dans les formules de mesures dérivées qui utiliseraient ${user.langChoice} pour déterminer la valeur d'une mesure.
  • dans les formules de filtrages de données qui utiliseraient ${user.langChoice}.

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

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

Configuration supportée :

  • Serveur : Tomcat 9 (Windows et Linux)
  • Serveur : Java 17 recommandé (Windows et Linux)
                   Java 11 supporté

Bonnes pratiques pour la version 2024 R1

Pour un fonctionnement optimal de DigDash Enterprise, il est recommandé d'appliquer les préconisations suivantes :

  • Utilisation du fichier digdash.properties pour stocker la configuration des environnements.
    Pour plus d'informations sur le paramétrage du fichier, consultez la page Paramétrage du fichier digdash.properties.
     
  • Utilisation d'un système de base de données externe pour les bases DDAudit, Comments et DDDataEntry.
    Pour plus d'informations sur l'installation d'un système de base de données externe, consultez le paragraphe :
  • Utilisation d'un Tomcat séparé de l'installation Digdash (installation par le gestionnaire de package de l'OS).
    Pour plus d'informations sur l'installation d'un Tomcat séparé, consultez le paragraphe :
  • Utilisation de OpenDJ à la place de adswrapper.
    Pour plus d'informations sur l'installation de OpenDJ, consultez le paragraphe :

Mise à jour de DigDash Enterprise vers la version 2024 R1

Ce paragraphe vous concerne si vous mettez à jour DigDash Enterprise depuis une version 2022 R2 ou ultérieure vers la version 2024 R1.
Pour une mise à jour depuis une version antérieure à la version 2022 R2, veuillez contacter DigDash à l’adresse contact@digdash.com.

Les drivers JDBC ont été mis à jour et nécessitent pour certains d'être réinstallés. Merci de vérifier selon vos besoins dans le document suivant : Ajout Pilote JDBC > Drivers préconfigurés non inclus.

Le module DDAudit a été modifié dans la version 2023R1. Pour en savoir plus sur les instructions relatives, veuillez consulter le paragraphe Modification du module DDAudit.

Procédure de mise à jour

Étape 1 : Sauvegarde de la configuration

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.
Consultez la documentation Sauvegarde et restauration.

Étape 2 : Arrêt du serveur

Arrêtez le serveur DigDash :

  • Sous Windows : cliquez-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur Arrêter depuis votre application Services de Windows.
  • Sous Linux : utilisez la commande service tomcat9 stop

Étape 3 : Sauvegarde et suppression des anciennes applications

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

Dossiers :

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

Fichiers :

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

❗Ne pas effacer le dossier ROOT.

Ne pas effacer le dossier ldapdigdash si utilisé. Le répertoire ldapdigdash est lié à adswrapper (non recommandé).

É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 webapps.
Copiez les fichiers suivants dans le même dossier de votre installation :

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

Le dossier webapps doit maintenant contenir 4 fichiers .war (5 si vous utilisez adswrapper) et le dossier ROOT.

Étape 5 : Récupération des add-ons

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

Étape 6 : Redémarrage du serveur

Redémarrez le serveur DigDash :

  • Sous Windows : cliquez-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur Démarrer depuis votre application Services de Windows.
  • Sous Linux : utilisez la commande service tomcat9 start

et laissez Tomcat redéployer les nouvelles applications.

Sous Linux, reportez-vous au Guide d'installation Linux.
Sous Windows, reportez-vous Guide d'installation Windows.

Étape 7 : Restauration

Si vous avez configuré votre nouvelle installation pour pointer sur votre ancien dossier des données 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.

Étape 8 : Nettoyage du cache du navigateur

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

Étape 9 : Régénération des modèles de données

La régénération des modèles de données est recommandée dans le cas d'une montée de version majeure.

Dans l'onglet Flux du Studio, cliquez-droit sur chaque portefeuille de flux puis cliquez sur Synchroniser pour tous les utilisateurs.

Dans la boite Confirmer la synchronisation du portefeuille de rôle, cochez la case Forcer la génération des cubes des données des flux sélectionnés puis, la case Forcer la génération de tous les cubes dépendants.

Confirmer_synchronisation

Modification du module DDAudit

Le module DDAudit a été modifié en version 2023 R1. Si vous avez déployé DDAudit dans une version précédente, suivez les instructions suivantes :

  • Si vous n'avez pas modifié les modèles et les flux de DDAudit, et si vous n'avez pas créé de nouveaux modèles et flux, alors il est conseillé de désinstaller le module DDAudit, en supprimant le rôle et ses données puis de le réinstaller via le gestionnaire Digdash Metadata Service depuis le Studio.
     
  • Si vous avez créé vos propres modèles et flux pour DDAudit, ou si vous avez modifié les modèles de données, vous devez modifier les requêtes SQL des modèles de données modifiés ou créés afin qu'ils n'utilisent plus le champ user mais dd_user (les noms des dimensions et mesures restent inchangés).

❗Si vous utilisez H2 comme base de donnée pour DDAudit (non recommandé), il vous faudra migrer votre ancienne base de données (voir le document Migration base de données H2) avant de pouvoir effectuer ces modifications.

Modifications de comportement dans la 2024 R1

De nouvelles fonctionnalités ou la résolution de bugs dans la 2024 R1 sont à l'origine de modifications de comportement susceptibles d'avoir un impact. Il est donc recommandé de consulter la liste des modifications de comportement ci-dessous.

Sécurité

IODS

La configuration IODS doit maintenant être effectuée dans le fichier digdash.properties ou dans les paramètres de ligne de commande au lieu de la page Paramètres serveur.

Serveur de fichiers

Un utilisateur disposant d'une autorisation (ACL) Soumettre un document et qui n'a pas les droits d'écriture sur un rôle, n'a plus la possibilité de télécharger de document sur un serveur de fichier partagé à ce rôle.

Autorisations (ACL)

L'ajout des autorisations Contenu > Lister les documents et Contenu > Lister les serveurs de documents peut avoir un impact sur le comportement. Lorsque vous ajoutez l'autorisation Administrateur > Gérer le contenu utilisateur à un utilisateur, vous devez également lui ajouter les autorisations Contenu > Lister les documents et Contenu > Lister les serveurs de documents, sinon il ne pourra pas gérer le contenu de l'utilisateur. L'inverse n'est pas vrai, vous souhaiterez peut-être ajouter Contenu > Lister les documents et Contenu > Lister les serveurs de documents sans Administrateur > Gérer le contenu utilisateur. Il pourrait ainsi lister les documents et les serveurs auxquels il a accès.

Configuration

Les fichiers js et css de la partie "adminconsole" (pages d'accueil et d'administration) sont désormais versionnés. Il n'est plus nécessaire de vider le cache lors d'une montée de version.

Studio

Modèles de données

Il est désormais possible d'utiliser des colonnes avec des noms différents comme colonnes clés pour l'union de modèles de données.

Libellé (légende) d'une dimension

Le terme Libellé remplace le terme Légende.

Gestionnaires

L'accès aux Gestionnaires se fait désormais depuis un onglet dédié à gauche de la fenêtre du Studio.

Fabrique PDF

L'option Toujours commencer à la fin du tableau a été supprimée.

Filtres 

La fenêtre d'ajout d'un filtre sélectionne désormais automatiquement le même niveau hiérarchique que la dimension utilisée dans le graphique et non plus le niveau racine.

Format

Le format Surface (are)  utilise désormais un séparateur des milliers.

Graphiques

Objectifs dans les tableaux

Les objectifs utilisés dans les tableaux sont désormais affichés dans la légende.

Étiquettes des graphiques barres

L'affichage des étiquettes de contenu des barres en empilement diffère selon si elles contiennent des données fixes ou variables :

  • Dans le cas où l'étiquette contient une donnée qui varie dynamiquement en fonction de la barre sur laquelle elle se trouve (par exemple, pour les mots-clés Valeur, Membre, Valeur absolue et Valeur en pourcentage), une étiquette est affichée pour chaque barre en empilement.
  • Dans le cas où l'étiquette contient seulement des données fixes par barre (pour les mots clés autres que ceux cités ci-dessus), une seule étiquette est affichée au sommet des barres en empilement ( à droite des barres empilées dans le cas où les données sont positives ou combinaison de données positives/négatives, à gauche quand les valeurs sont seulement négatives).

À noter que si l’utilisateur ne choisit pas d'afficher l'étiquette au sommet, l'étiquette s'affiche à partir de l'axe zéro une seule fois si elle contient seulement des données fixes, et à l'intérieur de chaque barre si elle contient une donnée variable.

Cartes

La valeur Autres n'impacte pas le dégradé de couleurs.

Dashboard

Commentaires

Les commentaires sont désormais mis à jour toutes les 30 secondes.

Objets du tableau de bord

Les objets rétractables sont désormais, par défaut, affichés au clic. 

Tri des tableaux

Il est désormais possible de trier les tableaux (simples et aborescents) sur plusieurs dimensions.

Mobile

L'ancienne interface dédiée au mobile a été désactivée. Si l'utilisateur essaie d'y accéder avec le lien sous la forme http://localhost:8080/ddenterpriseapi/mobile, un message d'erreur s'affiche.

Déploiement d'un patch sur une 2024 R1

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

On considère ici que votre configuration suit la recommandation d'utiliser le fichier digdash.properties. Si cela n'est pas fait, référez-vous au paragraphe Bonnes pratiques pour la version 2024 R1.

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.

La procédure de déploiement d'un patch est désormais identique à la mise à jour de version. Vous pouvez donc suivre la procédure détaillée ci-dessus.