Canal MonDossierWeb
Installation

1. Pré-requis
2. Installation
  2.1. Configuration du canal
    2.1.1. Pool de connexion
    2.1.2. Actions
    2.1.3. Adresse mail des étudiants
    2.1.4. Lien "Nous contacter"
    2.1.5. Rappel de l'identité de l'étudiant
    2.1.6. Messages
    2.1.7. Autres options de configuration
  2.2. Installation des plug-ins
  2.3. Déploiement du Canal
    2.3.1. Publication du canal

# 1. Pré-requis

Le canal a été testée sur Apogée 3.40 avec une base Oracle 9i. Il ne fonctionne pas sur une base Oracle 8i.

Pour qu'il fonctionne correctement, il est nécessaire d'avoir installé au préalable :

- Le package connecteur Apogée

- Le package esup-utils-mag

- Le canal MailTo (utilisé en servant ; optionnel : voir la partie Configuration)

- Le driver oracle 9i (pour Apogée 3.40) nommé ojdbc14.jar qui remplace le précédent classes12.jar. Oracle 9i est indispensable au bon fonctionnement du canal.

# 2. Installation

L'installation du canal MonDossierWeb repose sur les actions suivantes:

- Configuration du canal

- Installation éventuelle des plugins

- Déploiement du canal

## 2.1. Configuration du canal

La configuration générale du canal se fait via le fichier properties/CMonDossierWeb.xml Seuls les points abordés ci-dessous sont paramètrables.

### 2.1.1. Pool de connexion

Il fait référence au pool de connexion vers Apogée. Ce pool doit conserver comme nom "default" (name="default") . Si vous conservez JNDI comme valeur pour l'attribut type, il faut que l'attribut url match le pool de connexion Tomcat.

Exemple :

Dans le fichier de configuration du canal :

    <pool name="default" type="JNDI" url="Apogee" />

Dans le fichier server.xml de Tomcat :

    <Resource name="jdbc/Apogee" auth="Container" type="javax.sql.DataSource"
        username="..." password="..."
        driverClassName="oracle.jdbc.driver.OracleDriver" url="jdbc:oracle:thin:@<serveur>:<port>:<base>"
        maxActive="100" maxIdle="30" maxWait="10000"/>

Pour plus de détails sur la configuration du pool, voir le mdule database du package esup-utils-mag.

### 2.1.2. Actions

La définition des actions ne doit pas être modifiée.

Cependant, il est possible pour l'action etat_civil de décommenter un paramètre option dont la liste des valeurs spécifie les options d’affichage activées : prénom2 et/ou prénom3 et/ou nom d’usage.

    <param name="option">
       <value>prenom2</value>
       <value>prenom3</value>
       <value>nom_usage</value>
    </param>

Ces options d'affichage sont alors visibles dans l'onglet Etat-civil ainsi que dans le rappel de l'identité de l'étudiant, disponible sur les autres pages.

Pour n'utiliser par exemple que le nom d'usage, il convient de mettre en commentaire, laisser vide ou supprimer les balises <value> correspondant aux autres options. Attention, la dtd exige au moins une sous-balise <value> : il faut donc mettre en commentaire le bloc <param> pour n'utiliser aucune des options d'affichage.

Par défaut, les options d'affichage sont désactivées.

### 2.1.3. Adresse mail des étudiants

La balise studentMail permet de spécifier la classe implémentant la méthode de récupération des adresses mail des étudiants (sous balise classMail) ainsi que l'extension utilisée pour générer l'adresse à partir du login (sous balise extMail). Mettre en commentaire le bloc <studentMail></studentMail> pour ne pas utiliser cette fonctionnalite.

    <studentMail>
     <classMail>StudentMail</classMail>
     <extMail>@etudiant.univ.fr</extMail>
    </studentMail>

Note

Ne pas mettre en commentaire ce bloc si l'action sendMail est activée.

Pour personnaliser la récupération des adresses mail, il faut définir sa propre classe StudentMail qui implémente l'interface IMail et indiquer son nom dans le fichier de configuration du canal (balise <classMail>).

### 2.1.4. Lien "Nous contacter"

Il est possible d'afficher sur toutes les pages du canal un lien "Nous contacter" permettant aux étudiants de poser des questions à la Scolarité.

Si l'action sendMail est activée, le canal CMailTo sera utilisé. Dans le cas contraire, le lien sera de la forme mailTo:....

    <lienContact value="scolarite@univ.fr" />

Pour ne pas utiliser cette fonctionnalité, mettre en commentaire la balise.

### 2.1.5. Rappel de l'identité de l'étudiant

Il es possible de rappeler sur chacune des pages du canal un rappel de l'étudiant connecté. Cette fonctionnalité peut-être utile en cas d'impression.

    <rappelIdentite value="true"/>

Pour ne pas utiliser cette fonctionnalité, mettre à false.

Note

Pour ne pas utiliser le canal MailTo pour l'envoi des mails lors des clics sur les adresses électroniques des étudiants, mettre en commentaire la balise <action name="sendMail" ..../>. Dans ce cas, les liens sur les adressses mail seront du type mailto:...

### 2.1.6. Messages

#### 2.1.6.1. Message affiché si l'utilisateur n'a pas le droit de consulter le canal

Le message affiché à l'utilisateur est paramètrable via la balise msgInterdit.

#### 2.1.6.2. Message affiché si la base de données n'est pas disponible

Le message affiché à l'utilisateur est paramètrable via la balise msgErreurBD.

### 2.1.7. Autres options de configuration

Cette partie permet de rajouter des options de configuration non obligatoires ou propre à un établissement.

De base, seule l'édition pdf des notes est proposée dans cette section. Cette option est désactivée par défaut.

Note

Si vous désirez utiliser l'édition pdf des notes, il faut déployer les jar fop-0.20.5.jar et avalon-framework-4.2.0.jar disponibles dans le répertoire lib du canal

## 2.2. Installation des plug-ins

Nancy 2 et Rennes 1 n'extrayant pas les données provenant d'APOGEE de la même façon, il existe donc la possibilité d'installer des plug-ins d'après votre méthode d'extraction des données.

Les sources des plug-ins se situent dans le répertoire plugin présent à la racine du package. Ils ne sont pas deployés en même temps que le canal.

Pour les utiliser, il faut décommenter les lignes correspondantes dans le fichier de configuration CMonDossierWeb.xml qui se trouve dans le répertoire properties et mettre en commentaire les actions dont vous ne vous servez pas.

Décommenter aussi dans le fichier CMonDossierWeb.ssl qui se trouve dans webpages/stylesheets/org/esupportail/portal/channels/gestion/CMonDossierWeb/ les lignes correspondant aux plug-ins.

Voir aussi le fichier Liens.xsl pour s'assurer des liens qui seront présent à l'affichage du canal et le fichier default.xsl pour décommenter la déscription du plugin Résultat.

Faire ensuite un ant deploy pour déployer les modifications de configurations ayant trait aux plug-ins.

Pour les déployer, il faut lancer la commande :

- ant plugCalRent pour déployer le plugin calendrier de rentrée

- ant plugCalExam pour déployer le plugin de calendrier d'examens

- ant plugResultats pour déployer le plugin d'affichage des résultats de l'année en cours

## 2.3. Déploiement du Canal

Préparation du déploiement : modifier le fichier build.properties en fonction de la version de portail que vous utilisez (en prenant modèle sur le fichier build.sample.properties).

Lancez la commande suivante relative au fichier build.xml contenu dans le package:

    ant deploy

Il ne reste plus qu'à l'administrateur du portail de publier le canal.

### 2.3.1. Publication du canal

La publication du canal se fait en saisissant le nom de classe suivant:

- org.esupportail.portal.channels.gestion.CMonDossierWeb.CMonDossierWeb