Sommaire |
---|
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
Bloc de code mysql -u root -p
- Créer un schéma nommé « smsu »
Bloc de code create database 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
Bloc de code |
---|
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
Bloc de code |
---|
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
Bloc de code |
---|
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 "Configuration_de_l'application")
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 :
Bloc de code mysql -u root -p
- Se placer dans le schéma smsu :
Bloc de code use smsu ;
- Lister les tables présentes :
La liste des tables doit apparaître de la manière suivante :Bloc de code show tables ;
Bloc de code +--------------------------+ | Tables_in_smsu | +--------------------------+ | account | | b_user | | b_vers_mana | | basic_group | | customized_group | | fonction | | mail | | mail_recipient | | message | | pending_member | | person | | recipient | | role | | role_composition | | service | | supervisor | | supervisor_sender | | template | | to_mail_recipient | | to_recipient | +-------
...
Service SMS-U |
|
| Université de Paris 1 |
|
|
| Manuel d'installation du Front Office |
...
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 |
...
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
...
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.
...
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 :
- Se connecter au serveur mysql en tant qu'administrateur et saisir le mot de passe
mysql --u root -p |
- Créer un schéma nommé « smsu »
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"); |
...
INSERT INTO customized_group VALUES (1, 1, 1, "admin", 1, 1, 1); |
...
ant init-data |
...
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 :
mysql --u root -p |
- Se placer dans le schéma smsu :
use smsu ; |
- Lister les tables présentes :
show tables ; |
...
-------------------
...
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
-------------------
...
+ 20 rows in set (0.
...
00 sec)
...
...
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 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=1867791framework esup-commons)
- properties/logging/log4j.properties
- Vérifier le chemin d'accès au fichier de log
...
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 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 deploy :
Bloc de code |
---|
ant deploy |
Ajouter l'application dans le contexte du serveur du portail par le biais du fichier server.xml
Bloc de code |
---|
<Server port="8007" shutdown="SHUTDOWN"> |
...
<!-- Global JNDI resources --> |
...
<GlobalNamingResources> ... |
...
... |
...
<Context path="/esup-smsu" docBase="N:/outils/esup-2.6-esup-2.0.5/Portail/webapps/esup-smsu/" /> |
...
</Host> |
...
</Engine> |
...
</Service> |
...
</Server>
|
...
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 suivante :
anchor
...
...
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 disponibles :
...
...
Paramétrage Base de donnée et
...
Hibernate
- Url d'accès à la base de donnée donnée :
Ce paramètre défini l'url de la base de donnée du frontBloc de code hibernate.connection.jdbc.url=jdbc:mysql://<host>:3306/smsu
...
- office
- Login d'accès à la base de donnée donnée :
Ce paramètre défini le login pour l'accès à la base de donnée du front officeBloc de code hibernate.connection.jdbc.username=root
- Mot de passe d'accès à la base de donnée donnée :
Ce paramètre défini le mot de passe pour l'accès à la base de donnée du front officeBloc de code hibernate.connection.jdbc.password=xxxx
- Méthode d'accès à la base de donnée donnée :
Défini le mode d'accès à la base de donnée du front office.Bloc de code hibernate.useJndi=false
...
Paramétrage Web services
- Adresse du web service portail portail :
...
Bloc de code portail.ws.adress
...
=http://
...
[Nom_De_La_Machine_Front_Office
...
]:
...
[Port_Portail
...
]/uPortal/services/UportalService
- Adresse web service back office office :
...
Bloc de code smsuapi.ws.address
...
=https://
...
[Nom_De_La_Machine_Back_Office
...
]:
...
[Port_WebService
...
]/xfire
...
...
Paramétrage LDAP
- Adresse du serveur LDAP LDAP :
Ce paramètre défini l'adresse du serveur LDAP qui sera utilisé.Bloc de code ldap.url=ldap://localhost:389
- Login du serveur LDAP LDAP :
Ce paramètre défini le login qui sera utilisé pour se connecter au serveur LDAP.Bloc de code ldap.userName=cn=sms,ou=admin,dc=univ-paris1,dc=fr
- Mot de passe du serveur LDAP LDAP :
Ce paramètre défini le mot de passe qui sera utilisé pour se connecter au serveur LDAP.Bloc de code ldap.password=
- Timeout de connection LDAP LDAP :
Ce paramètre défini la durée du timeout.Bloc de code ldap.connectTimeout=5000
- La base DN du serveur LDAP LDAP :
La base DN qui caractérise le LDAPBloc de code ldap.base=dc=univ-paris1,dc=fr
- Le DN sub path pour les utilisateurs utilisateurs :
Le DN sub path permettant de caractériser les utilisateursBloc de code ldap.dnSubPath=ou=people
- L'identifiant d'utilisateur dans le LDAP LDAP :
Le nom de l'attribut uid dans le ldapBloc de code ldap.uidAttribute=uid
- Le display name de l'utilisateur dans le LDAP LDAP :
Ce paramètre défini le nom de l'attribut qui caractérise le nomBloc de code ldap.displayNameAttribute=displayName
...
- « 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 :
Ce paramètre défini le nom de l'attribut LDAP qui contient le prénom de l'utilisateur.Bloc de code ldap.firstNameAttribute=givenName
- Le nom de famille de l'utilisateur dans le LDAP
Ce paramètre défini le nom de l'attribut LDAP qui contient le nom de famille de l'utilisateur.Bloc de code ldap.lastNameAttribute=sn
- L'adresse email de l'utilisateur dans le LDAP LDAP :
Ce paramètre défini le nom de l'attribut LDAP qui contient l'adresse email de l'utilisateur.Bloc de code ldap.emailAttribute=mail
- Le numéro de téléphone portable de l'utilisateur dans le LDAP LDAP :
Ce paramètre défini le nom de l'attribut LDAP qui contient le numéro de téléphone portable de l'utilisateur.Bloc de code ldap.pagerAttribute=pager
- Le champ d'acceptation des conditions d'utilisation dans le LDAP LDAP :
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.Bloc de code ldap.termsOfUseAttribute=up1TermsOfUse
- La valeur associée aux conditions générales générales :
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.Bloc de code ldap.key.cg=CG
- L'attribut sur lequel s'effectue les recherches sur les utilisateurs utilisateurs :
Ce paramètre défini le nom de l'attribut LDAP sur lequel sont effectuées les recherches par nomBloc de code ldap.searchAttribute=cn
- L'expression permettant d'effectuer des tests tests :
Ce paramètre défini l'expression qui sera utilisé pour tester le LDAP par le biais des taches ant livrées par esup-commonsBloc de code ldap.testFilter=cn=*aaron*
- La liste des attributs remontés lors des recherches recherches :
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.Bloc de code ldap.attributes=displayName,mail,pager,up1TermsOfUse
- L'objectclass utilisé par le LDAP pour définir un utilisateur utilisateur :
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker les utilisateurs.Bloc de code ldap.objectClass=Person
- La liste des attributs affichés pour un utilisateur utilisateur :
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour les utilisateurs.Bloc de code ldap.searchDisplayedAttributes=cn
- L'attribut sur lequel s'effectue les recherches sur les groupes groupes :
Ce paramètre défini le nom de l'attribut LDAP sur lequel sont effectuées les recherches sur les groupes par nom.Bloc de code ldap.group.idAttribute=cn
- Le DN sub path pour les groupes groupes :
Le DN sub path permettant de caractériser les groupesBloc de code ldap.group.dnSubPath=ou=groups
- L'identifiant du groupe dans le LDAP LDAP :
Ce paramètre défini l'attribut LDAP qui est utilisé comme identifiant pour les groupes.Bloc de code ldap.group.idAttribute=cn
- La liste des membres d'un groupe dans groupe dans le LDAP LDAP :
Ce paramètre défini le nom de l'attribut LDAP qui contient la liste des membres d'un groupe.Bloc de code ldap.group.groupMemberAttr=member
- L'attribut sur lequel s'effectue les recherches sur les groupes :groupes :
Ce paramètre défini l'attribut LDAP qui sera utilisé lors des recherches par nom sur les groupes.Bloc de code ldap.group.groupSearchAttr=cn
- La liste des attributs affichés pour un groupe groupe :
Lorsque l'affichage est confié à esup-commons, ce paramètre sert à définir les attributs à afficher pour les groupes.Bloc de code ldap.group.groupSearchDisplayedAttr=cn
- La liste des attributs remontés lors des recherches sur les groupes :
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 configurationBloc de code ldap.group.groupAttr=cn,member
- L'objectClass utilisé par le LDAP pour définir un groupe groupe :
Ce paramètre défini l'object dont ce sert le serveur LDAP pour stocker les groupes.Bloc de code ldap.group.groupObjectClass=groupOfNames
- L'expression permettant d'effectuer des tests sur tests sur les groupes :
Ce paramètre défini l'expression qui sera utilisé pour tester le LDAP par le biais des taches ant livrées par esup-commonsBloc de code ldap.group.testFilter=cn=*mati*
...
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 adhérent :
...
Bloc de code 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 adhérent :
Bloc de code adhesion.activateValidation=true
- Nombre maximum utilisé dans la génération des codes de validation validation :
Bloc de code adhesion.maxNumberCodeValidation=100000
- Compte d'imputation des messages de validation validation :
...
Bloc de code
...
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 base :
...
Bloc de code
...
adhesion.roleValidation
...
=
...
[role_compte_validation
...
]
- Titre du SMS de validation (corps du message envoyé) :
...
Bloc de code
...
adhesion.titleSmsValidation
...
=
...
[Titre_SMS_valdidation
...
]
- préfixe de numéro de téléphone à retirer :
Bloc de code adhesion.phoneNumberPrefixToRemove=
...
Ce préfixe sera remplacé par un zéro.+33
- Liste des champs LDAP pouvant contenir une valeur par défaut de numéro de téléphone adhérent adhérent :
Les champs sont séparés parBloc de code adhesion.phoneNumberAttributes=homePhone,mobile
...
- 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 adhérent :
...
Bloc de code recipient.phoneNumberPattern
...
=
...
(1006\[0-9\]\{8\}
...
- 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 :
Bloc de code sms.defaultAccount=defaut
- Nombre maximum de destinataires d'un SMS déclenchant une validation automatique automatique :
Bloc de code sms.nbMaxSmsBeforeSupervising=50
- Login du superviseur par défaut défaut :
Bloc de code sms.defaultSupervisorLogin=e0891022243
...
...
Paramétrage CAS
- Attribut d'authentification utilisateur auprès du portail portail :
Bloc de code auth.portal.uidAttribute=uid
- URL serveur CAS CAS :
...
Bloc de code cas.url
...
=https://\[Nom_De_La_Machine_Cas\]:\[Port_Cas\]/cas
...
...
Paramétrage SMTP
- L'adresse du serveur SMTP à utiliser :
Ce paramètre défini l'adresse du serveur SMTP qui sera utilisé par le front office pour envoyer les emailsBloc de code smtp.host=an.smtp.host
- Le port du serveur SMTP à utiliser :
Ce paramètre défini le port du serveur SMTP qui sera utilisé par le front office pour envoyer les emailsBloc de code smtp.port=25
- Le login a utiliser pour s'authentifier auprès du serveur SMTP :
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 emailsBloc de code smtp.user=
- Le mot de passe a utiliser pour s'authentifier auprès du serveur SMTP :
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 emailsBloc de code smtp.password==
- L'adresse email qui sera utilisée pour envoyer les emails:
Bloc de code
...
smtp.fromEmail=
...
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer les emailsexample@domain.org
- L'adresse email qui sera utilisée pour envoyer les emails:
...
Bloc de code smtp.fromEmail=
...
Ce paramètre défini l'adresse email qui sera utiliser pour envoyer les emailsexample@domain.org
- Le nom qui apparaitra dans les emails :
...
Bloc de code smtp.fromName=
...
Ce paramètre défini le nom qui apparaitra comme expéditeur des emails envoyés par le front office.Name firstName
...
...
Paramétrage des purges
- Purge de la base des utilisateurs en attente de validation de numéro de téléphone téléphone :
Bloc de code purge.pendingMember.seniorityDay=30
- purge de la base des messages messages :
Bloc de code purge.periodic.seniorityDay=120
...
...
Paramétrage des traitements asynchrones
- La localisation du fichier de configuration de quartz :
Ce paramètre défini le chemin d'accès vers le fichier de configuration de quartz.Bloc de code quartz.configFile.location=/an/example/smsu_quartz.properties
- La cron expression utilisée par la tache de supervision d'envoi des sms :
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.Bloc de code quartz.superviseSmsSendingTrigger.cronExpression=0 0 0,6,12,18 * * ?
- La cron expression utilisée par la tache de purge des utilisateurs en attente de validation de numéro de téléphone téléphone :
Bloc de code quartz.purgePendingMemberTrigger.cronExpression=0 0 3 1 * ?
- La cron expression utilisée par la tache de purge des messages messages :
Bloc de code 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 erreur :
Bloc de code 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é retourné :
Bloc de code welcome.isConnexionTested=false
...
...
Paramètres lié à Quartz
Liste des paramètres paramètres :
- Le driver a utiliser pour se connecter à la base de données données :
Défini le driver qui sera utilisé par quartz pour se connecter à la base de données.Bloc de code org.quartz.dataSource.myDS.driver=org.gjt.mm.mysql.Driver
- L'adresse de la base de données données :
Défini l'adresse qui sera utilisée pour se connecter à la base de données.Bloc de code org.quartz.dataSource.myDS.URL=jdbc:mysql://<host>/smsu
- Le login d'accès à la base de données données :
Défini le login a utiliser pour se connecter à la base de données.Bloc de code org.quartz.dataSource.myDS.user=root
- Le mot de passe d'accès à la base de données données :
Défini le mot de passe a utiliser pour se connecter à la base de donnéesBloc de code org.quartz.dataSource.myDS.password=root
- Le nombre maximum de connection à la bse de donées donées :
Défini le nombre de connections maximum qui peuvent être utilisées.Bloc de code org.quartz.dataSource.myDS.maxConnections=5
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 Installation des certificats esup-smsu