Contenu du package

Le package esup-indicateurs est fourni sous la forme d'une archive "tar.gz".

Le fichier README.txt à la racine donne des indications pour l'installation et le paramétrage.

Il se décompose en plusieurs sous dossiers :

• scripts : contient les scripts shell et perl, et les feuilles xsl utilisées lors de la génération de documents html
• conf : contient les fichiers de configuration : types.map, services.map, db.conf 
• lib : contient les librairies extérieurs nécessaires. Pour le moment, juste la librairie java batik, utilisée pour la génération des graphiques
• db : contient les scripts SQL de création de la base des indicateurs, pour mysql et postgree

A la racine, un fichier de stats d'exemple est fourni pour tests : stats.sample.log

Installation du package

Prérequis

Pour la génération des documents html, les modules perl "XML::LibXML" et "SVG::TT::Graph" doivent etre installes.

Pour cela en tant que root, faire :

perl -MCPAN -e 'CPAN::Shell->install(XML::LibXML)'
perl -MCPAN -e 'CPAN::Shell->install(SVG::TT::Graph)'

La librairie libxslt doit également être installée, avec  le binaire xsltproc utilisé pour les transformations xslt.

Pour les accès SGBD le module perl DBD::mysql ou DBD::Pg doit être installé, en fonction du moteur sql utilisé.

Installation

Par exemple, pour la version 1.0.0 du package :

tar -xvzf esup-indicateurs-1.0.0.tar.gz

Ceci crée le répertoire racine de l'installation, esup-indicateurs-1.0.0

Dans le sous-dossier scripts, faire

chmod 755 *sh
chmod 755 *pl

Paramétrage du package

Il s'effectue en affectant des variables d'environnement dans les 2 scripts env.sh et traiteStatsEsup.sh

env.sh

 Il contient des paramètres généraux.

Il est nécessaire de paramétrer au moins les variables suivantes :

• ETABLISSEMENT : contient le nom de l'établissement. Il sera affiché dans les différents états
• CODEETAB : c'est un code propre à l'établissement. Il est utilisé lors de l'alimentation de la base de données (qui est potentiellement multi-etablissements)
• DIR_HOME_INDICATEURS : c'est le chemin d'installation du package

D'autres paramètres permettent de spécifier les répertoires contenant les fichiers de configuration, les fichiers générés ...

traiteStatsEsup.sh

Les paramètres les plus importants sont les suivants :

• JAVA_HOME : nécessaire si génération des documents html
• WITH_DB : mettre à 1 pour enrichir la base de données
• WITH_HTML : mettre à 1 pour générer les fichiers HTML

Prise en main

 Le package est livré avec un petit jeu d'essai, stats.sample.log, et des fichiers de configuration pré-paramétrés avec ce jeu d'essai.

 Pour dérouler le jeu d'essai, le paramétrage minimum à effectuer est :

• Mettre à jour la variable  DIR_HOME_INDICATEURS du fichier env.sh
• Mettre à jour les 3 variables indiquées ci-dessus dans le fichier traiteStatsEsup.sh
• Mettre à jour le fichier db.conf si on désire enrichir la base de données

Editer le fichier stats.sample.log, afin de modifier le mois. Par exemple, si on est en octobre 2008, remplacer les occurences de "2008-08-" par "2008-10-".

 Si on désire alimenter une base de données, il est nécessaire de l'initialiser.

Un script d'exemple est fourni : DBinit.sample.sh. il suffit de l'adapter, et de l'exécuter.

vous pouvez enfin exécuter le script principal :  traiteStatsEsup.sh

Il va créer par défaut dans le répertoire racine du package les répertoires suivants :

• xml : contient les résultats xml
• html : contient les fichiers html générés, et les images associées
• logs : contient des fichiers intermédiaires

Conseils d'installation en production

 Afin de faciliter des mises à jour ultérieures, il est recommandé d'utiliser des répertoires externes à l'arborescence du package pour les fichiers de configuration et les fichiers résultants.

Voici un exemple d'installation qui facilite les mises à jour ultérieures :

On suppose que le répertoire /home/uportal/stats est utilisé pour traiter les statistiques esup-portail.

Le package esup-indicateurs sera déployé dans ce répertoire ; pour la version 1.0.0 il sera donc installé dans  /home/uportal/stats/esup-indicateurs-1.0.0.

On fera un lien symbolique de /home/uportal/stats/esup-indicateurs vers /home/uportal/stats/esup-indicateurs-1.0.0 afin de rendre indépendant les cron de la version actuelle du package.

La variable  DIR_HOME_INDICATEURS sera donc valuée à /home/uportal/stats/esup-indicateurs

On déposera les fichiers de configuration dans  /home/uportal/stats/conf ; les fichiers intermédiaires seront générés dans /home/uportal/stats/logs, les fichiers xml générés dans /home/uportal/stats/xml et les fichiers html dans l'arborescence du serveur web (par exemple, /var/www/html/stats/$ANNEE).

Pour cela, mettre à jour les variables adéquates dans le fichier env.sh

 Les mises à jour ultérieures devraient être facilitées :

• désarchivage du package
• modification du lien symbolique
• recopie de l'ancien fichier env.sh (en controlant qu'il n'y a pas de nouvelles variables)
• ajustement des quelques variables modifiées dans le script traiteStatsEsup.sh