manuel install esup smsu api

5/10/2018 Manuel Install Esup Smsu API - slidepdf.com

http://slidepdf.com/reader/full/manuel-install-esup-smsu-api 1/16

Service SMS-U

Université de Paris 1

Manuel d'installationdu Back Office

esup-smu-api& esup-smsu-api-admin

Référence : UPA001-MI02

Date : 09/12/2009



A propos de SMS-U

SMS-U est un service numérique mutualisé d'envoi de messages SMS développé dans le cadre de

l'Université numérique Paris Ile-de-France (UNPIdF) avec le concours financier de la Mairie de Pariset le soutien du consortium ESUP-Portail.

SMS-U est un projet porté par l'Université Paris 1 Panthéon-Sorbonne.

Les composants esup-smsu-api, esup-smsu, esup-smsu-api-admin, esup-smsu-api-mail ont étédéveloppés par OBS IT&L@bs (versions 1.0, 1.01, 1.02, 1.03).

Copyright

SMS-U - Copyright (c) 2009 Université Paris 1 Panthéon-Sorbonne

Licence

Licence ESUP-Portail

Plus d'information sur SMS-U ...

http://sourcesup.cru.fr/projects/esup-smsu http://www.esup-portail.org

Cette documentation, délivrée dans le cadre de la phase de déploiement expérimentale, estsusceptible de présenter des erreurs ou omissions. Tous signalements d’erreur, d’inexactitude etpropositions d’amélioration sont les bienvenus.

9-12-2009



Université de Paris 1 Service SMS-U

Table des matières

1. INTRODUCTION ..............................................................................................................41.1. Objet du document.................................................................................................................... 4

1.2. Organisation du document........................................................................................................ 4

1.3. Glossaire ...................................................................................................................................4

1.4. Documents de référence ...........................................................................................................4

2. INSTALLATION DU BACK OFFICE ................................................................................62.1. Installation de la base de donnée ..............................................................................................6

2.1.1. Création du schéma en base de donnée .............................................................................6

2.1.2. Initialisation des tables en base de données ........................................................................6

2.1.3. Vérification des tables en base de données .........................................................................7

2.2. Déploiement de l’application back office ...................................................................................8

2.2.1. Configuration de l’application ...............................................................................................8

2.2.2. Lancement de l’application ...................................................................................................8

3. PARAMÉTRAGE DU BACK OFFICE ..............................................................................93.1. Paramètres généraux de l’application .......................................................................................9

3.2. Paramètres lié au broker .........................................................................................................10

3.3. Paramètres lié à Quartz ..........................................................................................................11

4. INSTALLATION DE L’ADMINISTRATION DU BACK OFFICE .....................................134.1. Installation de la base de donnée ............................................................................................13

4.2. Déploiement de l’application d’administration du back office ..................................................13

4.2.1. Configuration de l’application .............................................................................................13

4.2.2. Déploiement de l’application ..............................................................................................13

4.2.3. Intégration de l’applet au portail......................................................................................... 14

5. PARAMÉTRAGE DE L’ADMINISTRATION DU BACK .................................................16

Liste des figures

FIGURE 1 : FICHIER POPULATE_TABLES_ESUP-SMSU-API.SQL...................................6

FIGURE 2 : FICHIER SERVER.XML....................................................................................14

FIGURE 3 : FICHIER SERVER.XML....................................................................................14

FIGURE 4 : INTÉGRATION DE LA PORTLET AU PORTAIL..............................................15

Liste des tableaux

Tableau n°1: Glossaire............................................................................................................4

Tableau n°2: Documents de référence....................................................................................5

Manuel installation esup-smsu-api / 16 esup-smsu-api / esup-smsu-admin




1. Introduction

1.1. Objet du document

Ce document contient toutes les informations permettant l’installation des logiciels de laplateforme SMSU : le back office et l’administration du back office.

1.2. 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 Back Office du service SMS-U.

Le chapitre 3 expose les paramétrages du Back Office du service SMS-U.

Le chapitre 4 présente l’installation de l’administration du Back Office du serviceSMS-U.

Le chapitre 3 expose les paramétrages de l’administration du Back Office du serviceSMS-U.

1.3. Glossaire

Abréviations Définitions

SMS Short Message Service

API SMS-UBack office chargé de mutualiser la gestion de l’envoi de SMS au broker pour plusieursuniversités.

Broker de SMS

Système tiers responsable de l’envoi des SMS vers les opérateurs respectifs desdestinataires des SMS.

Dans le cadre du projet, le broker est OLM.

OLM Orange on Line Multimédia

EtablissementC’est une université. Elle a son propre portail. Elle a sa propre base d’utilisateurs. Elle peutmutualiser son annuaire avec d’autres établissements.

SUPANN 2008 Version du schéma LDAP partagé par toutes les applications basées sur le modèle esup.

uPortal Portail Web standardisé par le groupement ESUP. Il s’agit du front off ice du système

UtilisateurPersonne authentifiée dans le portail uPortal et qui accède à l’IHM de service d’envoi deSMS.

IHM Interface Homme Machine

UNPIdf Université Numérique Paris Ile-de-France

API Application Programming Interface

Framework esup-commons

Framework de développement basé sur Spring, JSF et Hibernate proposé commestandard de développement d’applications dans le cadre du projet ESUP-Portail.

Tableau n°1: Glossaire

1.4. Documents de référence





Tableau n°2: Documents de référence


N° Origine Titre Référence Version Date




2. Installation du Back office

L’application de Back office packagée se trouve dans le dossier /dist du projet.Dézippez le contenue de la distribution la plus récente de esup-smsuapi dans un répertoirede travail.

Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

2.1. Installation de la base de donnée

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

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

mysql –u root -p

- Créer un schéma nommé « smsuapi »

create database smsuapi ;

2.1.2. Initialisation des tables en base de données

Dans le fichier properties/config.properties, renseignez les paramètres relatifs à la basede donnée.

Il faut premièrement configurer le premier super utilisateur de l’application.

Pour ce faire, éditer le fichier «utils/database/populate_tables_esup-smsu-api.sql», puismodifier la ligne suivante

-- Ajout du premier super administrateur

INSERT INTO user_bo_smsu VALUES (1, 3, "admin");

Figure 1 : Fichier populate_tables_esup-smsu-api.sql

Il faut remplacer admin par le login de l’utilisateur qui sera le super administrateur.

A l’aide des scripts ant fournis avec le back 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 smsuapi au moment de l’exécutionde cette commande sous peine d’échec.

Nb : L’application étant lancée durant cette phase il faut que la configuration de l’applicationsoit 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érationseffectuées.

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

mysql –u root -p

- Se placer dans le schéma smsuapi :

use smsuapi ;

- Lister les tables présentes :

show tables ;

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

+-------------------+

| Tables_in_smsuapi |

+-------------------+

| account |

| application |

| b_user || b_user_admin |

| b_vers_mana |

| b_vers_mana_admin |

| blacklist |

| fonction |

| institution |

| role |

| role_composition |

| sms |

| statistic |





| user_bo_smsu |

+-------------------+

14 rows in set (0.00 sec)

2.2. Déploiement de l’application back office

2.2.1. Configuration de l’application

Le back office se déploie en mode servlet.

Vérifier la configuration des fichiers :

- properties/config.properties

o vérifier les informations de connexion à la base de donnée

o vérifier le chemin d’accès au fichier libmgs.properties

- properties/libmgs.properties

o Pas de paramétrage à modifier à l’heure actuelle

- build.properties

o 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

o Vérifier le chemin d’accès du fichier de log

2.2.2. Lancement de l’application

L’application se lance par la tache ant start si le mode quick-start est paramétré dans lefichier build.properties :

ant start

L’application peut être déployée dans un serveur d’applications existant, voir documentation

du framework (http://www.esup-portail.org/pages/viewpage.action?pageId=1867791)





3. Paramétrage du Back Office

Deux fichiers de propriété permettent aux exploitants de paramétrer le Back Office : unfichier pour les paramètres généraux de l’application (config.properties) et un fichier pour lesparamètres lié au broker (libmgs.properties).

3.1. Paramètres généraux de l’application

Voici la liste des paramètres disponibles :

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

hibernate.connection.jdbc.url=jdbc:mysql://<host>:3306/smsuapi

Ce paramètre défini l’url de la base de donnée du back office.

• Login d’accès à la base de donnée :hibernate.connection.jdbc.username=

Ce paramètre défini le login pour l’accès à la base de donnée du back office.

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

hibernate.connection.jdbc.password=

Ce paramètre défini le mot de passe pour l’accès à la base de donnée duback office.

• Mode d’accès à la base de donnée :

hibernate.useJndi=false

Défini le mode d’accès à la base de donnée du back office.

• Nom du connecteur OLM utilisé :

sms.connector.olm.name=smsuapi

Ce paramètre défini le nom du connecteur OLM utilisé par l’application. Cenom doit être identique à celui que l’on trouve dans le fichier libmgs.propertieset notamment dans le champ libmgs.< name>.sid.

• Localisation du fichier de configuration de la libraire MGS :

sms.connector.olm.propertyFile=/an/example/libmgs.properties

Ce paramètre défini le chemin d’accès vers le fichier contenant laconfiguration de la librairie MGS.

•

Statut utilisé par OLM pour définir un envoi réussi :sms.connector.olm.olmSentStatusCode=0

Ce paramètre défini la valeur du statut envoyée par les acquittements d’OLMdéfinissant un SMS transmis avec succès.

• Statut utilisé par OLM définissant un échec d’envoi:

sms.connector.olm.olmErrorStatusCode=1

Ce paramètre défini la valeur du statut envoyée par les acquittements d’OLMdéfinissant une erreur lors de la transmission d’un SMS.

• Valeur de la cause utilisée par OLM pour définir un échec d’envoi du à un numéroinvalide:

sms.connector.olm.olmInvalidMSISDNCauseCode=10





Ce paramètre défini la valeur de la cause envoyée par les acquittementsd’OLM définissant une erreur lors de la transmission d’un SMS du à unnuméro invalide.

• Active / désactive l’envoi effectif des SMS :

sms.connector.simulateSending=false

Ce paramètre sert à désactiver l’envoi effectif des messages au broker. Si à« true » alors aucun message ne sera envoyé au broker.

• Nombre maximum de jour de conservation des SMS :

purge.sms.seniorityDay=90

Ce paramètre sert à définir la durée maximum (en jours) de conservation desSMS en base avant que ceux ci ne soient purgés.

• Nombre maximum de jour de conservation des statistiques :

purge.statistic.seniorityDay=365

Ce paramètre sert à définir la durée maximum (en jours) de conservation desstatistiques en base avant que ceux ci ne soient purgés. Ces statistiques sont

utilisés pour la création des rapports consolidés.

• La localisation du fichier de configuration de quartz :

quartz.configFile.location=/an/example/smsuapi_quartz.properties

Ce paramètre défini le chemin d’accès vers le fichier de configuration dequartz.

• La cron expression utilisée par la tache de génération des statistiques :

quartz.buildStatisticsTrigger.cronExpression = 0 0 0 1 * ?

Ce paramètre défini l’expression cron qui est utilisée pour planifier la tache quigénère les statistiques nécessaires aux relevés consolidés.

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

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

Ce paramètre défini l’expression cron qui est utilisée pour planifier la tache quipurge les SMS.

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

quartz.purgeStatisticTrigger.cronExpression = 0 0 5 1 * ?

Ce paramètre défini l’expression cron qui est utilisée pour planifier la tache quipurge les statistiques.

3.2. Paramètres lié au brokerVoici la liste des paramètres disponibles :

• Identifiant de l’application :

libmgs.smsuapi.sid=2421

L’identifiant unique de l’application (fourni par OLM)

• Mode de fonctionnement de la librairie :

libmgs.smsuapi.mode=sgs

Spécifie le mode de fonctionnement de la librairie (texte, voix, fax …)

• Url utilisée pour l’envoi de SMS :

libmgs.smsuapi.mgs.messageUrl=https://sms.cvf.fr/cgi-bin/messages.cgi

Défini l’url à appeler pour envoyer des SMS.





• Url utilisée pour le suivi des acquittements des SMS :

libmgs.smsuapi.mgs.notifUrl=http://sms.cvf.fr/cgi-bin/notifications.cgi

Défini l’url à utiliser pour suivre les acquittements des SMS.

• Localisation du certificat :

libmgs.smsuapi.https.keystore=/an/example/certificat.ksDéfini le chemin d’accès jusqu’au certificat utilisé pour communiquer avecOLM

• Mot de passe du certificat :

libmgs.smsuapi.https.passwd=xxxxxxx

Défini le mot de passe du certificat

• Type de logger :

libmgs.smsuapi.log.type=file

Défini le type de logger utilisé par la librairie.

• Fichier de log :

libmgs.smsuapi.log.file.path=/an/example/pushLibMGS.log

Défini le chemin d’accès du fichier de log utilisé par la librarie libMGS.

• Timeout de notification :

libmgs.smsuapi.advanced.notifTimeout=1

Défini la durée (en minute) avant que la connexion vers l’url de notification soitautomatiquement fermée et ré-ouverte.

• Timeout :

libmgs.smsuapi.timeout=15

Défini la durée (en seconde) du timeout.

3.3. 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 dedonnées.

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

org.quartz.dataSource.myDS.URL=jdbc:mysql://<host>/smsuapiDé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 = 5Dé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 seréférer à la documentation Quartz.


4. Installation de l’administration du Back office

L’application de d’administration Back office packagée se trouve dans le dossier /dist duprojet.

Dézippez le contenue de la distribution la plus récente de esup-smsuapiadmin dans unrépertoire de travail.

Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

4.1. Installation de la base de donnée

L’administration du back office utilise la même base de données que celle du back office. Il

n’y a donc pas de procédure d’installation de base de données pour l’administration du backoffice.

4.2. Déploiement de l’application d’administration du backoffice

4.2.1. Configuration de l’application

Le back office se déploie en mode portlet.

Vérifier la configuration des fichiers :

- properties/config.properties

- build.properties

- properties/logging/log4j.properties

4.2.2. Déploiement de l’application

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



<GlobalNamingResources>

…

…

<Context path="/esup-smsu-api-admin" docBase="N:/outils/esup-2.6-esup-2.0.5/Portail/webapps/esup-smsu-api-admin/" />

</Host>

</Engine>

</Service>

</Server>

Figure 2 : Fichier server.xml

Il faut également modifier la configuration du connecteur http du portail, également par sonfichier server.xml. il faut ajouter le paramètre emptySessionPath="true"



<Connector port="8082" maxHttpHeaderSize="8192"

maxThreads="150" minSpareThreads="25" maxSpareThreads="75"

enableLookups="false" redirectPort="8443" acceptCount="100"

connectionTimeout="20000" disableUploadTimeout="true"

emptySessionPath="true"/>

Figure 3 : Fichier server.xml

Ce paramètre permet à la servlet de téléchargement de fonctionner correctement.

Le reste du déploiement est conforme à un déploiement portlet dans le portail esup.

4.2.3. Intégration de l’applet au portail

La portlet d’administration du back office se déploie par le biais du gestionnaire de canaux.La configuration utilisée est la suivante :




Figure 4 : Intégration de la portlet au portail





5. Paramétrage de l’administration du Back

Un fichier de propriété permet aux exploitants de paramétrer l’administration du Back Office.Voici la liste des paramètres disponibles :

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

hibernate.connection.jdbc.url=jdbc:mysql://<host>:3306/smsuapi

Ce paramètre défini l’url de la base de donnée du back 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 back 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 back 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.

• Le nom de l’attribut uid dans le portail :

auth.portal.uidAttribute=false

Défini le nom de l’attribut définissant l’uid.

• L’url du serveur cas :

cas.url=https://<host>:<port>/cas

Défini l’adresse du serveur cas.
