Portlet Esup Lecture – Guide d'installation
Auteur : Bourges Raymond (Université de Rennes 1)
Installation
Installer la portlet
- Télécharger lecture-portlet-<VERSION>.war depuis le site du projet
- Depuis le répertoire contenant ESUP-Portail lancer : ant portlet.deploy -DportletApp=/path/to/war/esup-lecture-portlet.war En tant qu'administrateur de uPortal lancer le portlet manager pour ajouter ESUP-Lecture en tant que nouvelle portlet
 | Il est vraisemblable que uPortal ne soit pas installé dans le répertoire webapps utiliser par défaut par Tomcat. Dans ce cas, il faut aussi penser à modifier le fichier conf/server.xml de Tomcat pour y renseigner le répertoire d'installation de la portlet. |
| Vous pouvez préciser une préférence de portlet avec le nom "context" afin de pouvoir utiliser N instances de cette même portlet avec des configurations différentes. Voir le guide de configuration pour plus d'information sur l'utilisation de cette préférence. |
- Adapter le fichier properties/config.properties
| Paramètre | Description | Version | Exemple |
|---|---|---|---|
| datasource.bean | Valeurs possible : JDBCDataSource ou JNDIDataSource Nom du bean à utiliser suivant que l'on utilise une source JDBC ou JNDI. Si JDBCDataSource alors il faut préciser les paramètres jdbc.connection.* Si JNDI (ce qui est recommandé) alors vous avez besoin de définir votre source de données dans le contexte tomcat utilisé par la portlet. Il faut aussi préciser le paramètre jndi.datasource |
2.0 | JNDIDataSource |
| jpa.database.type | Ce paramètre est utiliser par la couche JPA afin de connaître le type de base de données utilisée |
2.0 |
MYSQL |
| jdbc.connection.driver_class | Driver JDBC |
2.0 |
com.mysql.jdbc.Driver |
| jdbc.connection.url | Url d'accès à la base de données |
2.0 |
jdbc:mysql://localhost/lecturev2 |
| jdbc.connection.username | Utilisateur ayant accès à la base de données | 2.0 |
user1 |
| jdbc.connection.password | Mot de passe de l'utilisateur ayant accès à la base de données | 2.0 |
truc%55 |
| jndi.datasource | Nom de la source JNDI à utiliser |
2.0 |
jdbc/lectureDB |
| smtp.host | Nom du serveur SMTP utilisé pour l'envoi de mails |
2.0 |
smtp.univ-rennes1.fr |
| smtp.port | Port du serveur SMTP | 2.0 |
25 |
| smtp.user | Utilisateur utilisé pour se connecté au serveur SMTP (laisser à vide pour une utilisation en mode anonyme) |
2.0 |
|
| smtp.password | Mot de passe de l'utilisateur utilisé pour se connecté au serveur SMTP | 2.0 |
|
| smtp.fromEmail | Adresse utilisée pour construire le from des mails envoyés au serveur SMTP | 2.0 |
webmaster@univ-rennes1.fr |
| smtp.fromName | Nom utilisée pour construire le from des mails envoyés au serveur SMTP | 2.0 |
Web Master |
| smtp.interceptAll | Les mails doivent-ils être intersectés |
2.0 |
false |
| smtp.interceptEmail | Adresse utilisée pour construire le to des mails intersectés | 2.0 |
webmaster@univ-rennes1.fr |
| smtp.interceptName | Nom utilisée pour construire le to des mails intersectés | 2.0 |
Web Master |
| exceptionHandling.email | Adresse utilisée pour construire le to des mails d'exception |
2.0 |
webmaster@univ-rennes1.fr |
| serverName | Nom du serveur utilisé par CAS doit être de la forme protocol:hostName:port En mode portlet il faut y ajouter le contexte d'exécution de la portlet |
2.0 |
http://uportal.univ-rennes1.fr/lecture-portlet |
| casServerUrlPrefix | Non du serveur CAS Y ajouter le contexte d'exécution de si celui-ci n'est pas exécuté à la racine du serveur |
2.0 |
https://sso-cas.univ-rennes1.fr |
| casService.service | Nom du service, tel que construit par le uPortal pour la portlet, requérant un proxy ticket CAS TODO : Bien comprendre comment uPortal construit cette valeur ! |
2.0 |
http://129.20.129.80:8080/lecture-portlet |
| casService.proxyCallbackUrl | Url utiliser par CAS pour transmettre le proxy ticket à la portlet Il est de la forme : https://hostName:port/contextePortlet/proxy/receptor |
2.0 |
https://uportal.univ-rennes1.fr/lecture-portlet/proxy/receptor |
Ajouter des ressources ESUP-Lecture dans uPortal
ESUP-Lecture utilise au maximum les ressources (styles CSS et scripts javaScript) fournis par le portail. Néanmoins il nécessite l'ajout de quelques fichiers dans l'environnement du portail :
- lecture.css pour les styles CSS
- lectureV2.jpg pour le logo utilisé dans la CSS
- esup-lecture.js pour le javaScript
Ces fichiers peuvent être trouvés dans le fichier war de la portlet. Respectivement :
- /media/lecture.css
- /media/images/lectureV2.jpg
- /media/js/esup-lecture.js
Pour que ces fichiers .css et .js soient pris en compte il faut y faire référence dans le fichier skin.xml de uPortal.
| uPortal contient potentiellement plusieurs skins chacun ayant son propre fichier skin.xml. De plus, uPortal gère un mode standard ("universality") et un mode mobile ("muniversality"). Chacun de ces modes ayant ses propres skins. Il convient donc de modifier tous les fichiers skin.xml correspondant aux différents skins proposés aux utilisateurs du portail. |
Mode opératoire pour le package ESUP-Portail de uPortal
| Les exemples donnés ici concerne le skin uPortal "uportal3" et le mode standard ("universality"). De plus, nous utilisons le répertoire "custom" proposé par le package qui permet de conserver les modifications locales indépendamment des sources livrées avec le package. |
- A la racine du package, créer l'arborescence suivante :
- custom/uPortal/uportal-war/src/main/webapp/media/skins/universality/ avec ses sous répertoires :
- common/javascript/uportal
- uportal3
- custom/uPortal/uportal-war/src/main/webapp/media/skins/universality/ avec ses sous répertoires :
- Déposer le fichier esup-lecture.js dans custom/.../universality/common/javascript/uportal
- Déposer le fichier lecture.css dans custom/.../universality/uportal3
- Copier depuis la racine du package le fichier update/uPortal/uportal-war/src/main/webapp/media/skins/universality/uportal3/skin.xml dans le répertoire custom/.../universality/uportal3
- Editer le fichier custom/.../universality/uportal3/skin.xml pour ajouter en fin de fichier les lignes suivantes
- <css>lecture.css</css>
- <js>../common/javascript/uportal/esup-lecture.js</js>
- Pour que ces modifications soient prises en compte il faut, à la racine du package, lancer la commande suivante :
- ant init deploy
Servlet mode
Le mode servlet est possible mais n'est pas documenté. Il est essentiellement utilisé pour le développement. Pour être parfaitement fonctionnel le mode servlet doit utiliser un Web Service du portail qui expose les groupes. Ce Web Service n'a pas obligatoirement vocation à perdurer avec la montée en puissance de Grouper. Pour autant Grouper n'est pas encore pris en compte dans ESUP-Lecture.
Labels:
None