lang/en_utf8/help/uploadgroups.html

   1 <h1>Upload groups</h1>
   2
   3 <p>This facility allows the batch upload of groups into Moodle.</p>
   4
   5
   6 <ul>
   7   <li>Each line of the file contains one record</li>
   8   <li>Each record is a series of data separated by commas</li>
   9   <li>The first record of the file is special, and contains a list of fieldnames. This defines the format of the rest of the file.
  10     <blockquote>
  11       <p><strong>Required fieldnames:</strong> these fields must be included in the first record, and defined for each user</p>
  12       <p></p>
  13       <code class="example1">groupname</code>
  14       <p><strong>Default fieldnames:</strong> these are optional - if they are not included then the values are taken from the current language and current course</p>
  15       <p><code class="example1">idnumber, coursename, lang</code> </p>
  16       <p><strong>Optional fieldnames: </strong>all of these are completely optional. </p>
  17       <p> <code class="example1">description, enrolmentkey, picture, hidepicture</code></p>
  18     </blockquote>
  19     </li>
  20   <li>Commas within the data should be encoded as &amp;#44 - the script will automatically decode these back to commas. </li>
  21   <li>For Boolean fields, use 0 for false and 1 for true. </li>
  22   <li>Either idnumber or coursename can be used to identify the course. Idnumber overrides coursename. If neither is specified, the groups will be added to the current course. </li>
  23   <li>Coursename is the course shortname.</li>
  24   <li>Note: If a group is already registered in the Moodle database for a particular course, this script will return the
  25       group name for that group. Teachers are only allowed to upload groups in courses they are authorized to edit.</li>
  26 </ul>
  27
  28 <p>Here is an example of a valid import file:</p>
  29 <p><code>groupname,idnumber,lang,description,picture <br />
  30 group1, Phil101, en, this group requires extra attention!, 0 <br />
  31 group2, Math243, , ,
  32 </code></p>
  33