Installation
du Canal SMS
Présentation
générale
Le canal mis en place ici
permet
deux
fonctionnalités :
- Possibilité aux étudiants de saisir leur
numéro
de cellulaire via le portail, ainsi que le mode de réception
des messages (courriel, sms, les 2 en même temps)
- Fonction permettant aux enseignants et
personnels d’envoyer une information
instantanément à un ou plusieurs
étudiants. Par exemple, pour les informer
d’éventuels changements d’emploi du
temps, ou pour convoquer un ou plusieurs
étudiants à un rendez-vous.
Principe
L’envoi
des messages au travers le portail se fait au moyen
d’un service de multidiffusion de messages mis en place par
France Télécom
R&D (FTR&D).
Le
service de multidiffusion de FTR&D permet à un
service applicatif (dans notre cas, il s’agit de ESUP
Portail), d’envoyer des
messages de type courriel, fax, message vocal et SMS via une interface
d’accès
en mode HTTP. Le service permet l’envoi d’un
message grâce à une simple requête
de type POST vers leur serveur. Dans notre cas, seul le mode d'envoi de
SMS est utilisé.
Notez que
chaque université doit s'abonner au service de
multidiffusion de FT afin de pouvoir utiliser ce service. Pour tout
renseignement,
contactez moi à Yohan.Colmant@univ-valenciennes.fr
Architecture du service de
multidiffusion
L’architecture
mise en place par FTR&D regroupe 2
serveurs. Le premier est le proxy d’accès au
travers duquel se fait
l’authentification, et auquel on envoie les
paramètres de la requête. Ce
serveur se situe sur leur site de Lannion.
Le
second serveur, en liaison directe avec le proxy
d’accès,
est le serveur de multidiffusion. C’est lui qui
gère la multidiffusion des
messages, il se situe à Grenoble.
Installation
L'installation du Canal SMS se repose sur les actions suivantes:
- Recopie éventuelle de la
librairie
utilisée
- Configuration du Canal
- Déploiement du Canal
Recopie des librairies
utilisées
Ce canal utilise la librairie :
- mail.jar
Cette librairie est fournie par défaut avec le
package
uPortal esup. Il n'est donc pas nécessaire de l'ajouter
manuellement
à la librairie de votre portail. Cependant, les anciennes
versions du portail utilisent une version trop ancienne de mail.jar. Si
vous rencontrez des problèmes de "ClassNotFound" lors de
l'utilisation de ce canal, voyez à remplacer le mail.jar de
la distribution esup par celui fourni avec le canal.
Configuration du Canal
Configuration
générale du Canal
La configuration
générale du Canal SMS se fait
via
le fichier properties/CSms.xml
Structure
générale
La structure
générale du fichier de configuration du
canal est la suivante:
<properties>
<!-- ************************************ -->
<!-- Serveur d'envoi de SMS et parametres -->
<!-- ************************************ -->
<!-- URL du serveur -->
<sms_url/>
<!-- Login de connexion au serveur -->
<sms_login/>
<!-- Mot de passe de connexion au serveur -->
<sms_password/>
<!-- Nombre de caracteres que peut contenir un SMS -->
<sms_size/>
<!-- Dit de qui ca vient (par exemple "De" ou "From") -->
<sms_from/>
<!-- Emetteur lors de l'envoi du code d'activation -->
<sms_from_activation/>
<!-- Sujet du message lors de l'envoi du code d'activation -->
<sms_subject_activation/>
<!-- Message lors de l'envoi du code d'activation (ce qui precede le code d'activation) -->
<sms_message_activation/>
<!-- ************************ -->
<!-- Serveur d'envoi de mails -->
<!-- ************************ -->
<!-- URL du serveur smtp -->
<mail_url/>
<!-- ************* -->
<!-- Acces au LDAP -->
<!-- ************* -->
<!-- URL du serveur LDAP -->
<ldapUrl/>
<!-- Compte pour la lecture des attributs du telephone mobile -->
<loginLdap/>
<!-- Mot de passe d'acces -->
<passwordLdap/>
<!-- Branche des groupes dans le LDAP -->
<ldapGroups/>
<!-- Branche people dans le LDAP -->
<ldapPeople/>
<!-- Filtre permettant de retrouver les institus -->
<filtreInstituts/>
<!-- Filtre permettant de retrouver les differentes formations -->
<filtreFormations/>
<!-- ********************************************** -->
<!-- Attributs LDAP contenus dans le PersonDirs.xml -->
<!-- ********************************************** -->
<!-- Attribut qui contient le numero de telephone d'une personne au format international. Par exemple +33 6 00 00 00 00 -->
<mobile_attribute/>
<!-- Attribut qui contient le mode de contact choisi par l'utilisateur -->
<contact_mode_attribute/>
<!-- attribut qui contient le mail de l'utilisateur -->
<mail_attribute/>
<!-- Attribut qui contient le nom complet d'un user -->
<display_name_attribute/>
<!-- **************************** -->
<!-- Fichier de logs pour les SMS -->
<!-- **************************** -->
<!-- Chemin complet du fichier dans lequel on ecrit les logs d'envoi des SMS -->
<logFile/>
</properties>
Nous pouvons voir apparaître en caractères gras
les
options de configuration qui doivent être
éditées
par l'administrateur du portail.
Voyons en détail ces différentes parties:
Paramètres d'envoi
de SMS
sms_url
URL du service d'envoi de FT. Par défaut
"http://scolabureau.tsar.tm.fr/proxy_notilus/index.php"
sms_login
Login fourni par FT pour accéder à leur
plate-forme.
sms_password
Mot de passe fourni par FT pour accéder à leur
plate-forme.
sms_from
Label qui permet de dire de qui vient le message. Par défaut
"De", afin de construire le SMS "De John Doe....."
sms_from_activation
Lors de l'envoi du code d'activation à l'utilisateur, on
précise de qui vient le message. Préciser donc
ici par exemple le nom de votre université.
sms_subject_activation
Le sujet du message lors de l'envoi du code d'activation via SMS. Par
défaut "Code d'activation".
sms_message_activation
La partie du corps du message qui précèdera le
code lors de l'envoi du code d'activation. Par défaut "Votre
code d'activation est".
Paramètres d'envoi
de courriels
Dans cette version, nous utilisons un serveur POP qui ne requiert pas
d'authentification. Par la suite, nous verrons à utiliser le
canal mailTo en mode servant.
mail_url
Adresse du serveur POP pour l'envoi du message en mode courriel.
Accès au serveur
LDAP
ldapUrl
L'url du serveur ldap. Typiquement cet attribut est de la forme ldap://ldap.univ.fr:389
loginLdap
DN du compte LDAP permettant de lire tous les attributs des
utilisateurs cités dans la partie "Attributs uPortal".
passwordLdap
Mot de passe du compte cité
précédemment.
ldapGroups
Branche du LDAP contenant les groupes. Exemple "ou=groups,dc=univ,dc=fr"
ldapPeople
Branche du LDAP contenant les personnes. Exemple
"ou=people,dc=univ,dc=fr"
filtreInstituts
Filtre permettant de retrouver la liste des instituts de
l'université. Par exemple
"(&(&(objectClass=uvhcGroup)(uvhcGroupeType=institut))(uvhcGroupeOrigine=APO))".
Notez qu'il faut encoder le caractère "&" en
"&" dans le fichier de config.
filtreFormations
Filtre permettant de retrouver la liste des formations de
l'université.
Par exemple
"(&(&(objectClass=uvhcGroup)(uvhcGroupeType=codeEtape))(uvhcGroupeOrigine=APO))".
Attributs uPortal
mobile_attribute
Attribut contenant le numéro de cellulaire des utilisateurs.
contact_mode_attribute
Attribut de type string qui contient le mode de réception
des messages.
mail_attribute
Contient l'adresse courriel des utilisateurs.
display_name_attribute
Contient le nom complet d'un utilisateur.
Paramètres de log
logFile
Afin de garder une trace du nombre de SMS envoyés par
utilisateur avec la date d'envoi, nous générons
un fichier de logs. Il est nécessaire de renseigner le
chemin complet de ce fichier à cet endroit. Exemple
"C:\sms.log"
Déploiement du Canal
Préparation
du
déploiement : modifier le fichier build.properties
en fonction de la
version de
portail que vous utilisez.
Lancez la commande "ant deploy"
relative au fichier build.xml
contenu dans le package.
Lors de la publication, l'administrateur devra déclarer deux
fois le canal avec des paramètres différents:
- Pour l'accès en mode de
configuration du mode de réception des messages, il faudra
déclarer l'attribut "channelMode"
avec la valeur "profil"
- Pour l'accès en mode
d'envoi des messages, il faudra déclarer l'attribut "channelMode"
avec la valeur "envoi"
