Pré-requis

Afin d'effectuer l'installation de l'application ESCO-Grouper, certains logiciels/outils sont nécessaires :

• Maven 2.2.1
• Apache ant 1.8.0
• Tomcat 5.5.27
• Un éditeur de texte (ex : Bloc Note)

L'installation de Maven, Tomcat et du projet doit se faire dans des répertoires dont le chemin ne contient pas le caractère espace. Par exemple :

Grouper 1.6.2 et son web service doivent être installés et accessibles, y compris la base de données Grouper pour les accès via l'API.

Le web service de Grouper doit contenir le fichier esco-subject-extension-1.1.jar dans le répertoire lib afin de récupérer des attributs multi-valués du LDAP sur une personne (correction du bug Grouper https://bugs.internet2.edu/jira/browse/GRP-257).

Le fichier sources.xml de grouper-ws doit contenir les attributs LDAP à afficher dans l'application (voir un exemple plus bas).

Installation de l'application

Paramétrage et configuration

Aucune modification de configuration ou de paramétrage dans la base de données DERBY n'est à faire entre le v2.5.00 et la v2.6.00 de l'application.

Principe général d'installation

Pré-requis : Le serveur Tomcat version 5.5.27 où sera déployée l'application doit être lancé au moment de l'exécution des tâches Ant.

• Récupération des sources

• *Modification des options de lancement de Tomcat pour spécifier l'emplacement des fichiers de la mémoire allouée, etc... :* -Xms256m -Xmx512m -XX:PermSize=64M -XX:MaxPermSize=128M -Xss2048k -Xminf0.05 -Xminf0.40 -Xmaxf0.60
  -Djavax.net.ssl.trustStore=***emplacement du fichier .cacerts si mode SSL**
  Remarque : les options de lancement concernant la langue, l'encodage et le répertoire --Dconf.dir ne sont plus nécessaires depuis la version 2.4.00.
• *Si l'installation est en mode portlet,* *Edition du fichier server.xml du serveur Tomcat pour ajout du « {}emptySessionPath=true » à toutes les balises <connector> :*

  <Connector emptySessionPath="true" acceptCount="100" connectionTimeout="20000"

• Lancement de Tomcat
• *Modification des fichiers de configuration :* * Modification du fichier ESCOGrouper/build.properties (cf. §6.1)
• Modification du fichier ESCOGrouper/properties/ESCOGrouper.properties (cf. §6.2)
• Modification du paramétrage applicatif (base de données DERBY) (cf. §6.3)
• Modification des fichiers d'internationalisation (libellé, aide contextuelle, exception) (cf. §6.4)
• Vérification des stratégies (cf. §6.5)
• Vérification des profils (cf. §6.6). Ces profils peuvent être modifiés directement sur le serveur Tomcat après déploiement. Par contre cela nécessite un redémarrage du serveur pour prendre en compte les modifications.
• Vérification du paramétrage du serveur d'envoi de mail (cf. §6.7) * *Construction du projet par compilation maven via le script ant :*

• • Initialisation et compilation de l'application : se placer dans le répertoire /ESCO-Grouper et lancer la commande :ant init
    Attention : le fait d'avoir BUILD SUCCESSFUL en fin de script ANT ne signifie pas forcément que la compilation s'est bien déroulée. Il faut vérifier qu'il n'y ait pas de BUILD FAILED dans les tâches maven au dessus.
  • Déploiement : se placer dans le répertoire /ESCO-Grouper et lancer la commande :ant deploy
• *Modification des fichiers d'aide en ligne si nécessaires (cf. §6.8).*

• *Pour le mode portlet, il est nécessaire de copier les css dans les thèmes du portail. Le fichier à copier se trouve dans le répertoire ESCOGrouper/properties/css.*

Cas de la première installation

Dans le cas où l'application n'a jamais été installée et la base de données mémoire n'existe pas.

Se placer dans le répertoire /ESCO-Grouper et lancer les commandes :ant init
ant deploy
Quand Tomcat prend en compte le nouveau war, la base de données mémoire est créée avec le paramétrage fourni à l'étape 5.

/!{{color:#ff0000}} Tomcat prend en compte le nouveau war de la façon suivante :

• En mode remote, prise en compte à chaud
• En mode local, redémarrage de Tomcat

Cas d'une installation avec modification des propriétés autres que derby

Dans le cas où l'application est déjà installée et la base de données mémoire existe déjà. Si l'on souhaite modifier les fichiers du répertoire /properties autres que ceux de derby (les stratégies par exemple).

Se placer dans le répertoire /ESCO-Grouper et lancer les commandes :ant init
ant deploy
Quand Tomcat prend en compte le nouveau war, la base de données mémoire n'est pas modifiée par rapport à l'installation précédente.

Cas d'une installation avec modification des propriétés derby

Dans le cas où l'application est déjà installée et la base de données mémoire existe déjà. Si l'on souhaite seulement modifier le paramétrage applicatif (fichiers de propriétés derby).

Se placer dans le répertoire /ESCO-Grouper et lancer les commandes :ant dbinit
ant dbdeploy
La seconde tâche copie les fichiers générés (sql + label), supprime la base de données derby existante et alimente la base avec le nouveau paramétrage.

Ceci est vrai dans le cas du déploiement en mode local. En mode remote, il faut se référer au cas suivant.

Afin que les fichiers d'internationalisation soient pris en compte, il faut redémarrer Tomcat.

Cas d'une installation avec modification des properties (derby + autre)

Dans le cas où l'application est déjà installée et la base de données mémoire existe déjà. Si l'on souhaite modifier à la fois le paramétrage applicatif (fichiers de propriétés derby) et les autres paramétrages (stratégie par exemple).

Se placer dans le répertoire /ESCO-Grouper et lancer les commandes :ant init
ant dbdeploy
ant deploy
La seconde tâche copie les fichiers générés (sql + label), supprime la base de données derby existante et alimente la base avec le nouveau paramétrage.

Afin que les fichiers d'internationalisation soient pris en compte, il faut redémarrer Tomcat.