| Groupe 3F (CMS) |
|
|
| Date de création : | 6 decembre 2004 | |
| Dernière modification : | 8 decembre 2004 | |
| Diffusion : | Esup-Portail | |
Ce document décrit comment installer, configurer et initialiser le canal des signet
Le canal des Signets doit permettre à l'utilisateur du portail de sauvegarder en ligne les liens vers ses sites favoris comme il pourrait les sauvegarder dans les bookmarks, favoris ou encore signets de son navigateur. L'intérêt étant qu'ici les liens seront stockés sur le serveur ESUP et par conséquent accessibles de n'importe quelle machine à travers le portail.
Ce canal vient en remplacement du canal CSignet-1-RC1 dont la documentation est disponible sur https://www.esup-portail.org/consortium/espace/Bureau_2E/CSignet/CSignet.html .
Les sources sont disponibles sur le CVS dans le module CSignet2, le package peut être téléchargé dans l'espace de téléchargement.
Création de la base de données
Le canal des signets n'est pas un canal autonome. Pour fonctionner, il s'appuie sur des modules externes. Avant de l'installer, il est nécessaire de s'assurer que les modules suivants ont déjà été déployés avec succès :
- esup-utils : validé avec la version 1.01
- esup-utils-mag : validé avec la version 2.00-RC1
Ce canal utilise les librairies "commons-beanutils" et "commons-digester", intégrées au package esup.
Préparation du fichier de configuration CSignet2.xml : configurer la connexion à la base de données et divers paramètres spécifiques au canal. Spécifier l'utilisation des icones (vrai ou faux) et la taille maximale des fichiers uploadés.
Préparation du déploiement : modifier les chemins d'installation du fichier build.properties.
Lancement de la commande "ant deploy", pour déployer le canal dans les
bons répertoires.
L'administrateur peut maintenant publier le canal des signets
:
- En utilisant directement le canal de publication.
- En utilisant les fichiers de publication et la commande "ant pubchan" :
Pour l'utiliser vous devez au préalable copier manuellement les fichiers
pubchan_CSignet2.xml dans le répertoire
{uPortal}/properties/chanpub. Il faut spécifier dans ces fichiers à
quel(s) groupe(s) seront rattachés les canaux et quel(s) groupe(s) pourront
se les allouer.
Pour déployer les canaux lancez la commande "ant pubchan -DChannel=pubchan_CSignet2.xml".
La principale fonctionnalité du canal est le stockage de ses liens personnels. Il est donc possible de créer, modifier ou supprimer un signet. L'utilisateur a la possibilité de classifier ses liens comme il classerait des fichiers dans des répertoires. Le canal permet la création, l'imbrication, la modification et la suppression de dossiers. Sachant que la suppression d'un répertoire entraînera la suppression de son contenu. Enfin, il est possible d'ordonnancer et de déplacer les éléments (signets, et répertoires) notamment par copier-coller.
Enfin, l'utilisateur peut importer une liste de signets extraite de son navigateur. Pour cela il doit procéder à l'extraction, choisir le navigateur source dans le canal et procéder au chargement. Il peut de la même façon extraire les signets stockés dans le canal. Il devra choisir le navigateur de destination et télécharger le fichier qu'il pourra importer directement dans son navigateur.
La configuration de ce canal est décrite dans un fichier xml : CSignet2.xml. Une dtd lui est associée : Config.dtd.
Le fichier CSignet2.xml décrit le paramétrage du canal des signet. Il est lu une seule fois au démarrage du portail.
Sa structure générale est la suivante :
| <config> | <!-- Racine --> | ||||||
| <pools> | <!-- Liste des connexions aux bases de données --> | ||||||
| <pool> | <!-- Description d'une connexion --> | ||||||
| <actions> | <!-- Liste des actions des deux canaux --> | ||||||
| <action> | <!-- Description d'une action --> |
||||||
| <useicon> | <!-- Utilisation ou non des icones (vrai ou faux --> | ||||||
| <fileupload> | <!-- Configuration de la taille limite pour les fichiers uploadés --> | ||||||
C'est l'élément racine.
pools
Pour fonctionner le canal des signets a besoin d'une connexion appelée "default". Cette connexion peut être une connexion JDBC standard mais compte tenu du volume de requêtes générées il est fortement recommandé d'utiliser un pool de connexions Tomcat. Le fichier de configuration fourni donne des exemples de configuration pour différents SGBD.
pool
Définit une connexion à une base de données.
-name : nom logique de la connexion. Seule la connexion appelée
"default" sera utilisée.
-type : le type de connexion. Soit "JDBC", soit "JNDI"
pour un pool de connexion Tomcat.
-url : l'URL de connexion pour JDBC, l'identifiant du pool pour JNDI.
-driverClassName : uniquement pour JDBC, la classe du driver JDBC.
-username : uniquement pour JDBC, l'identifiant de connexion à
la base.
-password : uniquement pour JDBC, le mot de passe de connexion.
actions
A cet endroit sont déclarées les actions qui forment les différentes pages du canal. Cette partie ne doit pas être modifiée dans le cadre d'un déploiement. Pour les développeurs, il est possible de modifier le comportement d'une action en développant une nouvelle classe et en remplaçant dans celle-ci dans le fichier de configuration.
action
Une action du canal des signets. Cette partie correspond à la configuration du Framework MAG.
useicon
Le canal des signets utilise des icones pour les diverses actions (modifier, copier, coller, suppirmer etc.). Il est possible de ne pas utiliser ces icones en plaçant ce paramètre à FAUX. Dans ce cas, les liens seront affichés comme des libellés ([Modifier][Copier] etc.)
-value : booléen
<useicon value="vrai" />
fileupload
Il est possible de définir quelle sera la taille maximale des fichiers de signets extraits des navigateurs et chargés dans le canal.
- Important
uPortal gère déjà un mécanisme limitant la taille
des fichiers uploadés mais ce mécanisme est défectueux.
C'est pourquoi il est conseillé d'indiquer dans le fichier {uPortal}/properties/portal.properties
une valeur relativement importante pour la propriété org.jasig.portal.RequestParamWrapper.file_upload_max_size
et d'indiquer ici une valeur inférieure.
-size : la taille limite des fichiers en octets.
La création de la base de données doit se faire 'à la
main' vu que l'on ne souhaite pas utiliser la même que pour le portail.
Dans le répertoire "db" du package se trouve un script de création de la base de donnée MySQL (nécessite le support BDD). Des scripts pour les autres types de SGBD Sont aussi disponibles: HSQL, PostgreSQL
et Oracle. Le driver d'accès n'est pas fourni et doit être placé
dans le répertoire "lib" du portail.
Une fois la base créée, il suffit de renseigner le fichier de
configuration avec les bonnes valeurs.
Lors de la création de la base, certains enregistrements sont placés
par défaut.
| Création : 6 décembre 2004 -Céline BISSLER - UHP | |
| 31 décembre - Céline BISSLER (UHP) : Ajout des scripts pour les bases de données HSQL, PostgreSQL et Oracle. 17 janvier - Céline BISSLER (UHP) : Corrections erreurs. |