lang/en_utf8/help/enrol/imsenterprise/formatoverview.html

   1 <h1>Format overview</h1>
   2 <p>Below is a simple guide to the basic structure of a typical IMS Enterprise
   3 data file. Much more information is available on the <a href="http://www.imsglobal.org/enterprise/">IMS Enterprise official website</a>.</p>
   4
   5 <p>You may like to read the <a href="./enrol/imsenterprise/entv1p1_conformance_summary.html">conformance summary</a> which describes which IMS data elements this plugin can process.</p>
   6
   7
   8 <h1>Basic guide to IMS Enterprise file format</h1>
   9
  10 <p>For any IMS-style enrolment you need a &lt;group&gt; tag which specifies the course, a &lt;person&gt; tag which specifies the user account, and a &lt;membership&gt; tag containing &lt;member&gt; tags which specify a person's role within a given course.</p><p>
  11 </p>
  12
  13 <p>
  14 Remember that the numeric keys used in the Moodle databases are not the interoperable data - a student data system is never going to know in advance that Joe is the 20th user added to the Moodle database - so those aren't the keys exchanged in this type of data.</p><p>
  15 </p>
  16
  17 <p>
  18 Typically a course would have a reference code as well as a name, so let's assume its code is MOODLE101. To define your course you could use</p><p>
  19 </p>
  20
  21 <p>
  22 &nbsp; &lt;group&gt;<br />
  23 &nbsp; &nbsp; &lt;sourcedid&gt;<br />
  24 &nbsp; &nbsp; &nbsp; &lt;source&gt;MyDataSystem&lt;/source&gt;<br />
  25 &nbsp; &nbsp; &nbsp; &lt;id&gt;MOODLE101&lt;/id&gt;<br />
  26 &nbsp; &nbsp; &lt;/sourcedid&gt;<br />
  27 &nbsp; &nbsp; &lt;description&gt;<br />
  28 &nbsp; &nbsp; &nbsp; &lt;short&gt;Moodle 101&lt;/short&gt;<br />
  29 &nbsp; &nbsp; &lt;/description&gt;<br />
  30 &nbsp; &lt;/group&gt;<br />
  31 </p>
  32
  33 <p>
  34 The enrolment script will look for a course with code MOODLE101, and (optionally) create it if it doesn't exist. Similarly for the person - let's assume it's &quot;jmoodle&quot;:</p><p>
  35 </p>
  36
  37 <p>
  38 &nbsp; &lt;person&gt;<br />
  39 &nbsp; &nbsp; &lt;sourcedid&gt;<br />
  40 &nbsp; &nbsp; &nbsp; &lt;source&gt;MyDataSystem&lt;/source&gt;<br />
  41 &nbsp; &nbsp; &nbsp; &lt;id&gt;jmoodle&lt;/id&gt;<br />
  42 &nbsp; &nbsp; &lt;/sourcedid&gt;<br />
  43 &nbsp; &nbsp; &lt;userid&gt;jmoodle&lt;/userid&gt;<br />
  44 &nbsp; &nbsp; &lt;name&gt;<br />
  45 &nbsp; &nbsp; &nbsp; &lt;fn&gt;Joe Moodle&lt;/fn&gt;<br />
  46 &nbsp; &nbsp; &nbsp; &lt;n&gt;<br />
  47 &nbsp; &nbsp; &nbsp; &nbsp; &lt;family&gt;MOODLE&lt;/family&gt;<br />
  48 &nbsp; &nbsp; &nbsp; &nbsp; &lt;given&gt;JOE&lt;/given&gt;<br />
  49 &nbsp; &nbsp; &nbsp; &lt;/n&gt;<br />
  50 &nbsp; &nbsp; &lt;/name&gt;<br />
  51 &nbsp; &lt;/person&gt;<br />
  52 </p>
  53
  54 <p>
  55 If Joe doesn't already have an account, the script can (optionally) create an account for him.</p>
  56
  57
  58 <p>
  59 Let's now look at the membership, adding the person to the course:</p><p>
  60 </p>
  61
  62 <p>
  63 &nbsp; &lt;membership&gt;<br />
  64 &nbsp; &nbsp; &lt;sourcedid&gt;<br />
  65 &nbsp; &nbsp; &nbsp; &lt;source&gt;MyDataSystem&lt;/source&gt;<br />
  66 &nbsp; &nbsp; &nbsp; &lt;id&gt;MOODLE101&lt;/id&gt;<br />
  67 &nbsp; &nbsp; &lt;/sourcedid&gt;<br />
  68 &nbsp; &nbsp; &lt;member&gt;<br />
  69 &nbsp; &nbsp; &nbsp; &lt;sourcedid&gt;<br />
  70 &nbsp; &nbsp; &nbsp; &nbsp; &lt;source&gt;MyDataSystem&lt;/source&gt;<br />
  71 &nbsp; &nbsp; &nbsp; &nbsp; &lt;id&gt;jmoodle&lt;/id&gt;<br />
  72 &nbsp; &nbsp; &nbsp; &lt;/sourcedid&gt;<br />
  73 &nbsp; &nbsp; &nbsp; &lt;role roletype=&quot;01&quot;&gt;<br />
  74 &nbsp; &nbsp; &nbsp; &nbsp; &lt;status&gt;1&lt;/status&gt;<br />
  75 &nbsp; &nbsp; &nbsp; &nbsp; &lt;extension&gt;&lt;cohort&gt;unit 2&lt;/cohort&gt;&lt;/extension&gt;<br />
  76 &nbsp; &nbsp; &nbsp; &lt;/role&gt;<br />
  77 &nbsp; &nbsp; &lt;/member&gt;<br />
  78 &nbsp; &lt;/membership&gt;<br />
  79 </p>
  80
  81 <p>
  82 The IMS Enterprise specification does offer a facility for specifying start/end dates for enrolments, so those can be included using the &lt;timeframe&gt; tag if needed.</p><p>
  83 </p>
  84
  85 <p>
  86 If a person is already added to a group within the course, the script won't actually modify that. If they are not grouped, however, then the specified grouping will be applied.</p><p>
  87