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 :

La base de données Grouper 1.6.2/1.6.3 doit être installé et accessible.

Restriction

Il n'est possible d'utiliser ESCOGrouper en mode portlet que dans un portail uPortal en version 2.6 et en utilisant https. Dans ce cas, il n’est pas possible d’avoir deux portlets ESCOGrouper dans le même portail à cause de la session.

Installation de l'application

Récupération des sources

Les sources sont disponibles sur : https://sourcesup.cru.fr/frs/?group_id=824

Le guide d'installation en format PDF est disponible à : https://sourcesup.cru.fr/docman/?group_id=824

Le package ESCO-DynamicGroups doit être compilé avec grouper-ws pour déployer un hook grouper pour les groupes dynamiques, et esco-subject-extension-1.2.jar doit être déployé dans le répertoire lib de grouper-ws.

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, la v2.6.00 et la v2.6.07 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.

• Étape 1 : récupération des sources

• Étape 2 : 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.
• Étape 3 : si l’installation est en mode portlet (uPortal 2.6 accédé en https), édition du fichier server.xml du serveur Tomcat pour ajout du « emptySessionPath=true » à toutes les balises <connector> :

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

• Étape 4 : Lancement de Tomcat

• Étape 5 : Modification des fichiers de configuration :
  • modification du fichier ESCOGrouper/build.properties
  • modification du fichier ESCOGrouper/properties/ESCOGrouper.properties
  • modification du paramétrage applicatif (base de données DERBY)
  • modification des fichiers d’internationalisation (libellé, aide contextuelle, exception)
  • vérification des stratégies
  • vérification des profils. 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.

• Étape 6 : 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
    

• Étape 7 : Modification des fichiers d’aide en ligne si nécessaires.

• Étape 8 : Pour le mode portlet (uPortal 2.6 accédé en https), 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.

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 :a

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.

Les tâches ant

ant clean

Cette tâche permet de lancer le nettoyage des différents projets afin de pouvoir revenir à un état vierge avant toute nouvelle compilation.

ant init

Cette tâche permet de lancer un dbinit, de copier dans le projet les fichiers générés et de compiler le projet.

ant dbinit

Cette tâche permet de générer le fichier sql permettant d’alimenter la base de données mémoire à partir des fichiers de paramétrage ainsi que les fichiers d’internationalisation.

Cette tâche peut afficher des warning lors de son exécution. Ces warnings correspondent à des clés dupliquées. Dans la majorité des cas, cela est normal car une même clé est utilisée pour le même attribut sur des pages différentes. Par exemple, l’attribut extension est utilisé dans la page de propriétés d’un groupe et dans celle d’un dossier. Le même libellé (extension.label) est utilisé. D’où le warning de la duplication de clé mais qui est normal. Il faut être vigilant sur ces duplications lors que l’on veut des libellés différents pour un même attribut.

ant deploy

Cette tâche permet de déployer le war sur Tomcat.

• En mode remote, cela « undeploy » l’application existe (si elle porte le même nom de contexte) et déploie le nouveau war. Ce war est pris directement en compte par Tomcat.
• En mode local, cela copie l’application dans le répertoire paramétré. Il faut redémarrer Tomcat pour le nouveau war soit pris en compte.

ant dbdeploy

Cette tâche permet de copie les fichiers générés puis supprimer et créer à nouveau la base de données à partir des fichiers généré par la tâche dbinit ou init. Tomcat doit être démaré.

ant undeploy

Cette tâche supprime le war et le répertoire de déploiement sous tomcat que ce soit en mode remote ou en mode local.

Configurations techniques et applicatives

L’ensemble des fichiers de configuration à modifier se trouvent dans le répertoire /ESCO-Grouper/properties.

build.properties

Il s’agit du fichier d’environnement nécessaire à la compilation via la tâche ant.

ESCOGrouper.properties

Il s’agit du fichier de propriétés de l’application ESCO-Grouper.

Paramétrage applicatif (base de données DERBY)

Le paramétrage est un élément important de l’application, tous les écrans y font appel pour décider si tels éléments doivent être affichés ou non.

Cette brique technique se doit d’être le plus ouvert et le plus simple possible. Ainsi l’utilisation d’une base de données mémoire est recommandée dans ce type de configuration car elle est :

• Souple d’utilisation grâce à un accès distant ;
• Accessible par de multiples modules ;
• Modifiable à chaud.

Or des fichiers de configurations permettent d’alimenter simplement cette base de données et de créer les fichiers d’internationalisation correspondant.

Chaque fichier contient la manière de paramétrer les différentes pages => se référer aux fichiers fournis dans les sources.

Les fichiers sont référencés dans le fichier build.xml. En modifiant build.xml, on peut modifier le nom et le nombre des fichiers de paramétrage applicatif.

MyParameters.properties

Ce fichier permet de renseigner des paramètres

• nécessaires à la génération de la base de données,
• communs à l’ensemble de l’application et qui sont nécessaires au bon fonctionnement de l’application.

global.lang permet de définir les langues utilisées par l’application et ainsi vérifier lors de la génération des fichiers d’internationalisation que les libellés sont paramétrés dans l’ensemble des langues définies.

default.rule.regexp.* définit l’expression régulière utilisée si aucune autre expression n’est définie pour la validation des champs.

MySearch.properties

Ce fichier concerne le paramétrage des pages relatives aux recherches :

• Recherche de sujets :
  • Personnes
  • Groupes
  • Personnes dans un groupe

• Recherche de dossiers

MyStem.properties

Ce fichier concerne le paramétrage des pages relatives aux dossiers :

• Propriétés de dossier
  • Attributs

• Création de dossier et Modification de dossier
  • Attributs
  • Modification de l’extension
  • Privilèges

MyGroup.properties

Ce fichier concerne le paramétrage des pages relatives aux groupes :

• Propriétés de groupe
  • Attributs
  • Membres
  • Appartenances
  • Privilèges

• Création de groupe et Modification de groupe
  • Attributs
  • Droits par défaut
  • Type personnalisé
  • Privilèges

MyGroupDynamic.properties

Ce fichier concerne le paramétrage des pages relatives aux groupes dynamique :

• Onglet groupe dynamique
• Page Tester règle

MyPerson.properties

Ce fichier concerne le paramétrage des pages relatives aux groupes :

• Propriétés de personne :
• Attributs
• Appartenances
• Privilèges
• Abonnements

Internationalisation

Labels

Les fichiers contenant les libellés de l’application et qui ne sont pas créés par la génération de la base de données se trouvent dans les répertoires :

• /ESCO-Grouper/metier/esco-web/src/main/resources/properties/i18n/bundles/screen/
• /ESCO-Grouper/metier/esco-web/src/main/resources/properties/i18n/bundles/
• /ESCO-Grouper/metier/esco-module/dynamique-groupe/src/main/resources/properties/i18n/plugins/screen/

Exceptions

Il est possible de différencier les messages d’erreurs selon les écrans. Liste des préfixes pour les exceptions des résumés :

• org.esco.grouperui.group.resume. : préfixe pour l’écran de résumé des propriétés de groupe.
• org.esco.grouperui.person.resume. : préfixe pour l’écran de résumé des propriétés de personne.
• org.esco.grouperui.stemmodification.resume. : préfixe pour l’écran de résumé d’administration d’un dossier.
• org.esco.grouperui.groupmodification.resume. : préfixe pour l’écran de résumé d’administration d’un groupe.

Exemple :

Par défaut lorsque l’exception ESCOGroupNotSaveException est levée le message « Le groupe n'a pas été enregistré. » est affiché.

Si on souhaite avoir un message différent dans le résumé des propriétés de groupe, il suffit de définir une nouvelle clé dans le fichier Error_XX :org.esco.grouperui.group.resume.ESCOGroupNotSaveException=Mon nouveau message

Aide contextuelle

Les libellés des aides contextuelles se trouvent dans les différents fichiers d’internationalisation avec les clés se terminant par « _TITLE ».

Si la clé n’existe pas, l’aide contextuelle s’affichera avec "???CLE???".

Pour que l’aide contextuelle ne s’affiche pas, il suffit de retirer le libellé après la clé. Par exemple :STEM_CREATE_GROUP_TITLE=

Stratégies

Recherche de personnes

Le fichier grouper-api-strategy.xml permet de définir quelle stratégie de recherche de personnes est utilisée en fonction d’une expression évaluée.

<bean id="defaultStrategySubjectLocator" class="org.esco.grouperui.services.grouper.internal.locator.DefaultStrategySubjectLocator">
   <property name="evaluator" ref="evaluator" />
   <property name="defaultSearchStrategies" >
      <map>
         <entry key="evaluator.regexp('(esco:Etablissements\:((\[^_\]+)_(\\d{5,7}\\w?))(:\[^:\]+)*)\|(esco:admin:.+)\|(esco:Applications:.+)', path)" value-ref="UAIStrategySubjectSearch"></entry>
         <entry key="evaluator.regexp('(.*)', term)" value\-ref="defaulStrategySubjectSearch"></entry>
      </map>
   </property>
</bean>

Dans l’exemple ci-dessus, la stratégie "UAIStrategySubjectSearch" sera utilisée pour les groupes dont le path correspond à l’expression régulière indiquée.Les variables disponibles pour l’expression sont:

• term : le terme de recherche qui peut contenir des caractères joker ;
• path : le chemin à partir duquel on effectue la recherche ;
• person : la personne effectuant la recherche.

Recherche de groupes

Le fichier grouper-client-strategy.xml permet de définir quelle stratégie de recherche de groupes est utilisée en fonction d’une expression évaluée. Ce fichier se trouve dans le répertoire /ESCO-Grouper/ext/grouper-client.fragment/src/main/ressources/spring.

<bean id="defaultStrategyGroupLocator">
   <property name="evaluator" ref="evaluator" />
   <property name="defaultSearchStrategies" >
      <map>
         <entry key="evaluator.regexp('(.*)', term)" value-ref="defaulStrategyGroupSearch"></entry>
      </map>
   </property>
</bean>

Dans l’exemple ci-dessus, il n’existe qu’une stratégie par défaut.

Les variables disponibles pour l’expression sont :

• field : attribut sur lequel l’utilisateur effectue la recherche. Les valeurs possibles sont name, displayName et extension ;
• type : le type de la recherche (simple ou pour ajout). Les valeurs possibles sont SIMPLE et ADD ;
• path : le chemin à partir duquel on effectue la recherche ;
• term : le terme de recherche qui peut contenir des caractères joker ;
• subject : la personne effectuant la recherche.

Condition par défaut des groupes dynamiques

Le fichier group-dynamic-strategy.xml permet de définir quelle condition par défaut est affichée sur l’onglet Dynamique lors de la création d’un groupe de type dynamique en fonction d’une expression évaluée.

<bean id="defaultStrategyRequestLocator"class="org.esco.grouperui.services.dynamicgroup.internal.DefaultStrategyRequestLocator">
   <property name="evaluator" >
      <bean class="org.esco.grouperui.services.dynamicgroup.internal.ExpressionEvaluator" />
   </property>
   <property name="strategies" >
      <map>
         <entry key="evaluator.regexp('esco:Etablissements:(([^_]+)_(\\d{5,7}\\w?))(:[^:]+)*', stem.getName())">
            <bean class="org.esco.grouperui.services.dynamicgroup.internal.UAIStrategyRequestFactory" />
         </entry>
         <entry key="evaluator.regexp('(.*)', stem.getName())">
            <bean class="org.esco.grouperui.services.dynamicgroup.internal.DefaultStrategyRequestFactory" />
         </entry>
      </map>
   </property>
</bean>

Dans l’exemple ci-dessus, la stratégie "UAIStrategyRequestFactory" est utilisée pour les dossiers dont le nom correspond à l’expression régulière indiquée.

Les variables disponibles pour l’expression sont :

• stem : le dossier dans lequel l’utilisateur créé le groupe ;
• person : la personne effectuant la création.

Gestion des profils

Afin de pouvoir paramétrer l’application en fonction d’un utilisateur, il est possible de gérer différents profils.

Le profil peut être récupéré de deux manières différentes :

• En passant dans l’url le paramètre profile=*nomDuProfil* si l’application est en mode servlet
• En récupérant le profil de la personne connectée sur le Portail si l’application est en mode portlet.

Le mécanisme des profils est décrit dans le document intitulé « ESCO-Grouper - Manuel de développement v1.00.pdf ». Le point à retenir est qu’il existe des fichiers *Profile.xml qu’il est nécessaire de modifier pour autoriser ou non des fonctionnalités.

Ajout d’un profil

Afin d’ajouter un profil, il suffit de rajouter un fichier XML dans le répertoire des profils. Il sera chargé automatiquement au lancement de l’application.

Contenu d’un fichier de profil

Le contenu d’un fichier de profil correspond à ceci :

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/aop/spring-aop.xsd
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-3.0.xsd">
   <bean id="testProfile" class="org.esco.grouperui.web.beans.profile.UserProfile">
       <property name="name" value="testProfile"></property>
       <property name="functions">
          <map>
          <!--entry key="*uneClef*" value="*unBooléen*"></entry-->
             <entry key="org.esco.grouperui.web.stem.properties" value="true"></entry>
          </map>
       </property>
   </bean>
   <bean class="org.esco.grouperui.web.beans.profile.UserProfileAggregator">
       <description>Add the profile to the list of profiles or modify if exist.</description>
          <property name="profiles">
             <list>
                  <ref bean="testProfile"></ref>
             </list>
          </property>
   </bean>
</beans>

Ce fichier, par exemple, va créer un profil nommé « testProfile » qui va permettre aux utilisateurs ayant ce profil d’accéder aux propriétés de dossier dans l’application ESCO-Grouper.

Vous trouverez en annexe §7.4 un tableau récapitulatif des clefs possibles.

Serveur SMTP

Le serveur SMTP permet d’envoyer des mails dans le cas d’une erreur technique intervenu dans l’application.

Ce fichier smtp.xml ne doit être modifié que dans le cas où il existe plusieurs serveurs SMTP dédiés à l’application. Si un seul serveur est utilisé, la configuration s’effectue dans le fichier ESCOGrouper.properties.

Aide en ligne

Le fichier Help_XX.properties, qui se trouve dans le répertoire ESCOGrouper/metier/esco-web/src/main/resources/properties/i18n/bundles/screen, effectue le mapping entre les codes écran et l’emplacement des fichiers HTML contenant les aides.

Par exemple pour l’aide en ligne de la zone de navigation :ONLINE_HELP_NAVIGUATION_AREA_URL=/ESCOGrouper/stylesheets/onlineHelp/en/navigationArea.html
Les fichiers HTML peuvent être modifies à chaud sur le serveur Tomcat.

Remarque : les fichiers pouvant se trouver n’importe où sur le serveur Tomcat, il faut faire attention au chemin indiqué, surtout si le contexte de déploiement est différent.

Paramétrage du bandeau

Pour afficher le bandeau du haut, il faut mettre à true la variable displaying de Banner dans le fichier /ESCO-Grouper/metier/esco-web/src/web/webapp/media/js/esco/option.js.

Pour ne pas l’afficher, il faut mettre la variable à false.

/*\*
* Class to show banner or not
\*/
var Banner  = {
displaying : true,
isDisplayed : function(){
		return this.displaying;
	}
};

Annexes

Environnements

Les fichiers de configurations modifiés pour installer l’application sont les suivants :

• \ESCOGrouper\metier\esco-web\src\main\filters\filters.properties
• \ESCOGrouper\metier\esco-web\src\main\resources\properties\config.properties
• \ESCOGrouper\metier\esco-web\src\main\resources\properties\env.properties
• \ESCOGrouper\metier\esco-web\src\main\resources\properties\applicationContext.xml

filter.properties

Ce fichier est composé de filtres pour créer les fichiers de configuration de Grouper (grouper-client.properties, sources.xml, grouper.hibernate.properties et log4j.properties). Au moment de la compilation du projet via maven ces variables seront remplacées dans les fichiers adéquats.

Variables d’environnement requises dans grouper.client.properties

Variables d’environnement requises dans sources.xml

Variables d’environnement requises dans grouper.hibernate.properties

Variables d’environnement requises dans log4j.properties

config.properties

Fichier de configuration d’ESCOGrouper lui-même. Il permet de configurer les variables d’environnement nécessaires à l’utilisation de CAS et définir les chemins relatifs d’accès aux médias.

env.properties

Fichier de configuration de la base de paramétrage. Il permet de configurer la connexion à la base de données mémoire Derby.

applicationContext.xml

Fichier principal de définition des beans spring. Il permet de définir le type d’authentification de l’application (par formulaire inclus avec des utilisateurs spécifiques ou CAS). Les utilisateurs utilisés pour le mode formulaire sont spécifiés dans le fichier auth-form.xml.

Groupes dynamiques

Le fichier dynConfig.properties du projet dynamique-groupe doit être modifié pour prendre en compte les groupes dynamiques. Il se trouve dans le répertoire /ESCOGrouper/metier/esco-module/dynamique-groupe/src/main/resources\properties.

Tableau récapitulatif des clés possibles pour la gestion de profils