...
- Déploiement : se placer dans le répertoire /ESCO-Grouper et lancer la commande commande :
| Bloc de code |
|---|
ant deploy |
- Étape 7 : Modification des fichiers d'aide en ligne si nécessaires (cf. §6.8).
- Étape 8 : Pour le mode portlet, il est nécessaire de copier les css dans les thèmes du portail.
Le Le fichier à copier se trouve dans le répertoire ESCOGrouper/properties/css.
...
Tomcat prend en compte le nouveau war de la façon suivante suivante :
- En mode remote, prise en compte à chaud
- En mode local, redémarrage de Tomcat
...
Se placer dans le répertoire /ESCO-Grouper et lancer les commandes commandes :
| Bloc de code |
|---|
ant init ant deploy |
...
Se placer dans le répertoire /ESCO-Grouper et lancer les commandes commandes :
| Bloc de code |
|---|
ant dbinit ant dbdeploy |
...
Se placer dans le répertoire /ESCO-Grouper et lancer les commandes commandes :
| Bloc de code |
|---|
ant init ant dbdeploy ant deploy |
...
L'ensemble des fichiers de configuration à modifier se trouvent dans le répertoire /ESCO-Grouper/properties.
| Ancre | ||||
|---|---|---|---|---|
|
Il s'agit du fichier d'environnement nécessaire à la compilation via la tâche ant.
Clef | Description | Exemple |
|---|---|---|
escogrouper.property.file | Nom du fichier de propriété à utiliser pour la compilation situé dans le répertoire /ESCO-Grouper/properties | ESCOGrouper.properties |
javascript.compression | Compiler en utilisant le mode de compression des JavaScript | true |
MAVEN |
|
|
maven.home | Répertoire où se situe Maven | /opt/apache-maven-2.2.0 |
maven.offline | Compilation Maven en mode offline | false |
maven.quiet | Niveau de commentaire des tâches Maven. Affiche seulement les erreurs si en mode true. | false |
TOMCAT |
|
|
tomcat.deploy.mode | Détermine le mode de déploiement en local (local) ou à distance (remote). | local |
tomcat.webapps.directory | Répertoire de déploiement dans le cas du mode local | /opt/tomcat/webapps |
tomcat.host | Url d'accès au manager du Tomcat. Cette url est nécessaire pour le déploiement de l'application en mode remote. | |
tomcat.user | Login du compte à utiliser pour se connecter au manager (mode remote) | manager |
tomcat.password | Mot de passe du compte à utiliser pour se connecter au manager (mode remote) | manager |
| Ancre | ||||
|---|---|---|---|---|
|
Il s'agit du fichier de propriétés de l'application ESCO-Grouper.
Clef | Description | Exemple |
|---|---|---|
APPLICATION |
|
|
application.version | Version de l'application (donné à titre indicatif) | 2.6.0 |
application.versionMajorNumber | Version de l'application (donné à titre indicatif) | 2 |
application.versionMinorNumber | Version mineure de l'application. Utilisé par application.xml pour afficher le numéro de version en bas de page. | 6 |
application.versionUpdate | Version update de l'application. Utilisé par application.xml pour afficher le numéro de version en bas de page. | 0 |
application.env | Environnement de l'application (donné à titre indicatif). Les valeurs possibles sont Test, Production, Développement, ... | test |
application.type | Type de compilation. Les valeurs possibles sont servlet ou portlet. | servlet |
application.portlet.name | Nom de la portlet. Ignorer en mode servlet. | ESCOGrouperPortlet |
application.host | Hôte de l'application : adresse IP ou adresse DNS du serveur Tomcat | escogrouper.esco-portail.org |
application.context | Contexte de l'application | ESCOGrouper |
application.port | Port d'accès à l'application | 443 |
CAS |
|
|
cas.mode | Mode d'utilisation de CAS (http, https) | https |
cas.host | Hôte de CAS | auth.esco-portail.org |
cas.port | Port d'accès à CAS | 443 |
cas.uri | URI de CAS. Le / est nécessaire en début de chaîne. | / |
cas.uri.login | URI du login de CAS. Le / est nécessaire en début de chaîne. | /login |
cas.uri.logout | URI du logout de CAS. Le / est nécessaire en début de chaîne. | /logout |
cas.uri.validate | URI du validate de CAS. Le / est nécessaire en début de chaîne. | /proxyValidate |
cas.uri.proxyCallback | URI du callback de CAS. Le / est nécessaire en début de chaîne. | /casProxyCallback |
LDAP |
|
|
ldap.host | Hôte du serveur LDAP | 172.31.142.71 |
ldap.port | Port du serveur LDAP | 389 |
ldap.login | Login du serveur LDAP | admin |
ldap.password | Mot de passe du serveur LDAP | passwd |
ldap.dn | Le compte admin du LDAP | cn=grouper,dc=esco-portail,dc=org |
ldap.dn.password | Mot de passe du compte admin du LDAP | passwd |
ldap.basedc | Dc du serveur LDAP | dc=esco-portail,dc=org |
ldap.baseuid | Branche qui contient les comptes utilisateur du serveur LDAP | ou=people,dc=esco-portail,dc=org |
BASE DE DONNÉES GROUPER |
|
|
database.driver | Driver de la base de données | com.mysql.jdbc.Driver |
database.username | Login de connexion à la base de données Grouper | esco |
database.password | Mot de passe pour se connecter à la base de données Grouper | passwd |
database.url | Url de la base de données Grouper | jdbc:mysql://172.31.142.71:3306/ |
BASE DE DONNÉES MÉMOIRE DERBY |
|
|
derby.driver | Driver de la base de données | org.apache.derby.jdbc.ClientDriver |
derby.port | Port d'écoute de la base de données | 1527 |
derby.url | Url d'accès à la base de données. Sous linux, les des slashs (//opt) sont obligatoires. | jdbc:derby://localhost:1527//opt/conf.dir/data/ESCODB;create=true; |
derby.username | Utilisateur de la base de données | sa |
derby.password | Mot de passe de l'utilisateur de la base | passwd |
derby.requireAuthentication | Authentification requise ou non pour accéder à la base de données (true, false) | true |
GROUPER WS |
|
|
grouperClient.webService.url | Url d'appel des web-services Grouper | |
grouperClient.webService.login | Login de connexion aux web-services | Apd00000 |
grouperClient.webService.password | Mot de passe de connexion aux web-service | passwd |
LOG4J |
|
|
log4j.level | Niveau de log dans l'ensemble de l'application. Les valeurs possibles sont DEBUG, INFO, WARN, ERROR, FATAL | DEBUG |
log4j.appender.grouper_event.File | Fichier de log des événements Grouper |
|
log4j.appender.grouper_error.File | Fichier de log des erreurs Grouper |
|
log4j.appender.grouper_debug.File | Fichier de log du debug Grouper |
|
log4j.appender.grouper_gb.File | Fichier de log de Grouper |
|
SMTP |
|
|
smtp.host | Hôte du serveur SMTP | localhost |
smtp.port | Port du serveur SMTP | 25 |
smtp.username | Login d'accès au serveur SMTP |
|
smtp.password | Mot de passe d'accès au serveur SMTP |
|
smtp.adress | Adresse mail du destinataire | ent@esco-portail.org |
smtp.name | Nom du destinataire | Administrateurs ENT |
smtp.adressFrom | Adresse émettrice des mails | devel@esco-portail.org |
smtp.nameFrom | Nom émetteur des mails | ESCO-Portail |
smtp.copyAdress | Adresse de copie des mails | julien.gribonvald@recia.fr |
error.level | Niveau d'erreur pour envoyer les mails | ERROR |
GROUPES DYNAMIQUES |
|
|
dynamic.group | Inclure le plugin des groupes dynamiques au projet (true/false) | true |
dynamic.database.attribute.field.ldaprequest | Valeur définie dans la table grouper_fields et la colonne name. Cette valeur est l'attribut où sera sauvegardée la requête LDAP. | rule |
dynamic.group.type | Valeur définie dans la table grouper_types et la colonne name. Elle définie le type dynamique. | dynamic |
...
- 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.
...
Ce fichier concerne le paramétrage des pages relatives aux recherches recherches :
- Recherche de sujets sujets :
- Personnes
- Groupes
- Personnes dans un groupe
- Recherche de dossiers
MyStem.properties
Ce fichier concerne le paramétrage des pages relatives aux dossiers 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 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 dynamique :
- Onglet groupe dynamique
- Page Tester règle
...
Ce fichier concerne le paramétrage des pages relatives aux groupes groupes :
- Propriétés de personne :
- Attributs
- Appartenances
- Privilèges
- Abonnements
| Ancre | ||||
|---|---|---|---|---|
|
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 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/
...
Il est possible de différencier les messages d'erreurs selon les écrans. Liste des préfixes pour les exceptions des résumés 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 Exemple :
Par défaut lorsque l'exception ESCOGroupNotSaveException est levée le message « Le « 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 XX :
| Bloc de code |
|---|
org.esco.grouperui.group.resume.ESCOGroupNotSaveException=Mon nouveau message |
...
Les libellés des aides contextuelles se trouvent dans les différents fichiers d'internationalisation avec les clés se terminant par « « _TITLE »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 exemple :
| Bloc de code |
|---|
STEM_CREATE_GROUP_TITLE= |
| Ancre | ||||
|---|---|---|---|---|
|
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.
...
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 sont:
- term term : le terme de recherche qui peut contenir des caractères joker joker ;
- path path : le chemin à partir duquel on effectue la recherche recherche ;
- person person : la personne effectuant la recherche.
...
Les variables disponibles pour l'expression sont sont :
- field field : attribut sur lequel l'utilisateur effectue la recherche. Les valeurs possibles sont name, displayName et extension extension ;
- type type : le type de la recherche (simple ou pour ajout). Les valeurs possibles sont SIMPLE et ADD ADD ;
- path path : le chemin à partir duquel on effectue la recherche recherche ;
- term term : le terme de recherche qui peut contenir des caractères joker joker ;
- subject subject : la personne effectuant la recherche.
...
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 sont :
- stem stem : le dossier dans lequel l'utilisateur créé le groupe groupe ;
- person person : la personne effectuant la création.
| Ancre | ||||
|---|---|---|---|---|
|
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 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 contenu d'un fichier de profil correspond à ceci ceci :
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
<?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 » « 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.
| Ancre | ||||
|---|---|---|---|---|
|
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.
| Ancre | ||||
|---|---|---|---|---|
|
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 navigation :
| Bloc de code |
|---|
ONLINE_HELP_NAVIGUATION_AREA_URL=/ESCOGrouper/stylesheets/onlineHelp/en/navigationArea.html |
Les fichiers HTML peuvent être modifies à chaud sur le serveur Tomcat.
Remarque 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.
...
Les fichiers de configurations modifiés pour installer l'application sont les suivants 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
...
Variables d'environnement requises dans grouper.client.properties
Clef | Description | Exemple |
|---|---|---|
grouperClient.ldap.url | Url du LDAP pour Grouper client | ldap://172.31.142.71/dc=esco-portail,dc=org |
grouperClient.ldap.login | Login du compte admin du serveur LDAP | admin |
grouperClient.ldap.password | Mot de passe du compte admin du serveur LDAP | passwd |
grouperClient.webService.url | Url d'appel des web-services Grouper | |
grouperClient.webService.login | Login de connexion aux web-services | grouper |
grouperClient.webService.password | Mot de passe de connexion aux web-service | passwd |
Variables d'environnement requises dans sources.xml
Clef | Description | Exemple |
|---|---|---|
PROVIDER_URL | Url du serveur LDAP | ldap://172.31.142.71:389 |
SECURITY_PRINCIPAL | Dn du serveur LDAP | cn=admin,dc=esco-portail,dc=org |
SECURITY_CREDENTIALS | Login du compte admin du serveur LDAP | admin |
base | Base du serveur LDAP | ou=people,dc=esco-portail,dc=org |
Variables d'environnement requises dans grouper.hibernate.properties
Clef | Description | Exemple |
|---|---|---|
hibernate_driver_class | Driver de la base de données Grouper | com.mysql.jdbc.Driver |
hibernate_username | Login de connexion à la base de données Grouper | grouper |
hibernate_password | Mot de passe pour se connecter à la base de données Grouper | passwd |
hibernate_url | Url de la base de données Grouper | jdbc:mysql://escogrouper:3306/ |
Variables d'environnement requises dans log4j.properties
Clef | Description |
|---|---|
log4j.appender.grouper_event.File | Fichier de log des événements Grouper |
log4j.appender.grouper_error.File | Fichier de log des erreurs Grouper |
log4j.appender.grouper_debug.File | Fichier de log du debug Grouper |
...
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.
Clef | Description | Exemple |
|---|---|---|
mediaPath.portlet | Chemin relatif d'accès aux médias en mode Portlet | /ESCOGrouper/media |
mediaPath.servlet | Chemin relatif d'accès aux médias en mode Servlet | ../media |
cas.url.login | Url de connexion de CAS | |
cas.url.logout | Url de déconnexion de CAS | |
cas.url.validator | Url de validation CAS | |
app.spring.ckeck | Url de vérification de la validité de session | https://localhost:8443/ESCOGrouper/j_spring_cas_security_check |
cas.service | Url du service cas | |
casValidateUrl | Url du service de validation par proxy | |
proxyCallbackUrl | Url du callback service de validation par proxy | |
ldap.url | Url du serveur LDAP | ldap://0.0.0.0:389/ |
ldap.dn | Dn du serveur LDAP | cn=admin,dc=esco-portail,dc=org |
ldap.password | Login du compte admin du serveur LDAP | admin |
ldap.basedc | Dc du serveur LDAP | dc=esco-portail,dc=org |
ldap.baseuid | Id de la base LDAP | ou=people,dc=esco-portail,dc=org |
ldap.basehasMember | Base où se trouve l'information hasMember dans le LDAP | ou=groups,dc=esco-portail,dc=org |
...
Clef | Description | Exemple |
|---|---|---|
dynamic.key.attribute.ldaprequest | Mette la valeur définie dans la table grouper_fields et la colonne name. Cette valeur est l'attribut où sera sauvegardée la requête de constitution des groupes dynamiques. | rule |
dynamic.value | Mettre la valeur définie dans la table grouper_types et la colonne name. Cette valeur définit le type dynamique. | dynamic |
tab.regpresent | Remplacer la valeur « dynamique » par celle saisie précédemment dans la clé dynamic.value. |
|
tab.group.regpresent | Remplacer la valeur « dynamique » par celle saisie précédemment dans la clé dynamic.value. |
|
Exemple de fichier sources.xml de grouper-ws
...