Guide d'installation Windows

Modifié par fperrier le 2022/07/26 09:39

 Java est requis pour pouvoir lancer DigDash. Actuellement, la version 17 de java n'est pas supportée et ne fonctionnera pas. Nous recommandons d'utiliser java 11 (les versions 12 à 16 n'étant pas des versions LTS) pour le moment.

Vocabulaire

Dans toutes les pages de documentation, les "applications" font références aux fichiers .war présents dans le serveur DigDash Enterprise :

  • Serveur : ddenterpriseapi.war
  • Tableau de bord : digdash_dashboard.war
  • Web Studio : studio.war
  • Page d'accueil et Desktop Studio : adminconsole.war

Cet ensemble d'applications constitue un domaine. Selon les besoins ce domaine peut être dupliqué pour par exemple disposer d'un contexte de développement et un autre de production.
Pour déployer plusieurs domaines suivez ce lien.

L'installation de DigDash Enterprise sur Windows peut se faire de deux façons :

  • lancement manuel
  • lancement automatique en tant que service Windows

Ce document décrit comment installer DigDash sur Windows dans ces deux modes.

Pour l'installation sur Linux, se reporter au document Guide d'Installation Linux.

Pour une mise à jour d'une installation existante, se reporter au document Guide de mise à jour.

Installation

  • Décompressez les fichiers contenus dans le fichier digdash_enterprise_2022R1_numpatch_64.zip vers le répertoire de votre choix sur votre ordinateur. Ne pas utiliser de chemins avec des espaces.
  • 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).

L'ensemble des fichiers serveurs de DigDash Enterprise est à présent installé sur votre ordinateur.

Paramètres Tomcat

Certains paramétrages usuels tels que l'allocation de mémoire et les ports réseaux nécessaires sont susceptibles d'être modifiés dès l'installation.

Ce paragraphe décrit comment modifier trois des paramètres les plus importants au moment de l'installation : l'allocation de mémoire à tomcat, les ports réseau utilisés et le nom du service Windows (si une installation en tant que service Windows est prévue).

Une liste plus complète de paramètres système se trouve dans le document Réglages avancés des paramètres système.

Mémoire allouée à Tomcat

  1. Ouvrez le répertoire <DD Install>\configure puis éditez le fichier setenv.bat
  2. Modifiez les valeurs des variables JVMMS et JVMMX définies en début du fichier. Par exemple : set JVMMS=4096 et set JVMMX=4096 pour augmenter la mémoire allouée à Tomcat à 4Go.

Ports réseau Tomcat

Si un des ports nécessaires à Tomcat est déjà utilisé par un autre processus, alors il ne se lancera pas. Il est nécessaire de vérifier la disponibilité des ports et si besoin de reconfigurer Tomcat.
Par défaut les 3 ports suivants sont configurés : 8005, 8080 et 8009. Pour les modifier :

  1. Ouvrez le répertoire <DD Install>/apache-tomcat/conf puis éditer le fichier server.xml
  2. Cherchez et remplacez les valeurs des ports 8005, 8080 et 8009 par des numéros de port disponibles sur le système.

Nom du service Windows Tomcat

Dans certains cas il est intéressant de modifier le nom du service Windows qui sera créé lors de l'installation en tant que service (chapitre suivant), par exemple si un service du même nom existe déjà.

  1. Ouvrez le répertoire <DD Install>\configure puis éditez le fichier servers_install_service.bat
  2. Cherchez et modifiez la valeur de la variable SERVICE_NAME au début du fichier.
    Par exemple :set SERVICE_NAME=Tomcat_DEV

Paramètres DigDash

Avant le 1er démarrage du serveur, il est vivement conseillé de s'assurer que certains paramètres sont compatibles avec votre environnement.

Fichier de configuration digdash.properties

Le fichier digdash.properties présent dans le répertoire d'installation vous permet de configurer tout l'environnement.

Vous pouvez modifier le fichier digdash.properties livré pour personnaliser votre environnement. Vous pouvez aussi changer son emplacement. Voir le chapitre Externalisation des paramètres dans le fichier digdash.properties.

Emplacement du dossier de vos données

DigDash Enterprise stocke les informations de configuration, les modèles de données, les graphiques, les cubes, l'historique des flux et d'autres fichiers de travail dans le dossier de l'utilisateur du système d'exploitation, dans un sous dossier Application Data/Enterprise Server/<domaine>.

Par exemple sous Windows, ce dossier est :
C:\Users\<utilisateur>\AppData\Roaming\Enterprise Server\ddenterpriseapi

Il est important de modifier ce dossier pour en garantir l'accessibilité (droits en lecture/écriture/exécution) et pour maitriser l'espace de stockage (ce dossier peut être volumineux).
Cette modification est aussi intéressante pour des raisons d'organisation, de scripting, etc.

Il existe plusieurs moyen de modifier ce chemin.

Dossier commun à tous les domaines

Fichier modifié : digdash.properties

Ceci est le moyen le plus simple et efficace. Toutes les applications de DigDash Enterprise en profiteront (un seul paramétrage).
L'autre méthode n'est à utiliser qu'en cas de besoin spécifique.

La variable digdash.appdata permet de spécifier l'unique dossier des données.
Dans le fichier <DDE Install>/digdash.properties, décommentez la ligne #digdash.appdata=c:/data en supprimant le caractère # en début de ligne :

digdash.appdata=C:/appdata

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

Si ce dossier n'existe pas, DigDash Enterprise le crée. Les données ne seront pas stockées directement dans ce dossier, mais dans des sous dossier pour chaque application :
<digdash.appdata>/Enterprise Server/<domaine>
<digdash.appdata>/Enterprise Administrator
<digdash.appdata>/ldapdigdash

Avantage : La configuration se faisant au niveau du fichier digdash.properties, elle ne sera pas écrasée lors de la mise à jour de DigDash Enterprise par déploiement de nouveaux fichiers WAR.

Inconvénient : Cette configuration est globale au Tomcat de DigDash Enterprise, donc tous les domaines DigDash Enterprise de ce serveur sont concernés.
Cependant les données des différents domaines DigDash Enterprise déployés dans ce Tomcat ont bien leur sous-dossier propre, il n'y a aucun risque d'écrasement des données.

Dossier différent pour chaque domaine

Fichier modifié : digdash.properties

La variable <domaine>.AppDataPath définie dans ce fichier a le même comportement que la variable globale décrite ci-dessus.
La différence est que ce paramétrage est spécifique à un domaine DigDash Enterprise.

Pour définir un dossier des données spécifique à un domaine, modifiez le paramètre AppDataPath préfixé du nom du domaine.
Si vous avez un domaine ddenterpriseapi_dev, le paramètre sera :

ddenterpriseapi_dev.AppDataPath=C:/appdata_dev

Avantages :

  • Configuration locale à un domaine
  • Fichier externe au WAR

Inconvénient : Configuration à faire pour chaque domaine.

Démarrage et arrêt manuel de DigDash Enterprise

Lorsque DigDash Enterprise n'est pas installé en tant que service Windows.

Démarrage de DigDash Enterprise

Ouvrez le répertoire d'installation de DigDash Entreprise, puis double cliquez sur le fichier start_tomcat.bat.

Le premier démarrage du serveur peut prendre plusieurs minutes car les applications web se déploient.

Arrêt de DigDash Enterprise

Ouvrez le répertoire d'installation de DigDash Entreprise, puis double cliquez sur le fichier stop_tomcat.bat.

Installation en tant que service Windows

L'installation en tant que service doit être faite avec un utilisateur ayant des droits d'administration Windows sur cette machine.

Assurez-vous d'avoir vérifié et modifié les paramètres importants mentionnés dans le chapitre précédent avant d'installer le service.
Si vous modifiez des paramètres vous devrez installer de nouveau le service (via le script servers_install_service.bat)

Installation

  • Démarrez l'invite de commande avec les droits d'administration :
    • Faites un clic droit sur le racourcis de l'invite de commande et sélectionnez « Exécuter en tant qu'administrateur »
  • Positionnez-vous dans le répertoire <DD Install>\configure puis entrez la commande servers_install_service.bat sur Windows 64 bits.
    Le service « Tomcat 9» est installé (ou un autre nom que vous auriez spécifié).
  • Le service est installé en lancement manuel par défaut. Pour modifier ce comportement il faut lancer le gestionnaire de services Windows, et changer les propriétés du nouveau service.
    Pensez aussi à vérifier au même endroit que l'utilisateur exécutant le service est bien configuré.

Démarrage

L'application Services de Windows permet de gérer tous les services installés.
Dans cette liste faites un clic-droit sur votre service ("Tomcat 9" par défaut), puis cliquez sur Démarrer.
Une fois le serveur démarré la page d'accueil sera accessible (http://localhost:8080 par défaut).