Tool sync : Format de fichier de création/mise à jour d'utilisateurs

Introduction

Chaque ligne du fichier contient un enregistrement. La première ligne du fichier premier contient le nom des champs qui composent les enregistrements, et détermine ainsi la structure de la suite du fichier.

Format du fichier

Champ	Valeur	Défaut
username(*)	String(variable)	-
firstname (*)	String(10)	-
lastname (*)	String(10)	-
idnumber	String(255)	-
email (*)	String(255)	-
auth	In('manual', 'cas, 'ldap', …)	manual
icq	String(255)	-
maildisplay	0 or 1	1
mailformat	0 (text) or 1 (html)	1
maildigest	0 or 1	0
autosubscribe	0 or 1	0
trackforums	0 or 1	0
phone1	String(32)	-
phone2	String(32)	-
address	String(255)	-
institution	String(255)	-
departement	String(255)	-
city	String(64)	Valeur par défaut du site (*)
country	String(2)	Valeur par défaut du site (**)
lang	String(2)	Valeur par défaut du site (***)
timezone	Code de Timezone (entier)	Valeur par défaut du site (****), 99 pour l'heure locale du serveur
description	String(255)	-
cohort	Nom de la cohorte. String(16).	La cohorte sera créée
cohortid	Identification de cohorte en base de données	La cohorte doit déjà exister avec l'id concerné , à ne pas confondre avec l'ID number, non obligatoire et visible en front des cohortes
cohortidnumber	Numéro d'identification de cohorte	La cohorte doit déjà exister avec l'idnumber concerné
course<n>	Nom court du cours (shortname)
enrol<n>	Plugin d'inscription	-
group<n>	Nom du groupe	Exemple group1
type<n>	OBSOLETE	-
role<n>	Nom court du rôle (ex: student, editingteacher)	-
start<n>	Timestamp Unix	-
end<n>	Timestamp Unix	-
wwwroot<n>	Url du moodle distant si le compte n'est pas local (nécessite VMoodle)	-
password	String (conforme aux règles de sécurité du site)	-

(*) Peut être configuré par le menu Administration du site > Lieu > Réglages Lieu (Localité par défaut)

(**) Peut être configuré par le menu Administration du site > Lieu > Réglages Lieu (Pays par défaut)

(***) Peut être configuré par le menu Administration du site > Langue > Réglages Langue (Langue par défaut)

(****) Peut être configuré par le menu Administration du site > Lieu > Réglages Lieu (Fuseau horaire par défaut). Les codes du fuseaux horaires sont ceux normalisés par l'IANA

Utilisation du fichier de création/mise à jour pour l'inscription et la mise en groupe

La fonction d'import reproduit et complète la version standard de Moodle en permettant simultanément : - de créer/mettre à jour l'utilisateur - de l'inscrire dans un ou plusieurs cours - de l'ajouter à un groupe existant dans ces cours - de lui attribuer un rôle (avec ou sans inscription associée)

Il suffit pour cela d'ajouter au fichier des groupes de colonnes (colonnes indicées du tableau précédent) :

Champ	Valeur
course<n>	Course shortname	Obligatoire dans le groupe de colonnes
group<n>	Group name	Facultatif
type<n>	OBSOLETE	Obsolète, mais toléré
role<n>	Nom court du rôle	Obligatoire, le nom court du rôle (student)
role<n>	Type d'inscription	Facultatif, défaut “sans rôle”
start<n>	Timestamp Unix	Facultatif, défaut à “maintenant”
end<n>	Timestamp Unix	Facultatif, défaut à 0 (sans fin)
wwwroot<n>	Url du moodle distant si le compte n'est pas local (nécessite VMoodle)	Facultatif

Dans l'outil Sync, l'inscription peut être faite sur des cours “distants”, si le composant VMoodle est installé pour piloter les instances Moodle de l'installation.

Champs supplémentaires à effets particuliers

Champ	Valeur	Défaut
deleted	0/1	0
suspended	0/1	0
oldusername	String

'deleted'

Si la colonne “deleted” est présente et est marquée avec des 1, alors l'utilisateur sera supprimé de moodle s'il existe (par la même procédure qu'une suppression administrative).

Le fichier peut être réduit au couple :

<identifiant primaire>;username;firstname;lastname;deleted

'suspended'

Si la colonne “suspended” est présente et est marquée à 1, alors le profil d'utilisateur est marqué suspendu, sans autre modification des données utilisateur.

Le fichier peut être réduit au couple :

<identifiant primaire>;username;firstname;lastname;suspended

'oldusername'

Ce champ est utilisé pour modifier l'identifiant primaire (login) d'un utilisateur. Elle utilise un fichier simplifié avec uniquement deux colonnes :

oldusername;username;firstname;lastname

On s'assurera que l'identifiant primaire est l'identifiant de connexion.

Exemple de fichier

sample_users_en.csv

Retour à l'index du composant - Retour au catalogue