Groupe 1A (socle)
Date de création :	26 novembre 2004
Dernière modification :	08 fevrier 2005
Diffusion :	internet

Utilitaire chargement de groupe

Ce document décrit comment utiliser l'utilitaire de chargement de groupe développé par Esup-Portail.

Cette utilitaire est inclus dans les packages esup, (consulter le CHANGELOG du package afin de savoir si il est disponible dans votre version)

Principe

Cet utilitaire a pour but d'agir sur les groupes de uPortal via une tache ant. Il dispose des méthodes suivantes :

• Ajouter d'un groupe
• Supprimer un groupe
• Renommer un groupe
• Attacher un groupe dans un autre
• Supprimer l'attachement d'un groupe dans un autre
• Ajouter un membre (personne) dans un groupe
• Supprimer un membre (personne) d'un groupe

Utilisation

Cette utilitaire se base sur un fichier XML permettant de définir les actions a effectuer.

Par défaut, le fichier utilisé est properties/groups/GroupLoad.xml

Il supporte le paramètre dataFile, qui permet d'utiliser un autre fichier de configuration.

Exemple :

ant esup.groups.load -DdataFile=/properties/groups/esupGroupLoad.xml

Vous disposez aussi de deux fichiers exemples :

• /properties/groups/esupGroupLoad.xml
• /properties/groups/GroupLoadSample.xml
  

Fichier de configuration

Exemple :

<?xml version="1.0" encoding="UTF-8"?>
<Group-Loading failonerror="false" duplicategroup="false">
	<!-- BE CAREFUL BEFORE RUN SWITCH JNDI TO OFF in portal.properties and    PersonDirs.xml -->
   
  	<groupAdd name="Groupe test" description="Groupe test"/>
    <groupAdd name="Groupe test duplique" description="Groupe test duplique" duplicate="true"/>
    <groupAdd name="Groupe de canaux" description="Groupe test de canaux" type="channel"/>
    
	<groupDel key="local.104"/> 
 	<groupDel name="uPortal"/> 
 
	<groupRename name="Outils" newName="Outils renome"/>
 	<groupRename key="local.105" newName="Informatiques"/>
 	<groupRename name="Outils renome" newDesc="Une autre description"/>
 
	<attachAdd name="Groupe test" parentName="Information"/>
 	<attachAdd key="pags.campus" parentName="Etudiants"/>
	<attachAdd name="Outils renome" parentKey="local.120"/>

	<attachDel name="Groupe test" parentName="Information"/>
 	<attachDel key="pags.campus" parentName="Etudiants"/>
 	<attachDel name="Outils renome" parentKey="local.120"/>
 
	<memberAdd uid="admin" parentName="Groupe test"/> 
 	<memberAdd uid="admin" parentKey="Groupe test"/> 
 	
	<memberDel uid="admin" parentName="Groupe test"/> 
 	<memberDel uid="admin" parentKey="Groupe test"/> 
</Group-Loading>

Ce fichier est un exemple, en aucun cas ce fichier ne marchera.

Le fichier est traité de haut en bas.

Les groupes peuvent être décrits par leur nom ou par leur clé.

failonerror

Ce flag vous permet de spécifier le comportement de l'utilitaire :

• true : s'arrête sur la 1ère erreur et ne traite pas le reste du fichier
• false : traite tout le fichier en affichant les erreurs

duplicategroup

Ce flag vous permet de spécifier si vous authorisé la création de groupe ayant le même nom:

• true : autorise la création de groupe ayant le même nom
• false : interdit la création de groupe ayant le même nom

Ajout d'un groupe (groupAdd)

Attributs :

• name : nom du groupe
• description : description du groupe
• type : type du groupe par défaut groupe de personne, pour faire un groupe de canaux : type="channel"
• duplicate : si "duplicategroup" est à false (on interdit la création de groupe de même nom), ce flag permet de surpasser la directive général, il autorise donc la duplication uniquement pour un groupe.

Suppression de groupe (groupDel)

Attributs :

• [ name | key ] : nom du groupe ou indetifiant du groupe (local.120)

Renommer un groupe (groupRename)

Attributs :

• [ name | key ] : nom du groupe ou indetifiant du groupe (local.120)
• newName : nouveau nom
• newDesc : nouvelle description

Vous devez spécifier le newName ou la newDesc (ou les deux).

Attacher un groupe dans un autre (attachAdd) ou

Attributs :

• [ name | key ] : nom du groupe enfant ou indetifiant du groupe enfant (local.120)
• [ parentName | parentKey ] : nom du groupe parent ou indetifiant du groupe parent (local.120)

ATTENTION : le groupe enfant doit être de même type que le groupe parent (person <=> person ou channel <=> channel)

ATTENTION : cette utilitaire interdit d'attacher un groupe si il existe déjà un groupe ayant le même nom dans le parent.

Supprimer l'attachement d'un groupe dans un autre (attachDel)

idem attachAdd

Ajouter un membre (personne) dans un groupe (memberAdd)

Attributs :

• uid : indetifiant de la personne
• [ parentName | parentKey ]: nom du groupe parent ou indetifiant du groupe parent (local.120)

ATTENTION : pour l'instant cette méthode peut uniquement attacher des personnes (pas de channels)

Supprimer un membre (personne) d'un groupe (memberDel)

idem memberAdd

Création :26 novembre 2004 - Julien Marchal
Modifications : 08 février 2005 : Julien Marchal : ajout duplicategroup, duplicate