Guide de mise à jour

Modifié par Aurelie Bertrand le 2024/04/18 15:17

Introduction

Ce guide décrit la procédure et les précautions à prendre pour mettre à jour votre version DigDash Enterprise vers la nouvelle version 2023R1.
Il présente également les modifications de comportement introduits dans cette 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, 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}.

Nouveauté importante : 

Le Desktop Studio a été supprimé définitivement dans la version 2021 R2.
Le Studio Web est donc devenu l'unique moyen de construire vos sources de données et vos graphiques.
Vous n'aurez plus à gérer les complications liées à l'installation et la mise à jour de Java sur les postes clients.

Attention : l'usage de l'ancien Desktop Studio dans un déploiement 2021 R2 ou supérieur n'est pas supporté.

Les archives d’installation de DigDash Enterprise sont nommées sous le modèle digdash_enterprise_2023R1_64.zip ou digdash_enterprise_2023R1_numpatch_64.zip.
Après extraction, le dossier s’appellera digdash_enterprise_2023R1_64 ou digdash_enterprise_2023R1_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 recommandée :

  • Serveur : Tomcat 9 (Windows et Linux)
  • Serveur : Java 11 (Windows)

Sous linux vous devrez au minimum installer Java en suivant les recommandations du Guide d'installation.

Bonnes pratiques pour la version 2023 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 OpenLDAP à la place de adswrapper.
    Pour plus d'informations sur l'installation de OpenLDAP, consultez le paragraphe :

Mise à jour de DigDash Enterprise vers la version 2023 R1

Ce paragraphe vous concerne si vous mettez à jour DigDash Enterprise depuis une version 2021R1 ou ultérieure vers la version 2023 R1.

Depuis la version 2021 R1 le processus d'installation, de configuration et de maintenance (installation d'un patch ou intervention du support) a été simplifié.
Si vous n'avez pas déjà suivi cette procédure de configuration il est intéressant et vivement recommandé de reprendre de zéro l'installation.
Le nouveau système de configuration vous fera gagner du temps par la suite.

Les drivers JDBC ont été mis à jour et nécessite 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.

Nouvelle version de la base données H2

La base de données H2 a été mise à jour. 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.

Les utilisateurs qui n'utilisent pas la base de données H2 pour ces données mais une base de données alternative, comme mysql, mariadb ou postgresql, ne sont pas concernés.

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

Procédure de 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.
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 la documentation Sauvegarde et restauration.

Étape 2 : Arrêt du serveur

Arrêtez le serveur DigDash :

  • Sous Windows :
    • Si Digdash Enterprise n'est pas installé en tant que service Windows : lancez le fichier <install_dd_OLD>/stop_tomcat.bat.
    • Si Digdash Enterprise est installé en tant que service 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*

Fichiers :

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

* À noter que adswrapper n'est pas recommandé.

  • Ne pas effacer le dossier ROOT.
  • Ne pas effacer le dossier ldapdigdash si utilisé. Le répertoire ldapdigdash est lié à adswrapper qui n'est pas 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

Le dossier webapps doit maintenant contenir 4 fichiers .war 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 :
    • Si Digdash Enterprise n'est pas installé en tant que service Windows : lancez le fichier <install_dd>/start_tomcat.bat.
    • Si Digdash Enterprise est installé en tant que service 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 restart

et laissez Tomcat redéployer les nouvelles applications.

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

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 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 caseForcer 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_synchro_portefeuille.png

Modification du module DDAudit

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

  • 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 depuis le zip d'installation de cette nouvelle version, ou 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).

Note : Si vous utilisez H2 comme base de donnée pour DDAudit, 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 2023 R1

De nouvelles fonctionnalités ou la résolution de bugs dans la 2023 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.

Les éléments marqués d'une astérisque * sont ceux pour lesquels il est possible, si nécessaire, de rétablir le comportement antérieur. Veuillez consulter le paragraphe Rétablissement des comportements antérieurs pour plus d'informations.

Générales

Détection des données*

La détection des types de données a été améliorée afin de détecter automatiquement tous les types de données.

Optimisations*

Des optimisations introduites dans la version 2022R2 sont à l'origine de potentielles régressions.
Ces optimisations sont désormais désactivées par défaut.

Support partiel ES6*

Un support partiel de la version ES6 (ECMAScript 6) du langage JavaScript a été introduit. Celle-ci permet une syntaxe plus moderne dans les scripts des mesures dérivées, transformateurs de colonnes, etc.

Gestion des utilisateurs

L'export au format CSV de la liste des utilisateurs utilise désormais le séparateur virgule en lieu et place du séparateur point virgule.
L'import au format CSV de la liste des utilisateurs intègre à présent la détection automatique des séparateurs.

Studio

Paramètres des graphiques et tableaux

Le cyclage des couleurs sur l'axe Colonne ou Barre est désormais activé par défaut.
L'option Retour à la ligne sur en-tête est désormais activée par défaut pour les tableaux. 

Fabriques de PDF/PPT

Toute image insérée dans une zone image d'une Fabrique PDF/PPT est désormais redimensionnée en fonction de la taille de cette zone et en conservant son ratio. Cela était auparavant le cas seulement pour les images vectorielles.

Les Fabriques PDF/PPT créées avec une version antérieure à la version 2023 R1 doivent être éditées afin de réajuster la position des images si nécessaire.

Traduction non modale

Quand l'option Inclure dans le dictionnaire global est cochée, la Valeur affichée d'un élément (colonne, mesure, flux, etc) n'est sauvegardée dans le dictionnaire global qu'une fois que l'utilisateur a enregistré le modèle de donnée, la fonction, le portefeuille ou le flux concerné (bouton Appliquer). Auparavant, la sauvegarde de la valeur affichée dans le dictionnaire global était effectuée automatiquement.

Tableaux croisés : tri*

Dans un tableau croisé, lorsqu'un tri est appliqué sur la dimension d'une sous-colonne, le regroupement des sous-colonnes sous la colonne parent est désormais conservé. Auparavant, lorsque ce tri était appliqué, les sous-colonnes étaient dégroupées chacune sous une colonne parent individuelle, comme illustré ci-dessous avec un tri ascendant sur la date.
Tri_sous_colonnes
Ceci s'applique également aux lignes.

Éditeur de tableau de bord

La navigation privée d'une page de tableau de bord intègre désormais par défaut les variables en plus des filtres de la page. Les variables n'apparaissent cependant pas dans la boite Navigation. Dans le cas où la navigation privée n'est pas définie pour l'ensemble de la page mais seulement pour certains filtres, les variables n'y sont pas intégrées.

Assistant de création de tableau de bord

Le nom d'une mesure calculée ou dérivée ne peut plus être éditée après sa création.

Dashboard

Toutes les boites popup affichées dans le Dashboard (Voir les commentaires, Éditeur de commentaires, Détails des données, etc) ne sont plus redimensionnables. Elles restent repositionnables.

Documents

Lors de l'ajout de fichiers dans la boite Documents du tableau de bord, il n'est plus possible de charger plusieurs fichiers simultanément.

Commentaires

La boite Éditeur de commentaires, utilisée pour ajouter un commentaire, ne comporte plus la section Filtres. Celle-ci permettait de modifier les filtres associés au commentaire ajouté.
Une catégorie peut être attribuée à un commentaire. Les différents catégories disponibles ne disposent plus d'une icône associée.

Rétablissement des comportements antérieurs

Il peut être intéressant dans certains cas de rétablir le comportement antérieur. 
Pour cela, il faut éditer le fichier system.xml situé dans <DD Install>\Enterprise Server\ddenterpriseapi\config\system.xml et ajouter une ligne de propriété spécifiant le comportement.
Cette opération nécessite un redémarrage du serveur DigDash.

Détection des données

Ajoutez la ligne :
<Property key="PROP_OPTIM_NO_FORMAT_DETECTION_CUBEGEN" value="true"/>
entre <SystemProperties> et </SystemProperties>

Optimisations

Ajoutez la ligne :
<Property key="PROP_JS_OPTIM_LEVEL" value="1"/>
entre <SystemProperties> et </SystemProperties>

Support partiel ES6

Ajoutez la ligne :
<Property key="PROP_JS_ES6_SUPPORT" value="false"/>
entre <SystemProperties> et </SystemProperties>

Tableaux croisés : tri

Ajoutez la ligne :
<Property key="PROP_CROSSTABLE_AXIS_SORT_LEGACY" value="true"/>
entre <SystemProperties> et </SystemProperties>

Déploiement d'un patch sur une 2023 R1

Ce paragraphe concerne la mise à jour d'une version 2023 R1 vers une autre 2023 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 chapitre Bonnes pratiques pour la version 2023 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.

Version 2021 R1 ou inférieure vers 2023 R1

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