Ceci est une ancienne révision du document !
Table des matières
Tool Sync : Format de fichier de mises à jour des inscriptions (enrolments)
Format du fichier
| Champ | Valeur | Défaut |
|---|---|---|
| cmd | 'add', 'del', 'shift', 'disable', ou 'enable' | Réglage de l'outil |
| rolename(*) | nom court du rôle | - |
| enrol | String | manual |
| cid(*) | id ou nom court, ou le numéro d'identification du cours | - |
| uid(*) | username, id, email, ou idnumber | - |
| starttime | timestamp unix | - |
| endtime | timestamp unix | - |
| gcmd | 'gadd', 'gaddcreate', 'greplace', 'greplacecreate' ou 'gdel' | - |
| g1 à g9 | String | - |
(*) Champs obligatoires
champs
cmd
La commande à exécuter. Si cette colonne est absente, alors la valeur par défaut mémorisée dans l'outil s'applique. Si aucune valeur par défaut n'est configurée, alors la valeur 'add' est utilisée par défaut. La commande peut prendre les valeurs :
- add : Ajoute un role
- del (delete) : Supprime une inscription et le rôle
- shift : Bascule l'utilisateur sur le rôle mentionné en supprimant toutes ses attributions antérieures
- disable : Désactive une inscription (sans en changer ses paramètres)
- enable : Active une inscription existante
rolename
Le nom court du rôle concerné (ex: student, editingteacher, etc.)
enrol
La méthode d'inscription concernée. Si cette colonne est absente du fichier, alors les opérations du fichier ne concerneront QUE les attributions de rôle, sans remettre en question les enregsitrements d'inscription. Si elle est présente, mais que la valeur de cellule est vide, alors la méthode d'inscription considérée par défaut est la méthode manuelle (manual).
cid
L'identifiant de cours. La source d'identifiant dépend de ce qui a été configuré dans le réglage de l'outil.
uid
L'identifiant de l'utilisateur. La source d'identifiant dépend de ce qui a été configuré dans le réglage de l'outil.
starttime / endtime
Les temps de début et de fin d'inscription, exprimés sous forme de timestamp unix. Ces temps de sont pris en compte QUE si la colonne 'enrol' existe.
gcmd
Commande secondaire relative aux groupes. Définit les actions à exécuter sur les groupes de cours lors du traitement de la ligne. Ce traitement peut être :
- gadd : Ajoute l'utilisateur au(x) groupe(s). Si un groupe n'existe pas, ne fait rien pour ce groupe.
- gaddcreate : Idem, mais crée le(s) groupe(s) s'il n'existe(nt) pas.
- greplace : Déplace l'utilisateur dans le(s) groupe(s) en supprimant toutes les affectations antérieures. Ignore les groupes non existants.
- greplacecreate : Idem, mais crée les groupes non existants.
- gdel : Retire l'utilisateur du(des) groupe(s).
g1 à g9
Chaque ligne du fichier de commande peut traiter une opération sur un ensemble de 1 à 9 groupes. Le fichier CSV devra donc comprendre autant de colonnes de groupes que la commande agissant sur le plus grand nombre (par exemple, si une ligne doit modifier 5 groupes, alors le fichier aura 5 colonnes de groupe). Les cellules de groupes inutilisées doivent rester vides.
Fichier minimal
Le fichier minimal comporte 3 colonnes : rolename, uid, cid. Son effet sera d'ajouter un rôle a des inscriptions existantes (ou rôles autres) pour les utilisateurs cités dans les cours cités.