Documents:Description ESCO 1.0.1

Un article de Wiki ESCO-Portail.

Sommaire

Disponibilité du package

Le package esco est disponible ici

Description du package ESCO-Portail

Le package ESCO (esco-2.6-esco-1.0.1) est basé sur la distribution esup-2.6-esup-2.0.3. Il adapte au monde de l'enseignement secondaire, en le complétant, ce qui se fait dans l'enseignement supérieur. La documentation ci-dessous complète la documentation esup disponible à l'adresse http://wiki.esup-portail.org/display/ESUPMU/Documentations .

Organisation

Voici l'organisation de l'arborescence ESCO-Portail une fois décompactée

esco-2.6-esco-1.X.Y
|-- CHANGELOG
|-- contribs
|   |-- [...]
|-- custom
|-- esco-gm
|   |-- [...]
|-- esco-update
|   |-- Tomcat
|   `-- uPortal
|       |-- [...]
|-- packages
|-- resources
|   |-- [...]
|-- update
|   |-- Tomcat
|   |   `--[...]
|   `-- uPortal
|       |-- [...]
|-- ant.bat
|-- ant.sh
|-- map_esco_esup.properties
|-- build.xml
|-- custom.properties
|-- build.sample.properties
`-- config.sample.properties

L'organisation de la partie ESUP est décrite à l'adresse http://wiki.esup-portail.org/display/ESUPMU/01+-+Organisation . Pour ESCO, il a été ajouté les éléments suivants :

  • esco-update : contient tout le différentiel entre esup et esco, par rapport à ce que esup propose. Ce répertoire vient écraser, lorsque c'est nécessaire, ce qui a été déployé par esup.
  • esco-gm : contient tout ce qui concerne le Group Manager de ESCO, autrement dit, ce qui permet d'accéder à ESCO-Grouper depuis le portail.
  • map_esco_esup.properties : pour plus de cohérence, les variables définies dans build.properties et config.properties ont été renommées pour esco. Pour assurer une cohérence et ne pas toucher à la distribution esup, ce fichier a été ajouté pour assurer la correspondance.

Taches ANT

Les tâches ant utilisées sont les mêmes que celles utilisées pour esup : http://wiki.esup-portail.org/pages/viewpage.action?pageId=3932217

Configuration

build.properties

À part celle ajoutées, les variables utilisées sont les mêmes que celles utilisées par esup, à part le fait qu'elles aient été préfixées en esco. (http://wiki.esup-portail.org/display/ESUPMU/01+-+build.properties).
Les variables ajoutées pour les besoins ESCO sont les suivantes :

VariableDescriptionExempleModifiable
esco.deploy.dirRépertoire de déploiement du portail, sous webapps. (Dans le projet esup, ce répertoire est imposé à uPortalesco.deploy.dir=escoOui
esco-gm.baseEmplacement où se trouvent les sources de Esco-GroupManageresco-gm.base=${esco.root}/esco-gmNon
esco-gm.deploy.libEmplacement où seront placées les librairies Esco-GroupManageresco-gm.deploy.lib=${esco.sources}/lib/compile/Non
esco-gm.deploy.propertiesEmplacement où seront placés les fichiers de configuration de Esco-GroupManageresco-gm.deploy.properties=${esco.sources}/properties/Non
esco-gm.deploy.tplibesco-gm.deploy.tplib=trueNon
esco-gm.compile.debugesco-gm.compile.debug=trueNon
esco-gm.compile.deprecationesco-gm.compile.deprecation=trueNon
esco-gm.compile.targetesco-gm.compile.target=1.5Non
esco-gm.compile.sourceesco-gm.compile.source=1.5Non
esco-gm.compile.optimizeesco-gm.compile.optimize=trueNon

config.properties

À part celle ajoutées, les variables utilisées sont les mêmes que celles utilisées par esup, à part le fait qu'elles aient été préfixées en esco. (http://wiki.esup-portail.org/display/ESUPMU/02+-+config.properties).

VariableDescriptionExempleModifiable
esco-gm.ws.useSpécifie si on utilise Esco-GroupManager et les groupes Esco-Grouper. Comme pour CAS, Esco-Grouper doit avoir été installé préalablement.esco-gm.ws.use=trueOui
esco-gm.ws.hostNom du serveur contenant le web service Esco-GroupManageresco-gm.ws.host=grouper.ac.frOui
esco-gm.ws.protoProtocole d'accès au web service Esco-GroupManageresco-gm.ws.proto=httpOui
esco-gm.ws.portPort sur lequel on accède au web service Esco-GroupManageresco-gm.ws.port=:8080Oui
esco-gm.ws.uriURI d'accès au web service Esco-GroupManageresco-gm.ws.uri=/ws4Internet2Grouper/xfireOui
esco-gm.ws.urlComposition de l'URL d'accès au web service Esco-GroupManager avec les éléments ci-dessusesco-gm.ws.url=${esco-gm.ws.proto}://${esco-gm.ws.host}${esco-gm.ws.port}${esco-gm.ws.uri}/IGrouperAPIExposerNon
esco-gm.UI.hostNom du serveur où se trouve Esco-Grouperesco-gm.UI.host=grouper.ac.frOui
esco-gm.UI.protoProtocole d'accès au serveur Esco-Grouperesco-gm.UI.proto=httpOui
esco-gm.UI.portPort utilisé pour accéder au serveur Esco-Grouperesco-gm.UI.port=Oui
esco-gm.UI.uriURI de base du serveur Esco-Grouperesco-gm.UI.uri=/grouperOui
esco-gm.UI.urlURL complète d'accès au serveur Esco-Grouperesco-gm.UI.url=${esco-gm.UI.proto}://${esco-gm.UI.host}${esco-gm.UI.port}${esco-gm.UI.uri}Non
esco-gm.log.fileFichier de logs du web service Esco-GroupManageresco-gm.log.file=${esco.log.dir}/esco-groupManager.logOui
esco-gm.log.levelNiveau de log pour le web service Esco-GroupManager (INFO, DEBUG, WARN, ERROR)esco-gm.log.level=INFOOui

custom.properties

Son utilisation est identique à celle d'Esup : http://wiki.esup-portail.org/display/ESUPMU/03+-+custom.properties .

Installation

La façon d'installer Esco-Portail est similaire la façon d'installer Esup-Portail : http://wiki.esup-portail.org/display/ESUPMU/05+-+Installation , avec cependant les différences suivantes :

  • le nom du package différent ;-)
  • les commandes start-esup.sh et stop-esup.sh ont été renommées start-esco.sh et stop-esco.sh

Conseils d'utilisation

Les conseils d'utilisation sont les mêmes que pour Esup (http://wiki.esup-portail.org/display/ESUPMU/06+-+Conseils+d%27utilisation).
Pour les numéros de version Esco, la norme Esup est suivie, en remplaçant simplement esup par esco.

Personnalisations

La façon de personnaliser Esco-Portail est identique à la façon de personnaliser Esup-Portail : http://wiki.esup-portail.org/display/ESUPMU/07+-+Personnalisations .
L'utilisation des groupes PAGS est possible, même en utilisant Esco-grouper dont une version à venir permettra de générer des groupes dynamiques et donc de se passer des groupes PAGS uPortal.

Particularité des groupes Esco-Grouper

Une fois Esco-Grouper installé et fonctionnel, il convient de rattacher correctement les groupes Esco-Grouper au portail. Pour ce faire il faut :

  • copier le fichier .../esco-update/uPortal/properties/esco-GroupLoad.xml dans .../custom/uPortal/properties
  • modifier ../custom.uPortal/properties/esco-GroupLoad.xml afin de définir les attachements désirés entre les groupes Esco-Grouper et les groupes du portail
  • relancer la tâche ant init
  • relancer la tâche ant deploy
  • relancer le portail
  • Le fichier esco-GroupLoad.xml est de la forme :

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
    <properties>
     
       <comment>
          Properties used to define how the the Grouper groups should be loaded 
          in the native uPortal groups.
       </comment>
     
       <!-- Duration validity, in seconds, for the Grouper requests. -->
       <entry key="grouper.requests.cache.duration">25</entry>
     
       <!-- 
            Defines the grouper groups to load in uPortal groups.
            keys denote a uPortal group name and values are semicolon separated 
            lists of grouper stems. The group loaded are the root groups 
            in the stems.
     
    	For instance, all groups in the stem esco:admin that are not member of another group
            are loaded in the Portal Administrator group:
    	<entry key="Portal Administrators">
    esco:admin</entry>
        -->
    	<entry key="Administrateurs uPortal">esco:admin:central</entry>
    	<entry key="Administrateurs">esco:admin:local</entry>
    	<entry key="Tous les groupes de personnes">esco:Etablissements;esco:Inter-etablissements;esco:admin:esco-lo:lycees-lo;esco:admin:esco-lo:uportal-lo</entry>
    </properties>

    Nous pouvons voir ici qu'il attache :

    • le groupe esco-Grouper esco:admin:central sous le groupe uPortal Administrateurs uPortal
    • le dossier esco-Grouper esco:admin:local sous le groupe uPortal Administrateurs
    • les dossiers esco-Grouper esco:Etablissements et esco:Inter-etablissements sous le groupe uPortal Tous les groupes de personnes
    • les groupes esco(Grouper lycees-lo et uportal-lo sous le groupe uPortal Tous les groupes de personnes. Ces groupes contiennent les gestionnaires de layouts du portail.
pages développeurs
pages "communauté ESCO"