Spécifications de l importation dans Ganesha 4 des fichiers au format CSV et XML

Transcription

1 Spécifications de l importation dans Ganesha 4 des fichiers au format CSV et XML SAS au capital de euros - RCS Paris B Siret : NAF/APE : 804 D

2 Historique des modifications Date Version Description Auteur 26/04/ Ajout du support des fichiers XML M. Ghezal 19/09/ Modification du format du fichier G. Caldeira pour la version 3.2 de Ganesha 17/01/ Modification du format du fichier G. Caldeira pour la version 3.1 de Ganesha 26/07/ Les champs «Login» et G. Duverny «Password» doivent contenir au minimum 5 caractères. 15/03/ Ajout des champs Form_entreprise S. Diep et AccesFonctionsAdminAuteur. 21/09/ Création. G. Duverny Liste de diffusion Nom Anéma Format CSV et XML - 2 -

3 Le format CSV Le format CSV (Comma Separated Value) qui est configuré comme suit a été choisi comme format d importation dans la plate-forme Ganesha. Il concerne uniquement les membres. Champs terminés par ; Champ entourés par " (facultatif) Caractère spécial \ Lignes terminés par \r\n Le format d une ligne d enregistrement TYPE;NOM Aucun champs ne doit contenir de ";". Le fichier doit contenir le nom de chaque champ en première ligne. Les champs TYPE et NOM sont obligatoires et doivent être renseigné. Tous les autres champs sont facultatifs. Il n y a pas d ordre dans les champs. Si un membre existe déjà, lors de sa mise à jour ses infos seront remplacées, mais le groupe associé sera ajouté. Il faut que toutes les lignes d enregistrement contiennent exactement le même nombre de champ que la première ligne. Anéma Format CSV et XML - 3 -

4 Détail du format des champs Champ Type Type N 0 => Stagiaire 1 => Intégrateur 3 => Tuteur 4 => Tuteur Entreprise 5 => Conseiller Nom 100 A Prenom 100 A Login 50 A (il faut au minimum 5 A) Password 50 A (il faut au minimum 5 A) Si les Passwords sont cryptés, n oubliez pas de le précisez lors de l insertion A NomSociete 50 A NomGroupe 100 A Plusieurs groupes peuvent être renseigné en étant séparés par le caractère. Adresse 250 A CP 15 A Ville 100 A ModeAcces N 0 => bloqué 1 => période (cf. DateDébutAccès + DateFinAccès) 2 => illimité DateDebutAcces 20 A si ModeAccès = 1 de la forme xx/xx/xxxx DateFinAcces 20 A si ModeAccès = 1 de la forme xx/xx/xxxx AccesBAR N 0 => non 1 => oui Form_entreprise N 0 => non 1 => oui Role N Si TYPE = 0 : 0 => Apprenant 1 => Demandeur Si TYPE = 3 : 0 => Formateur 1 => Responsable de formation 2 => Intégrateur 3 => Responsable de formation et Intégrateur 4 => Conseiller 5 => Responsable de formation et Conseiller 6 => Intégrateur et Conseiller 7 => Responsable de formation et Intégrateur et Conseiller AccesFileManager N 0 => Bloqué 1 => Autorisé en lecture 2 => Autorisé en modification A : correspond à un caractère ASCII. N : correspond à un nombre entier. Anéma Format CSV et XML - 4 -

5 Exemple Type;Prenom;Nom;Login;Password; ;NomSociete;NomGroupe;Adresse;CP; Ville;ModeAcces;DateDebutAcces;DateFinAcces;AccesBAR;Form_entreprise; Role;AccesFileManager;Type 1 GROUPE 2 GROUPE 5;4 place Jussieu;75252;PARIS;1;23/09/2004; 29/09/2005;1;0;0;0;0 Anéma Format CSV et XML - 5 -

6 Le format XML Le format XML (extensible Markup Language) a été ajouté comme format d importation dans la plate-forme Ganesha en plus du format CSV. Il concerne uniquement les membres. Le fichier devrait être encodé en UTF-8 même si la plateforme gère l encodage à la vollée. De la même manière les balises devraient être en minuscule même si la plateforme gère une remise à la casse de toutes les balises avant d analyser le fichier. Quelques rappels propres au format XML : Le prologue XML est obligatoire et doit préciser l encodage ainsi que la version. Le fichier XML ne doit contenir qu un seul élément racine, dans l exemple suivant c est l élément ganesha. Chaque balise ouverte doit être refermée sans aucun chevauchement. Informations sur le format XML : La structure de notre document XML est définie comme suit. Le format d un enregistrement dans un fichier XML <?xml version="1.0" encoding="utf-8"?> <ganesha> <user> <type>contenu</type> <nom>contenu</nom> <prenom>contenu</prenom> <login>contenu</login> <password>contenu</password> < >contenu</ > <nomsociete>contenu</nomsociete> <nomgroupe>contenu</nomgroupe> <adresse>contenu</adresse> <cp>contenu</cp> <ville>contenu</ville> <modeacces>contenu</modeacces> <datedebutacces>contenu</datedebutacces> <datefinacces>contenu</datefinacces> <accesbar>contenu</accesbar> <form_entreprise>contenu</form_entreprise> <role>contenu</role> <accesfilemanager>contenu</accesfilemanager> </user> </ganesha> Anéma Format CSV et XML - 6 -

7 Explication La racine de notre document XML est représenter par la balise <ganesha>, chaque membre est ensuite encapsulé dans un élément user dans lequel un certain nombre d éléments définissent le membre. Pour définir un membre il y a un certain nombre d informations obligatoires et d autres facultatives qui sont les mêmes que pour le format CSV. Contrairement au format CSV, dans le fichier XML, chaque utilisateur n a pas obligatoirement le même nombre d informations facultatives. La valeur des balises doit respecter le même format que pour les champs du fichier CSV (cf. page 4). Tout comme pour les fichiers CSV, si un membre existe déjà, lors de sa mise à jour ses infos seront remplacées, et le groupe associé sera ajouté. Détail du format du contenu des balises Le contenu des balises suit les mêmes règles que celles du fichier CSV avec quelques limitations supplémentaires propre au format XML : Les caractères & doivent être remplacer par l entité & Les caractères < doivent être remplacé par l entité &lt ; Les caractères > doivent être remplacé par l entité &gt ; Il est conseillé de remplacer les caractères " par l entité " Il est conseillé de remplacer les caractères par l entité &#39; Anéma Format CSV et XML - 7 -

8 Exemple <?xml version="1.0" encoding="utf-8"?> <ganesha> <user> <type>0</type> <nom>durand</nom> <prenom>pierre</prenom> <login>pdurand</login> <password>durandp</password> <nomsociete>societe</nomsociete> <nomgroupe>r&d</nomgroupe> <adresse>12 bd Voltaire</adresse> <cp>75012</cp> <ville>paris</ville> <modeacces>1</modeacces> <datedebutacces>22/03/2007</datedebutacces> <datefinacces>01/08/2007</datefinacces> <accesbar>0</accesbar> <form_entreprise>0</form_entreprise> <role>0</role> <accesfilemanager>0</accesfilemanager> </user> <user> <type>0</type> <nom>dupont</nom> </user> <user> <type>0</type> <nom>vincent</nom> <nomsociete>sas</nomsociete> <modeacces>0</modeacces> </user> </ganesha> Le fichier XML suivant importe : Un membre dont les informations sont complètes, on notera l emploi de l entité & pour le nom de sont groupe. Un utilisateur avec un minimum d information Un utilisateur avec des informations semi-complète et dont le compte est bloqué. Anéma Format CSV et XML - 8 -