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 :

...

• 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.

...

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 :

  Bloc de code
  show tables ;

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

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

• 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 esup-commons)
• 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 :

...

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

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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  portail.ws.adress=http://[Nom_De_La_Machine_Front_Office]:[Port_Portail]/uPortal/services/UportalService

• Adresse web service back office :

  Bloc de code
  smsuapi.ws.address=https://[Nom_De_La_Machine_Back_Office]:[Port_WebService]/xfire

Paramétrage LDAP

• Adresse du serveur LDAP :

  Bloc de code
  ldap.url=ldap://localhost:389

  Ce paramètre défini l'adresse du serveur LDAP qui sera utilisé.
• Login du serveur LDAP :

  Bloc de code
  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 :

  Bloc de code
  ldap.password=

  Ce paramètre défini le mot de passe qui sera utilisé pour se connecter au serveur LDAP.
• Timeout de connection LDAP :

  Bloc de code
  ldap.connectTimeout=5000

  Ce paramètre défini la durée du timeout.
• La base DN du serveur LDAP :

  Bloc de code
  ldap.base=dc=univ-paris1,dc=fr

  La base DN qui caractérise le LDAP
• Le DN sub path pour les utilisateurs :

  Bloc de code
  ldap.dnSubPath=ou=people

  Le DN sub path permettant de caractériser les utilisateurs
• L'identifiant d'utilisateur dans le LDAP :

  Bloc de code
  ldap.uidAttribute=uid

  Le nom de l'attribut uid dans le ldap
• Le display name de l'utilisateur dans le LDAP :

  Bloc de code
  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 :

  Bloc de code
  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

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  ldap.group.dnSubPath=ou=groups

  Le DN sub path permettant de caractériser les groupes
• L'identifiant du groupe dans le LDAP :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  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 :

  Bloc de code
  adhesion.activateValidation=true

• Nombre maximum utilisé dans la génération des codes de validation :

  Bloc de code
  adhesion.maxNumberCodeValidation=100000

• Compte d'imputation des messages de 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 :

  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=+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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  sms.defaultAccount=defaut

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

  Bloc de code
  sms.nbMaxSmsBeforeSupervising=50

• Login du superviseur par défaut :

  Bloc de code
  sms.defaultSupervisorLogin=e0891022243

Paramétrage CAS

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

  Bloc de code
  auth.portal.uidAttribute=uid

• URL serveur CAS :

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

Paramétrage SMTP

• L'adresse du serveur SMTP à utiliser :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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:

  Bloc de code
  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:

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  purge.pendingMember.seniorityDay=30

• purge de la base des messages :

  Bloc de code
  purge.periodic.seniorityDay=120

Paramétrage des traitements asynchrones

• La localisation du fichier de configuration de quartz :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  quartz.purgePendingMemberTrigger.cronExpression=0 0 3 1 * ?

• La cron expression utilisée par la tache de purge des 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 :

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

  Bloc de code
  welcome.isConnexionTested=false

Paramètres lié à Quartz

Liste des paramètres :

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

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 :

  Bloc de code
  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 Installation des certificats esup-smsu