===== Group and grouping synchronisation file =====
===== Synchronisation by CSV file =====

==== Group creation file format ==== 

^    Field	^Value ^ Default ^
|   courseid(*) | primary identifier of the course | |
|   name(*)	| group name | - |
|   idnumber    | String | - |
|   groupid	| group id (in case of modification)<sup>1</sup> | - | 
|   selfgrouping | 0 or 1 | If 1, creates a grouping with the same name as the group |
|   grouping	| int | Grouping Id |
|   description	| String | - |

  * (*) Mandatory fields
  * (1) According to the tool setting. If the group identifier is not qualified enough, then the ''courseid'' value is combined with it. The ''groupid'' column is only to be used when renaming groups. This identifier takes precedence over the mandatory ''courseid''/''name'' combination.

==== Group population file format ==== 

^    Field	^ Value ^ Default ^
|   groupid(*) | primary identifier of the course<sup>1</sup> | |
|   userid(*)	| user identifier<sup>2</sup> | - |
|   courseid    | Course identifier (according to the general setting of the course tool<sup>3</sup> | - |
|   cmd	| 'add', 'shift', 'del' | 'add' | 

  * (*) Mandatory fields
  * (1) According to the tool setting
  * (2) According to the tool setting
  * (3) This column is needed when the primary identifier of the group is its name, because the name is not a fully qualified identifier. Several groups can have the same local name across different courses.

[[:tool:sync|Back to the component index]]