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

mysql -u root -p -e "create database smsuapi"

Un schéma nommé « smsuapi » est maintenant créé

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

-- Ajout du premier super administrateur
INSERT INTO user_bo_smsu VALUES (1, 3, "admin");

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

mysql -u root -p smsuapi "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)

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 :

Lancement de l'application

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

ant start

L'application peut être déployée dans un serveur d'applications existant, voir la documentation du framework esup-commons

Paramétrage du Back Office

Deux fichiers de propriété permettent aux exploitants de paramétrer le Back 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).

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

Voici la liste des paramètres disponibles :

Paramètres lié au broker

Voici la liste des paramètres disponibles :

Paramètres lié à Quartz

Liste des paramètres :

org.quartz.dataSource.myDS.user = root
Défini le login a utiliser pour se connecter à 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

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 :

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

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

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 :