Tool sync : Format de fichier de définition/alimentation de cohortes

Introduction

Le fichier de synchronisation de cohortes est un fichier plat au format CSV encodé en UTF-8 de préférence. La configuration de l'outil permet néanmoins la prise en charge d'un fichier encodé ISO-8859.

Format du fichier

Champ	Valeur	Défaut
cmd	'add' ou 'del'	add
cid(2)	integer	-
cname(1)	String(255)	-
cidnumber(1)	String(255)	-
cdescription	String(255)	-
ccatcontext	String(255)	-
ccatcontextidnumber	String(255)	-
userid	id, IDnumber, email ou username	-

(1) champs obligatoires (sous conditions).

(2) Colonne facultative uniquement pour la commande 'del' et si la source d'identification des cohortes est réglée sur 'id'.

Champs

cmd

Une commande à exécuter sur l'association cohorte/utilisateur. cela peut être :

add : Ajoute l'utilisateur à la cohorte. Crée la cohorte si elle est manquante et si c'est possible.

del : Retire l'utilisateur de la cohorte ou supprime la cohorte si aucun utilisateur n'est mentionné.

free : Retire tous les membres de la cohorte sans la supprimer.

cohortid

L'identifiant de cohorte. La source de l'identifiant dépend du réglage de l'outil.

userid

L'identifiant de l'utilisateur. La source de l'identifiant dépend du réglage de l'outil.

cname (> 2017012200)

Si la cohorte doit être créée par une opération, on doit rajouter cette colonne pour fournir le nom de la cohorte. Si le nom n'est pas fourni, l'id servira de base pour nommer la cohorte.

cdescription

Si la cohorte doit être créée, on peut rajouter cette colonne pour renseigner la cohorte. Une valeur vide n'affectera pas la définition de la cohorte.

idnumber

Si la cohorte doit être créée, on peut rajouter cette colonne pour définir l'identifiant externe. Une valeur vide n'affectera pas la définition de la cohorte.

Exemples de fichier

Exemple de fichier d'ajout de cohortes vides :

cname;cidnumber;cdescription
Cohorte 1;COH001; Première cohorte
Cohorte 2;COH002; Deuxième cohorte
Cohorte 3;COH003; Troisième cohorte
Cohorte 4;COH004; Quatrième cohorte

Exemple de fichier d'ajout d'une cohorte peuplée :

cname;cidnumber;cdescription;userid
# Creation de la cohorte
Cohorte 1;COH001; Première cohorte;user1
# Ajout des membres
Cohorte 1;COH001;;user2
Cohorte 1;COH001;;user3
Cohorte 1;COH001;;user4
Cohorte 1;COH001;;user5

Exemple de fichier de peuplement d'une cohorte existante :

cidnumber;userid
COH001; Première cohorte;user1
COH001;;user2
COH001;;user3
COH001;;user4
COH001;;user5

Exemple de suppression de cohortes (clefs de cohortes réglé sur numéro d'identification) :

cmd;cidnumber
del;COH2;
del;COH4
del;COH12

Fichier de suppression de membres ciblés de cohortes :

cmd;idnumber;userid
del;COH1;user23
del;COH2;user24
del;COH2;user25

Fichier pour vider les cohortes (par numéro d'identification)

cmd;cidnumber
free;COH001
free;COH002
free;COH003
free;COH004

Fichier de suppression combinée de membres et/ou cohortes complètes :

cmd;idnumber;userid
# Suppression de membres
del;COH1;user45
del;COH1;user46
# Suppression de cohorte complète
del;COH32;

Exemple de fichier d'opérations combinées :

cmd;cidnumber;cname;cdescription;userid
# Creation et ajout membre
add;COH54;Classe 2.3;Classe 2ème 3;user1
# Ajout membres (id de base : numéro d'identificaiton
add;COH54;;;user100
add;COH54;;;user101
# Suppression membre
del;COH55;;;user50
# Suppression cohorte
del;COH56;;;
# Creation cohorte
add;COH54;Classe 2.4;Classe 2ème 4;

—-

Retour à l'index du composant - Retour au catalogue