Service SMS-U |
|
|
Université de Paris 1 |
|
|
|
Manuel d'installation du Front Office |
Référence : UPA001-MI01
Date : 30/11/2009
Diffusion restreinte
Description du document
Propriété |
|
|
|
|
Client |
Université de Paris 1 |
|
|
|
Titre projet |
Service SMS-U |
|
|
|
Titre document |
Manuel d'installation du Front Office |
|
|
|
Référence |
UPA001-MI01 |
|
|
|
Version |
1.3 |
|
|
|
Classification |
Diffusion restreinte |
|
|
|
Rédacteur |
Christophe Pinel |
|
|
|
Statut |
!worddav3ce1dccdc1b9805ac3af35b7e4188ef6.wmf|height=27,width=112! !worddav50e713f35a9b3db108ea29c9938b6ea2.wmf|height=27,width=123! !worddav1848d48d431fdd12740c5fd19aeea518.wmf|height=27,width=116! !worddavebaeb392e0f517394fb950c66f7c9d51.wmf|height=27,width=95! |
|
|
|
|
K. CHEVALIER |
Equipe projet |
H. DROLON |
|
Date |
30/11/2009 |
|
|
|
Diffusion
Société |
Nom |
Fonction |
Diffusion |
Université de Paris 1 |
B. ROQUES |
Chef de projet |
validation |
|
A. ANLI |
Responsable Technique |
lecture |
|
|
|
|
Orange Business Services SilicompAQL |
K. CHEVALIER |
Responsable Technique |
rédaction |
|
H. DROLON |
Chef de projet |
approbation |
Historique des versions
Version |
Opération |
Nom |
Date |
1.0 |
création |
C. PINEL |
26/06/2009 |
1.1 |
Séparation du manuel en trois parties : un manuel pour le Front Office, un manuel pour le Back Office et un pour l'application 'envoi de SMS par mail' |
K. CHEVALIER |
09/07/2009 |
1.2 |
Ajout de paramétrage de l'application |
C. PINEL |
31/07/2009 |
1.3 |
Modification des commandes suite à la mise en place des distributions |
M. JANVIER |
30/11/2009 |
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
Ce document contient toutes les informations permettant l'installation des logiciels de la plateforme SMSU : le front office.
Le présent rapport est divisé en cinq chapitres :
Abréviations |
Définitions |
|
|
|
|
|
|
N° |
Origine |
Titre |
Référence |
Version |
Date |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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éé.
Le back office nécessite un serveur de base de donnée MySQL en version 5.
Pour créer le schéma de base de donnée :
mysql --u root -p |
create database smsu ; |
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
INSERT INTO account VALUES (1, "default account"); |
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
INSERT INTO customized_group VALUES (1, 1, 1, "admin", 1, 1, 1); |
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
ant 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.
Pour vérifier que les étapes précédentes se sont correctement déroulées :
mysql --u root -p |
use smsu ; |
show tables ; |
La liste des tables doit apparaître de la manière suivante :
------------------- |
|
Tables_in_smsu |
|
account |
|
b_user |
|
b_vers_mana |
|
basic_group |
|
customized_group |
|
fonction |
|
|
|
mail_recipient |
|
message |
|
pending_member |
|
person |
|
recipient |
|
role |
|
role_composition |
|
service |
|
supervisor |
|
supervisor_sender |
|
template |
|
to_mail_recipient |
|
to_recipient |
|
Le back office se déploie en mode portlet.
Vérifier la configuration des fichiers :
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
L'application se déploie par la tache ant deploy :
ant deploy |
Ajouter l'application dans le contexte du serveur du portail par le biais du fichier server.xml
<Server port="8007" shutdown="SHUTDOWN"> |
Figure 1 : Fichier server.xml
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
Le fichier /properties/config.properties de propriété permet aux exploitants de paramétrer le Front Office.
Voici la liste des paramètres disponibles :
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
hibernate.connection.jdbc.username=root
Ce paramètre défini le login pour l'accès à la base de donnée du front office
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
hibernate.useJndi=false
Défini le mode d'accès à la base de donnée du front office.
*portail.ws.adress*=http://\[Nom_De_La_Machine_Front_Office\]:\[Port_Portail\]/uPortal/services/UportalService |
*smsuapi.ws.address*=https://\[Nom_De_La_Machine_Back_Office\]:\[Port_WebService\]/xfire |
ldap.url= ldap://localhost:389
Ce paramètre défini l'adresse du serveur LDAP qui sera utilisé.
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.
ldap.password=
Ce paramètre défini le mot de passe qui sera utilisé pour se connecter au serveur LDAP.
ldap.connectTimeout=5000
Ce paramètre défini la durée du timeout.
ldap.base=dc=univ-paris1,dc=fr
La base DN qui caractérise le LDAP
ldap.dnSubPath=ou=people
Le DN sub path permettant de caractériser les utilisateurs
ldap.uidAttribute=uid
Le nom de l'attribut uid 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)
ldap.firstNameAttribute=givenName
Ce paramètre défini le nom de l'attribut LDAP qui contient le prénom de l'utilisateur.
ldap.lastNameAttribute=sn
Ce paramètre défini le nom de l'attribut LDAP qui contient le nom de famille de l'utilisateur.
ldap.emailAttribute=mail
Ce paramètre défini le nom de l'attribut LDAP qui contient l'adresse email de l'utilisateur.
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.
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.
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.
ldap.searchAttribute=cn
Ce paramètre défini le nom de l'attribut LDAP sur lequel sont effectuées les recherches par nom
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
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.
ldap.objectClass=Person
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker les utilisateurs.
ldap.searchDisplayedAttributes=cn
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour les utilisateurs.
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.
ldap.group.dnSubPath=ou=groups
Le DN sub path permettant de caractériser les groupes
ldap.group.idAttribute=cn
Ce paramètre défini l'attribut LDAP qui est utilisé comme identifiant pour les groupes.
ldap.group.groupMemberAttr=member
Ce paramètre défini le nom de l'attribut LDAP qui contient la liste des membres d'un groupe.
ldap.group.groupSearchAttr=cn
Ce paramètre défini l'attribut LDAP qui sera utilisé lors des recherches par nom sur les groupes.
ldap.group.groupSearchDisplayedAttr=cn
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour 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
ldap.group.groupObjectClass=groupOfNames
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker 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
*adhesion.phoneNumberPattern*= 06\[0-9\]\{8\} (10 chiffres commençant par 06) Ce paramètre peut être vidé (pas de vérification du tout) |
adhesion.maxNumberCodeValidation=100000
*adhesion.accountValidation*=\[compte_de_validation\] |
*adhesion.roleValidation*=\[role_compte_validation\] |
*adhesion.titleSmsValidation*=\[Titre_SMS_valdidation\] |
adhesion.phoneNumberPrefixToRemove=
+33
Ce préfixe sera remplacé par un zéro.
adhesion. phoneNumberAttributes=homePhone,mobile
Les champs sont séparés par une virgule.
*recipient.phoneNumberPattern*= 06\[0-9\]\{8\} (10 chiffres commençant par 06. Ce paramètre peut être vidé (pas de vérification du tout) |
sms.defaultAccount=defaut
sms.nbMaxSmsBeforeSupervising=50
sms.defaultSupervisorLogin=e0891022243
auth.portal.uidAttribute=uid
*cas.url*=https://\[Nom_De_La_Machine_Cas\]:\[Port_Cas\]/cas |
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
smtp.port=25
Ce paramètre défini le port du serveur SMTP qui sera utilisé par le front office pour envoyer les emails
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
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
*smtp.fromEmail=*example@domain.org
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer les emails
*smtp.fromEmail=*example@domain.org
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer 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.
purge.pendingMember.seniorityDay=30
purge.periodic.seniorityDay=120
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.
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.
quartz.purgePendingMemberTrigger.cronExpression = 0 0 3 1 * ?
quartz.periodicPurgeTrigger.cronExpression = 0 0 3 2 * ?
quartz.notificationByMailForInvalidPhoneTrigger.cronExpression = 0 0 12 ? * MON
welcome. isConnexionTested= false
Liste des paramètres :
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.
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.
org.quartz.dataSource.myDS.user = root
Défini le login a utiliser pour se connecter à 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
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.
Se reporter à la documentation UPA001-MI05.doc