proj-sms-u
Pages enfant
  • Manual d'installation du Back Office (esup-smsu-api)

Comparaison des versions

Ancienne version 1

changes.mady.by.user Pascal Rigaux

Sauvegardée le

comparé à

Nouvelle version 2

changes.mady.by.user Pascal Rigaux

Sauvegardée le

Légende

  • Ces lignes ont été ajoutées. Ce mot a été ajouté.
  • Ces lignes ont été supprimées. Ce mot a été supprimé.
  • La mise en forme a été modifiée.
Sommaire

Service SMS-U

 

 

Université de Paris 1

 

 

 

Manuel d'installation du Back Office

...

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épertoire de travail.
Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

...

Installation de la base de donnée

Le back 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 donnée :

  • Se connecter au serveur mysql en tant qu'administrateur et saisir le mot de passe passe
    Bloc de code
    
mysql --u root -p
  • Créer un schéma nommé « smsuapi »

...

  • « smsuapi »
    Bloc de code
    
create database smsuapi ;

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 premier super utilisateur de l'application.
Pour ce faire, éditer le fichier «utils/database/populate_tables_esup-smsu-api.sql » », puis modifier la ligne suivante 

...

suivante

Bloc de code

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

Bloc de code

ant init-data

Nb : Aucune table ne doit être présente dans le schéma smsuapi au moment de l'exécution de cette commande sous peine d'échec. Nb 

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.1Configuration_de_l'application)

Nb Nb : Dû à un manque dans les classes appelées par la tâche init-data, il se peut que la tâche « ne « ne rende pas la main » 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 déroulées :

  • Se connecter à la base de donnée et saisir le mot de passe passe :  
    Bloc de code
    
mysql -u root -p
  • Se placer dans le schéma smsuapi smsuapi :
    Bloc de code
    
use

...

  •  smsuapi ;
  • Lister les tables présentes présentes :
    Bloc de code
    
show

...

  •  tables ;
    La liste des tables doit apparaître de la manière

...

  • suivante :

    ...

    Bloc de code
    
+-----------------------

...

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

  • +
| 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)

Déploiement de l'application back office

Configuration de l'application

Le back office se déploie en mode servlet.
Vérifier la configuration des fichiers fichiers :

Lancement de l'application

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

Bloc de code

ant start

L'application peut être déployée dans un serveur d'applications existant, voir la documentation du framework (http://www.esup-portail.org/pages/viewpage.action?pageId=1867791Image Removed)

...

esup-commons

Paramétrage du Back Office

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

...

lié au broker (libmgs.properties).

...

Paramètres généraux de l'application

Voici la liste des paramètres disponibles disponibles :

  • Url d'accès à la base de donnée donnée :
    Bloc de code
    
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 donnée :
    Bloc de code
    
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 donnée :
    Bloc de code
    
hibernate.connection.jdbc.password=
    Ce paramètre défini le mot de passe pour l'accès à la base de donnée du back office.
  • Mode d'accès à la base de donnée donnée :
    Bloc de code
    
hibernate.useJndi=false
    Défini le mode d'accès à la base de donnée du back office.
  • Nom du connecteur OLM utilisé utilisé :
    Bloc de code
    
sms.connector.olm.name=smsuapi
    Ce paramètre défini le nom du connecteur OLM utilisé par l'application. Ce nom doit être identique à celui que l'on trouve dans le fichier libmgs.properties et notamment dans le champ libmgs.< name>.sid.
  • Localisation du fichier de configuration de la libraire MGS MGS :
    Bloc de code
    
sms.connector.olm.propertyFile=/an/example/libmgs.properties
    Ce paramètre défini le chemin d'accès vers le fichier contenant la configuration de la librairie MGS.
  • Statut utilisé par OLM pour définir un envoi réussi réussi :
    Bloc de code
    
sms.connector.olm.olmSentStatusCode=0
    Ce paramètre défini la valeur du statut envoyée par les acquittements d'OLM définissant un SMS transmis avec succès.
  • Statut utilisé par OLM définissant un échec d'envoi:
    Bloc de code
    
sms.connector.olm.olmErrorStatusCode=1
    Ce paramètre défini la valeur du statut envoyée par les acquittements d'OLM dé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éro invalide:
    Bloc de code
    
sms.connector.olm.olmInvalidMSISDNCauseCode=10
    Ce paramètre défini la valeur de la cause envoyée par les acquittements d'OLM définissant une erreur lors de la transmission d'un SMS du à un numéro invalide.
  • Active / désactive l'envoi effectif des SMS SMS :
    Bloc de code
    
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 SMS :
    Bloc de code
    
purge.sms.seniorityDay=90
    Ce paramètre sert à définir la durée maximum (en jours) de conservation des SMS en base avant que ceux ci ne soient purgés.
  • Nombre maximum de jour de conservation des statistiques statistiques :
    Bloc de code
    
purge.statistic.seniorityDay=365
    Ce paramètre sert à définir la durée maximum (en jours) de conservation des statistiques 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 :
    Bloc de code
    
quartz.configFile.location=/an/example/smsuapi_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 génération des statistiques :
    Bloc de code
    
quartz.buildStatisticsTrigger.cronExpression=0 0 0 1  * ?
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui génère les statistiques nécessaires aux relevés consolidés.
  • La cron expression utilisée par la tache de purge des sms :
    Bloc de code
    
quartz.purgeSmsTrigger.cronExpression=0 0 3 1 *  ?
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui purge les SMS.
  • La cron expression utilisée par la tache de purge des statistiques :
    Bloc de code
    
quartz.purgeStatisticTrigger.cronExpression=0 0 5 1  * ?
    Ce paramètre défini l'expression cron qui est utilisée pour planifier la tache qui purge les statistiques.

...

Paramètres lié au broker

Voici la liste des paramètres disponibles disponibles :

  • Identifiant de l'application application :
    Bloc de code
    
libmgs.smsuapi.sid=2421
    L'identifiant unique de l'application (fourni par OLM)
  • Mode de fonctionnement de la librairie librairie :
    Bloc de code
    
libmgs.smsuapi.mode=sgs
    Spécifie le mode de fonctionnement de la librairie (texte, voix, fax ...)
  • Url utilisée pour l'envoi de SMS SMS :
    Bloc de code
    
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 SMS :
    Bloc de code
    
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 certificat :
    Bloc de code
    
libmgs.smsuapi.https.keystore=/an/example/certificat.ks
    Défini le chemin d'accès jusqu'au certificat utilisé pour communiquer avec OLM
  • Mot de passe du certificat certificat :
    Bloc de code
    
libmgs.smsuapi.https.passwd=xxxxxxx
    Défini le mot de passe du certificat
  • Type de logger logger :
    Bloc de code
    
libmgs.smsuapi.log.type=file
    Défini le type de logger utilisé par la librairie.
  • Fichier de log log :
    Bloc de code
    
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 notification :
    Bloc de code
    
libmgs.smsuapi.advanced.notifTimeout=1
    Défini la durée (en minute) avant que la connexion vers l'url de notification soit automatiquement fermée et ré-ouverte.
  • Timeout :
    Bloc de code
    
libmgs.smsuapi.timeout=15
    Défini la durée (en seconde) du timeout.

...

...

Paramètres lié à Quartz

Liste des paramètres paramètres :

  • Le driver a utiliser pour se connecter à la base de données 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 données :
    Bloc de code
    
org.quartz.dataSource.myDS.URL=jdbc:mysql://<host>/smsuapi
    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 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 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 doné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.

...

...

Installation de l'administration du Back office

L'application de d'administration 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-smsuapiadmin dans un répertoire de travail.
Le paramétrage suivant est à effectuer dans le dossier ainsi créé.

...

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 back office.

...

...

Déploiement de l'application d'administration du back office

Configuration de l'application

Le back office se déploie en mode portlet.
Vérifier la configuration des fichiers fichiers :

  • properties/config.properties
  • build.properties
  • properties/logging/log4j.properties

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-api-admin" docBase="N:/outils/esup-2.6-esup-2.0.5/Portail/webapps/esup-smsu-api-admin/" />

...

 \\
   </Host>

...

 
  </Engine>

...

 
 </Service>

...

 
</Server>

...

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

Bloc de code

 <!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->

...


 <Connector port="8082" maxHttpHeaderSize="8192

...

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

...


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

...


    connectionTimeout="20000" disableUploadTimeout="true"

...


    emptySessionPath="true"/>

...

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.

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

Figure 4 : Intégration de la portlet au portail

...


Figure 4 : Intégration de la portlet au portail

...

Paramétrage de l'administration du Back Office

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

  • Url d'accès à la base de donnée donnée :
    Bloc de code
    
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 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 back office
  • Mot de passe d'accès à la base de donnée 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 back office
  • Méthode d'accès à la base de donnée donnée :
    Bloc de code
    
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 portail :
    Bloc de code
    
auth.portal.uidAttribute=false
    Défini le nom de l'attribut définissant l'uid.
  • L'url du serveur cas cas :
    Bloc de code
    
cas.url=https://<host>:<port>/cas
    Défini l'adresse du serveur cas.