tool:sync:files:cohortbindings

Tool sync: Cohort-to-course binding file format

Introduction

The cohort-to-course binding file lets you add/remove cohort-based enrolment methods to courses.

The file

  • Should preferably be encoded in UTF-8 if the identifiers contain non-ASCII characters, or in ISO 8859-1 if the tool configuration specifies it.
  • Contains fields separated according to the general configuration of the synchronisation tool
  • Has a first line containing the column names, 'cmd' (optional), 'cohort', 'course' and 'role'
  • Contains data lines containing:
Field Value Default
cmd 'add' or 'del' add
cohort(*) mixed -
course(*) mixed -
role(*) mixed -
makegroupmixed 0

(*) mandatory fields (under conditions).

Fields

cmd

A command to run on the cohort/course binding. It can be:

  • add: Adds the cohort binding.
  • del: Removes the cohort binding.

cohort

The cohort identifier, according to the definition in the general settings of the 'cohorts' section of the synchronisation tool.

course

The course identifier, according to the definition in the general settings of the 'cohorts' section of the synchronisation tool.

role

The role identifier, according to the definition in the general settings of the 'cohorts' section of the synchronisation tool.

group

If the value is 1 the group will be created automatically, based on the cohort name.

File examples

Example of a binding file:

 cohort;course;role;group
 COH001;COURSE1;student;1
 COH001T;COURSE1;editingteacher;1
 COH002;COURSE2;student;1
 COH002T;COURSE2;editingteacher;1

Back to the component index - Back to catalogue

tool/sync/files/cohortbindings.txt · Dernière modification : de 127.0.0.1

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki