Référence : UPA001-MI01
Date : 30/11/2009
Diffusion restreinte
Description du document

Diffusion

Historique des versions

Table des matières
1. Introduction
1.1. Objet du document
1.2. Organisation du document
1.3. Glossaire
1.4. Documents de référence
2. Installation du Front office
2.1. Installation de la base de donnée
2.1.1. Création du schéma en base de donnée
2.1.2. Initialisation des tables en base de données
2.1.3. Vérification des tables en base de données
2.2. Déploiement de l'application front office
2.2.1. Configuration de l'application
2.2.2. Déploiement de l'application
2.2.3. Intégration de l'applet au portail
3. Paramétrage du Front Office
3.1. Paramétrage Base de donnée et Hibernate
3.2. Paramétrage Web services
3.3. Paramétrage LDAP
3.4. Paramètres liés à l'adhésion
3.5. Paramétrage destinataires
3.6. Paramétrage envoi de SMS
3.7. Paramétrage CAS
3.8. Paramétrage SMTP
3.9. Paramétrage des purges
3.10. Paramétrage des traitements asynchrones
3.11. Test de connexion back office
3.12. Paramètres lié à Quartz
3.13. Paramétrage Front Office – Back Office : Mise en place des certificats

Liste des figures
Figure 1 : Fichier server.xml
Figure 2 : Intégration de la portlet au portail

Liste des tableaux
Tableau n°1: Glossaire
Tableau n°2: Documents de référence

Introduction

Objet du document

Ce document contient toutes les informations permettant l'installation des logiciels de la plateforme SMSU : le front office.

Organisation du document

Le présent rapport est divisé en cinq chapitres :

• Le chapitre 1 (présent chapitre) constitue l'introduction du document.
• Le chapitre 2 présente l'installation du Front Office du service SMS-U.
• Le chapitre 3 expose le paramétrage du Front Office du service SMS-U.

Glossaire

1. Glossaire

Documents de référence

1. Documents de référence

Installation du Front office

L'application de Front office packagée se trouve dans le dossier /dist du projet.
Dézippez le contenue de la distribution la plus récente de esup-smsu dans un répertoire de travail.
Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

Installation de la base de donnée

Le back office nécessite un serveur de base de donnée MySQL en version 5.

Création du schéma en base de donnée

Pour créer le schéma de base de donnée :

• Se connecter au serveur mysql en tant qu'administrateur et saisir le mot de passe 

• Créer un schéma nommé « smsu »

Initialisation des tables en base de données

Dans le fichier properties/config.properties, renseignez les paramètres relatifs à la base de donnée.
Il faut premièrement configurer le compte par défaut ainsi que le premier super administrateur. Pour ce faire, éditer le fichier «utils/database/populate_tables_esup-smsu.sql», puis modifier les lignes suivantes

Il faut remplacer la valeur "default account" par le nom du compte par défaut (défini dans le fichier de configuration config.properties par la clef sms.defaultAccount

Il faut remplacer la valeur "admin" par le login de la personne qui sera administrateur.
A l'aide des scripts ant fournis avec le front office, créer les tables par la tache init-data

Nb : Aucune table ne doit être présente dans le schéma smsu au moment de l'exécution de cette commande sous peine d'échec.
Nb : L'application étant lancée durant cette phase il faut que la configuration de l'application soit correcte avant de lancer la tache ant (cf chapitre 2.1.1)
Nb : Dû à un manque dans les classes appelées par la tâche init-data, il se peut que la tâche « ne rende pas la main » à la fin de son exécution. Ceci n'a pas d'impact sur les opérations effectuées.

Vérification des tables en base de données

Pour vérifier que les étapes précédentes se sont correctement déroulées :

• Se connecter à la base de donnée et saisir le mot de passe : 

• Se placer dans le schéma smsu :

• Lister les tables présentes :

La liste des tables doit apparaître de la manière suivante :

Déploiement de l'application front office

Configuration de l'application

Paramétrage des propriétés de l'application

Le back office se déploie en mode portlet.
Vérifier la configuration des fichiers :

• properties/config.properties
  • vérifier les informations de connexion à la base de donnée
  • vérifier les informations de connexion au LDAP
  • vérifier l'URL d'accès au web service du portail
  • vérifier l'URL d'accès au web service du back office
  • vérifier le chemin d'accès au fichier libmgs.properties
  • vérifiez les informations de configuration du compte de validation
  • dans le cas d'un déploiement en servlet, vérifiez le paramétrage du serveur CAS
  • vérifiez le paramétrage SMTP
  • vérifiez le paramétrage Quartz
  • de manière générale, vérifiez l'ensemble des paramètres.
• build.properties
  • Paramétrez le type de déploiement désiré. (servlet, protlet, quick-start ... voir documentation du framework : http://www.esup-portail.org/pages/viewpage.action?pageId=1867791)
• properties/logging/log4j.properties
  • Vérifier le chemin d'accès au fichier de log

Paramétrage des groupes PAGS

Déposez dans le dossier properties\groups le fichier de configuration des groupes pags PAGSGroupStoreConfig.xml
Ce fichier doit être le même que celui déposé au sein du portail.
Pour sa configuration, reportez-vous à la document disponible sur le site suivant :
http://www.esup-portail.org/consortium/espace/Socle_1A/gestion_groupes/serviceGroup/pags.html

Déploiement de l'application

L'application se déploie par la tache ant deploy :

Ajouter l'application dans le contexte du serveur du portail par le biais du fichier server.xml

Figure 1 : Fichier server.xml

Intégration de l'applet au portail

La portlet du front office se déploie par le biais du gestionnaire de canaux.
La configuration utilisée est la suivante :
Figure 2 : Intégration de la portlet au portail

Paramétrage du Front Office

Le fichier /properties/config.properties de propriété permet aux exploitants de paramétrer le Front Office.
Voici la liste des paramètres disponibles :

Paramétrage Base de donnée et Hibernate 

• Url d'accès à la base de donnée :

hibernate.connection.jdbc.url=jdbc:mysql://<host>:3306/smsu
Ce paramètre défini l'url de la base de donnée du front office 

• Login d'accès à la base de donnée :

hibernate.connection.jdbc.username=root
Ce paramètre défini le login pour l'accès à la base de donnée du front office

• Mot de passe d'accès à la base de donnée :

hibernate.connection.jdbc.password=xxxx
Ce paramètre défini le mot de passe pour l'accès à la base de donnée du front office

• Méthode d'accès à la base de donnée :

hibernate.useJndi=false
Défini le mode d'accès à la base de donnée du front office.

Paramétrage Web services

• Adresse du web service portail :

portail.ws.adress=http://\[Nom_De_La_Machine_Front_Office\]:\[Port_Portail\]/uPortal/services/UportalService

• Adresse web service back office :

smsuapi.ws.address=https://\[Nom_De_La_Machine_Back_Office\]:\[Port_WebService\]/xfire

Paramétrage LDAP

• Adresse du serveur LDAP :

ldap.url= ldap://localhost:389
Ce paramètre défini l'adresse du serveur LDAP qui sera utilisé.

• Login du serveur LDAP :

ldap.userName= cn=sms,ou=admin,dc=univ-paris1,dc=fr
Ce paramètre défini le login qui sera utilisé pour se connecter au serveur LDAP.

• Mot de passe du serveur LDAP :

ldap.password=
Ce paramètre défini le mot de passe qui sera utilisé pour se connecter au serveur LDAP.

• Timeout de connection LDAP :

ldap.connectTimeout=5000
Ce paramètre défini la durée du timeout.

• La base DN du serveur LDAP :

ldap.base=dc=univ-paris1,dc=fr
La base DN qui caractérise le LDAP

• Le DN sub path pour les utilisateurs :

ldap.dnSubPath=ou=people
Le DN sub path permettant de caractériser les utilisateurs

• L'identifiant d'utilisateur dans le LDAP :

ldap.uidAttribute=uid
Le nom de l'attribut uid dans le ldap

• Le display name de l'utilisateur dans le LDAP :

ldap.displayNameAttribute=displayName
Ce paramètre défini le nom de l'attribut qui caractérise le nom « d'affichage de l'utilisateur » (généralement son nom et prénom concaténé dans un attribut LDAP)

• Le prénom de l'utilisateur dans le LDAP :

ldap.firstNameAttribute=givenName
Ce paramètre défini le nom de l'attribut LDAP qui contient le prénom de l'utilisateur.

• Le nom de famille de l'utilisateur dans le LDAP

ldap.lastNameAttribute=sn
Ce paramètre défini le nom de l'attribut LDAP qui contient le nom de famille de l'utilisateur.

• L'adresse email de l'utilisateur dans le LDAP :

ldap.emailAttribute=mail
Ce paramètre défini le nom de l'attribut LDAP qui contient l'adresse email de l'utilisateur.

• Le numéro de téléphone portable de l'utilisateur dans le LDAP :

ldap.pagerAttribute=pager
Ce paramètre défini le nom de l'attribut LDAP qui contient le numéro de téléphone portable de l'utilisateur.

• Le champ d'acceptation des conditions d'utilisation dans le LDAP :

ldap.termsOfUseAttribute=up1TermsOfUse
Ce paramètre défini le nom de l'attribut LDAP qui contient la liste des conditions d'utilisation qui ont été acceptées par l'utilisateur.

• La valeur associée aux conditions générales :

ldap.key.cg=CG
La valeur qui sera stockée dans le LDAP à l'attribut défini par ldap.termsOfUseAttribute lorsque l'utilisateur accepte les conditions générales.

• L'attribut sur lequel s'effectue les recherches sur les utilisateurs :

ldap.searchAttribute=cn
Ce paramètre défini le nom de l'attribut LDAP sur lequel sont effectuées les recherches par nom

• L'expression permettant d'effectuer des tests :

ldap.testFilter=cn=aaron
Ce paramètre défini l'expression qui sera utilisé pour tester le LDAP par le biais des taches ant livrées par esup-commons

• La liste des attributs remontés lors des recherches :

ldap.attributes= displayName,mail,pager,up1TermsOfUse
Ce paramètre défini la liste des paramètres qui seront par défaut remontés du LDAP lors de recherches sur un utilisateur. Si plusieurs attributs sont désirés, ils doivent être séparés par une virgule dans le fichier de configuration.

• L'objectclass utilisé par le LDAP pour définir un utilisateur :

ldap.objectClass=Person
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker les utilisateurs.

• La liste des attributs affichés pour un utilisateur :

ldap.searchDisplayedAttributes=cn
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour les utilisateurs.

• L'attribut sur lequel s'effectue les recherches sur les groupes :

ldap.group.idAttribute=cn
Ce paramètre défini le nom de l'attribut LDAP sur lequel sont effectuées les recherches sur les groupes par nom.

• Le DN sub path pour les groupes :

ldap.group.dnSubPath=ou=groups
Le DN sub path permettant de caractériser les groupes

• L'identifiant du groupe dans le LDAP :

ldap.group.idAttribute=cn
Ce paramètre défini l'attribut LDAP qui est utilisé comme identifiant pour les groupes.

• La liste des membres d'un groupe dans le LDAP :

ldap.group.groupMemberAttr=member
Ce paramètre défini le nom de l'attribut LDAP qui contient la liste des membres d'un groupe.

• L'attribut sur lequel s'effectue les recherches sur les groupes :

ldap.group.groupSearchAttr=cn
Ce paramètre défini l'attribut LDAP qui sera utilisé lors des recherches par nom sur les groupes.

• La liste des attributs affichés pour un groupe :

ldap.group.groupSearchDisplayedAttr=cn
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour les groupes.

• La liste des attributs remontés lors des recherches sur les groupes :

ldap.group.groupAttr=cn,member
Ce paramètre défini la liste des paramètres qui seront par défaut remontés du LDAP lors de recherches sur les groupes. Si plusieurs attributs sont désirés, ils doivent être séparés par une virgule dans le fichier de configuration

• L'objectClass utilisé par le LDAP pour définir un groupe :

ldap.group.groupObjectClass=groupOfNames
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker les groupes.

• L'expression permettant d'effectuer des tests sur les groupes :

ldap.group.testFilter=cn=mati
Ce paramètre défini l'expression qui sera utilisé pour tester le LDAP par le biais des taches ant livrées par esup-commons

Paramètres liés à l'adhésion

• Expression régulière de validation de la forme du numéro de téléphone d'un adhérent :

adhesion.phoneNumberPattern= 06[0-9]{8}
(10 chiffres commençant par 06)
Ce paramètre peut être vidé (pas de vérification du tout)

• Activation/Désactivation de la validation par SMS du numéro de téléphone d'un adhérent : adhesion.activateValidation=true
• Nombre maximum utilisé dans la génération des codes de validation :

adhesion.maxNumberCodeValidation=100000

• • Compte d'imputation des messages de validation :

adhesion.accountValidation=[compte_de_validation]

• • Rôle associé au compte de validation (non utilisé, présent pour la cohérence des données en base :

adhesion.roleValidation=[role_compte_validation]

• • Titre du SMS de validation (corps du message envoyé) :

adhesion.titleSmsValidation=[Titre_SMS_valdidation]

• préfixe de numéro de téléphone à retirer :

adhesion.phoneNumberPrefixToRemove=
+33
Ce préfixe sera remplacé par un zéro.

• Liste des champs LDAP pouvant contenir une valeur par défaut de numéro de téléphone adhérent :

adhesion. phoneNumberAttributes=homePhone,mobile
Les champs sont séparés par une virgule.

Paramétrage destinataires

• Expression régulière de validation de la forme du numéro de téléphone d'un adhérent :

recipient.phoneNumberPattern= 06[0-9]{8}
(10 chiffres commençant par 06.
Ce paramètre peut être vidé (pas de vérification du tout)

Paramétrage envoi de SMS

• Compte par défaut d'envoi de SMS :

sms.defaultAccount=defaut

• Nombre maximum de destinataires d'un SMS déclenchant une validation automatique :

sms.nbMaxSmsBeforeSupervising=50

• • Login du superviseur par défaut :

sms.defaultSupervisorLogin=e0891022243

Paramétrage CAS

• • Attribut d'authentification utilisateur auprès du portail :

auth.portal.uidAttribute=uid

• • URL serveur CAS :

cas.url=https://\[Nom_De_La_Machine_Cas\]:\[Port_Cas\]/cas

Paramétrage SMTP

• L'adresse du serveur SMTP à utiliser :

smtp.host=an.smtp.host
Ce paramètre défini l'adresse du serveur SMTP qui sera utilisé par le front office pour envoyer les emails

• Le port du serveur SMTP à utiliser :

smtp.port=25
Ce paramètre défini le port du serveur SMTP qui sera utilisé par le front office pour envoyer les emails

• Le login a utiliser pour s'authentifier auprès du serveur SMTP :

smtp.user=
Ce paramètre défini le login a utiliser pour s'authentifier auprès du serveur SMTP qui sera utilisé par le front office pour envoyer les emails

• Le mot de passe a utiliser pour s'authentifier auprès du serveur SMTP :

smtp.password==
Ce paramètre défini le mot de passe a utiliser pour s'authentifier auprès du serveur SMTP qui sera utilisé par le front office pour envoyer les emails

• L'adresse email qui sera utilisée pour envoyer les emails:

*smtp.fromEmail=*example@domain.org
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer les emails

• L'adresse email qui sera utilisée pour envoyer les emails:

*smtp.fromEmail=*example@domain.org
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer les emails

• Le nom qui apparaitra dans les emails :

*smtp.fromName=*Name firstName
Ce paramètre défini le nom qui apparaitra comme expéditeur des emails envoyés par le front office.

Paramétrage des purges

• • Purge de la base des utilisateurs en attente de validation de numéro de téléphone :

purge.pendingMember.seniorityDay=30

• • purge de la base des messages :

purge.periodic.seniorityDay=120

Paramétrage des traitements asynchrones

• La localisation du fichier de configuration de quartz :

quartz.configFile.location=/an/example/smsu_quartz.properties
Ce paramètre défini le chemin d'accès vers le fichier de configuration de quartz.

• La cron expression utilisée par la tache de supervision d'envoi des sms :

quartz.superviseSmsSendingTrigger.cronExpression= 0 0 0,6,12,18 * * ?
Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui supervise l'envoi des SMS au back office.

• • La cron expression utilisée par la tache de purge des utilisateurs en attente de validation de numéro de téléphone :

quartz.purgePendingMemberTrigger.cronExpression = 0 0 3 1 * ?

• • La cron expression utilisée par la tache de purge des messages :

quartz.periodicPurgeTrigger.cronExpression = 0 0 3 2 * ?

• • La cron expression utilisée par la tache d'envoi de mail aux utilisateurs dont le numéro de téléphone est en erreur :

quartz.notificationByMailForInvalidPhoneTrigger.cronExpression = 0 0 12 ? * MON

Test de connexion back office

• Test de connexion avec le back office. En cas de succès, le nom de l'application cliente lue dans le certificat est retourné :

welcome. isConnexionTested= false

Paramètres lié à Quartz

Liste des paramètres :

• Le driver a utiliser pour se connecter à la base de données :

org.quartz.dataSource.myDS.driver= org.gjt.mm.mysql.Driver
Défini le driver qui sera utilisé par quartz pour se connecter à la base de données.

• L'adresse de la base de données :

org.quartz.dataSource.myDS.URL=jdbc:mysql://<host>/smsu
Défini l'adresse qui sera utilisée pour se connecter à la base de données.

• Le login d'accès à la base de données :

org.quartz.dataSource.myDS.user = root
Défini le login a utiliser pour se connecter à la base de données.

• Le mot de passe d'accès à la base de données :

org.quartz.dataSource.myDS.password = root
Défini le mot de passe a utiliser pour se connecter à la base de données

• Le nombre maximum de connection à la bse de donées :

org.quartz.dataSource.myDS.maxConnections = 5
Défini le nombre de connections maximum qui peuvent être utilisées.
Les autres paramètres n'ont normalement pas à être modifiés, dans le cas contraire se référer à la documentation Quartz.

Paramétrage Front Office – Back Office : Mise en place des certificats

Se reporter à la documentation UPA001-MI05.doc