MDL-21695 Migrated enrol_imsenterprise help files into description strings
Originally, the strings were prepared by Helen with _help suffix. But in IMS Enterprise, there is no place for help icons. So the strings are used as descriptions at the setting page and therefore they have _desc suffix now. AMOS BEGIN MOV [usecapitafix_help,enrol_imsenterprise],[usecapitafix_desc,enrol_imsenterprise] HLP enrol/imsenterprise/capita.html,[usecapitafix_desc,enrol_imsenterprise] MOV [createnewcategories_help,enrol_imsenterprise],[createnewcategories_desc,enrol_imsenterprise] HLP enrol/imsenterprise/categorisation.html,[createnewcategories_desc,enrol_imsenterprise] MOV [createnewcourses_help,enrol_imsenterprise],[createnewcourses_desc,enrol_imsenterprise] HLP enrol/imsenterprise/createnewcourses.html,[createnewcourses_desc,enrol_imsenterprise] MOV [createnewusers_help,enrol_imsenterprise],[createnewusers_desc,enrol_imsenterprise] HLP enrol/imsenterprise/createnewusers.html,[createnewusers_desc,enrol_imsenterprise] MOV [deleteusers_help,enrol_imsenterprise],[deleteusers_desc,enrol_imsenterprise] HLP enrol/imsenterprise/deleteusers.html,[deleteusers_desc,enrol_imsenterprise] MOV [sourceddidfallback_help,enrol_imsenterprise],[sourceddidfallback_desc,enrol_imsenterprise] HLP enrol/imsenterprise/sourceddidfallback.html,[sourceddidfallback_desc,enrol_imsenterprise] MOV [restricttarget_help,enrol_imsenterprise],[restricttarget_desc,enrol_imsenterprise] HLP enrol/imsenterprise/target.html,[restricttarget_desc,enrol_imsenterprise] MOV [truncatecoursecodes_help,enrol_imsenterprise],[truncatecoursecodes_desc,enrol_imsenterprise] HLP enrol/imsenterprise/truncatecoursecodes.html,[truncatecoursecodes_desc,enrol_imsenterprise] MOV [allowunenrol_help,enrol_imsenterprise],[allowunenrol_desc,enrol_imsenterprise] HLP enrol/imsenterprise/unenrol.html,[allowunenrol_desc,enrol_imsenterprise] AMOS END
This commit is contained in:
David Mudrak
@@ -26,23 +26,22 @@
|
||||
|
||||
$string['aftersaving...'] = 'Once you have saved your settings, you may wish to';
|
||||
$string['allowunenrol'] = 'Allow the IMS data to <strong>unenrol</strong> students/teachers';
|
||||
$string['allowunenrol_help'] = 'If enabled, course enrolments will be removed when specified in the Enterprise data.';
|
||||
$string['allowunenrol_link'] = 'admin/enrol/imsenterprise';
|
||||
$string['allowunenrol_desc'] = 'If enabled, course enrolments will be removed when specified in the Enterprise data.';
|
||||
$string['basicsettings'] = 'Basic settings';
|
||||
$string['coursesettings'] = 'Course data options';
|
||||
$string['createnewcategories'] = 'Create new (hidden) course categories if not found in Moodle';
|
||||
$string['createnewcategories_help'] = 'If the <org><orgunit> element is present in a course\'s incoming data, its content will be used to specify a category if the course is to be created from scratch. The plugin will NOT re-categorise existing courses.
|
||||
$string['createnewcategories_desc'] = 'If the <org><orgunit> element is present in a course\'s incoming data, its content will be used to specify a category if the course is to be created from scratch. The plugin will NOT re-categorise existing courses.
|
||||
|
||||
If no category exists with the desired name, then a hidden category will be created.';
|
||||
$string['createnewcourses'] = 'Create new (hidden) courses if not found in Moodle';
|
||||
$string['createnewcourses_help'] = 'If enabled, the IMS Enterprise enrolment plugin can create new courses for any it finds in the IMS data but not in Moodle\'s database. Any newly-created courses are initially hidden.';
|
||||
$string['createnewcourses_desc'] = 'If enabled, the IMS Enterprise enrolment plugin can create new courses for any it finds in the IMS data but not in Moodle\'s database. Any newly-created courses are initially hidden.';
|
||||
$string['createnewusers'] = 'Create user accounts for users not yet registered in Moodle';
|
||||
$string['createnewusers_help'] = 'IMS Enterprise enrolment data typically describes a set of users. If enabled, accounts can be created for any users not found in Moodle\'s database.
|
||||
$string['createnewusers_desc'] = 'IMS Enterprise enrolment data typically describes a set of users. If enabled, accounts can be created for any users not found in Moodle\'s database.
|
||||
|
||||
Users are searched for first by their "idnumber", and second by their Moodle username. Passwords are not imported by the IMS Enterprise plugin. The use of an authentication plugin is recommended for authenticating users.';
|
||||
$string['cronfrequency'] = 'Frequency of processing';
|
||||
$string['deleteusers'] = 'Delete user accounts when specified in IMS data';
|
||||
$string['deleteusers_help'] = 'If enabled, IMS Enterprise enrolment data can specify the deletion of user accounts (if the "recstatus" flag is set to 3, which represents deletion of an account). As is standard in Moodle, the user record isn\'t actually deleted from Moodle\'s database, but a flag is set to mark the account as deleted.';
|
||||
$string['deleteusers_desc'] = 'If enabled, IMS Enterprise enrolment data can specify the deletion of user accounts (if the "recstatus" flag is set to 3, which represents deletion of an account). As is standard in Moodle, the user record isn\'t actually deleted from Moodle\'s database, but a flag is set to mark the account as deleted.';
|
||||
$string['pluginname_desc'] = 'This method will repeatedly check for and process a specially-formatted text file in the location that you specify. The file must follow the IMS Enterprise specifications containing person, group, and membership XML elements.';
|
||||
$string['doitnow'] = 'perform an IMS Enterprise import right now';
|
||||
$string['pluginname'] = 'IMS Enterprise file';
|
||||
@@ -59,17 +58,17 @@ $string['miscsettings'] = 'Miscellaneous';
|
||||
$string['processphoto'] = 'Add user photo data to profile';
|
||||
$string['processphotowarning'] = 'Warning: Image processing is likely to add a significant burden to the server. You are recommended not to activate this option if large numbers of students are expected to be processed.';
|
||||
$string['restricttarget'] = 'Only process data if the following target is specified';
|
||||
$string['restricttarget_help'] = 'An IMS Enterprise data file could be intended for multiple "targets" - different LMSes, or different systems within a school/university. It\'s possible to specify in the Enterprise file that the data is intended for one or more named target systems, by naming them in <target> tags contained within the <properties> tag.
|
||||
$string['restricttarget_desc'] = 'An IMS Enterprise data file could be intended for multiple "targets" - different LMSes, or different systems within a school/university. It\'s possible to specify in the Enterprise file that the data is intended for one or more named target systems, by naming them in <target> tags contained within the <properties> tag.
|
||||
|
||||
In general you don\'t need to worry about this. Leave the setting blank and Moodle will always process the data file, no matter whether a target is specified or not. Otherwise, fill in the exact name that will be output inside the <target> tag.';
|
||||
$string['sourcedidfallback'] = 'Use the "sourcedid" for a person\'s userid if the "userid" field is not found';
|
||||
$string['sourcedidfallback_help'] = 'In IMS data, the <sourcedid> field represents the persistent ID code for a person as used in the source system. The <userid> field is a separate field which should contain the ID code used by the user when logging in. In many cases these two codes may be the same - but not always.
|
||||
$string['sourcedidfallback_desc'] = 'In IMS data, the <sourcedid> field represents the persistent ID code for a person as used in the source system. The <userid> field is a separate field which should contain the ID code used by the user when logging in. In many cases these two codes may be the same - but not always.
|
||||
|
||||
Some student information systems fail to output the <userid> field. If this is the case, you should enable this setting to allow for using the <sourcedid> as the Moodle user ID. Otherwise, leave this setting disabled.';
|
||||
$string['truncatecoursecodes'] = 'Truncate course codes to this length';
|
||||
$string['truncatecoursecodes_help'] = 'In some situations you may have course codes which you wish to truncate to a specified length before processing. If so, enter the number of characters in this box. Otherwise, leave the box blank and no truncation will occur.';
|
||||
$string['truncatecoursecodes_desc'] = 'In some situations you may have course codes which you wish to truncate to a specified length before processing. If so, enter the number of characters in this box. Otherwise, leave the box blank and no truncation will occur.';
|
||||
$string['usecapitafix'] = 'Tick this box if using "Capita" (their XML format is slightly wrong)';
|
||||
$string['usecapitafix_help'] = 'The student data system produced by Capita has been found to have one slight error in its XML output. If you are using Capita you should enable this setting - otherwise leave it un-ticked.';
|
||||
$string['usecapitafix_desc'] = 'The student data system produced by Capita has been found to have one slight error in its XML output. If you are using Capita you should enable this setting - otherwise leave it un-ticked.';
|
||||
$string['usersettings'] = 'User data options';
|
||||
$string['zeroisnotruncation'] = '0 indicates no truncation';
|
||||
$string['roles'] = 'Roles';
|
||||
|
||||
@@ -43,15 +43,15 @@ if ($ADMIN->fulltree) {
|
||||
//--- user data options ---------------------------------------------------------------------------------
|
||||
$settings->add(new admin_setting_heading('enrol_imsenterprise_usersettings', get_string('usersettings', 'enrol_imsenterprise'), ''));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewusers', get_string('createnewusers', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewusers', get_string('createnewusers', 'enrol_imsenterprise'), get_string('createnewusers_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imsdeleteusers', get_string('deleteusers', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imsdeleteusers', get_string('deleteusers', 'enrol_imsenterprise'), get_string('deleteusers_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/fixcaseusernames', get_string('fixcaseusernames', 'enrol_imsenterprise'), '', 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/fixcasepersonalnames', get_string('fixcasepersonalnames', 'enrol_imsenterprise'), '', 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imssourcedidfallback', get_string('sourcedidfallback', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imssourcedidfallback', get_string('sourcedidfallback', 'enrol_imsenterprise'), get_string('sourcedidfallback_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$settings->add(new admin_setting_heading('enrol_imsenterprise_usersettings_roles', get_string('roles', 'enrol_imsenterprise'), get_string('imsrolesdescription', 'enrol_imsenterprise')));
|
||||
|
||||
@@ -68,20 +68,20 @@ if ($ADMIN->fulltree) {
|
||||
//--- course data options -------------------------------------------------------------------------------
|
||||
$settings->add(new admin_setting_heading('enrol_imsenterprise_coursesettings', get_string('coursesettings', 'enrol_imsenterprise'), ''));
|
||||
|
||||
$settings->add(new admin_setting_configtext('enrol_imsenterprise/truncatecoursecodes', get_string('truncatecoursecodes', 'enrol_imsenterprise'), '', 0, PARAM_INT, 2));
|
||||
$settings->add(new admin_setting_configtext('enrol_imsenterprise/truncatecoursecodes', get_string('truncatecoursecodes', 'enrol_imsenterprise'), get_string('truncatecoursecodes_desc', 'enrol_imsenterprise'), 0, PARAM_INT, 2));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewcourses', get_string('createnewcourses', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewcourses', get_string('createnewcourses', 'enrol_imsenterprise'), get_string('createnewcourses_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewcategories', get_string('createnewcategories', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/createnewcategories', get_string('createnewcategories', 'enrol_imsenterprise'), get_string('createnewcategories_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imsunenrol', get_string('allowunenrol', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imsunenrol', get_string('allowunenrol', 'enrol_imsenterprise'), get_string('allowunenrol_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
//--- miscellaneous -------------------------------------------------------------------------------------
|
||||
$settings->add(new admin_setting_heading('enrol_imsenterprise_miscsettings', get_string('miscsettings', 'enrol_imsenterprise'), ''));
|
||||
|
||||
$settings->add(new admin_setting_configtext('enrol_imsenterprise/imsrestricttarget', get_string('restricttarget', 'enrol_imsenterprise'), '', ''));
|
||||
$settings->add(new admin_setting_configtext('enrol_imsenterprise/imsrestricttarget', get_string('restricttarget', 'enrol_imsenterprise'), get_string('restricttarget_desc', 'enrol_imsenterprise'), ''));
|
||||
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imscapitafix', get_string('usecapitafix', 'enrol_imsenterprise'), '', 0));
|
||||
$settings->add(new admin_setting_configcheckbox('enrol_imsenterprise/imscapitafix', get_string('usecapitafix', 'enrol_imsenterprise'), get_string('usecapitafix_desc', 'enrol_imsenterprise'), 0));
|
||||
|
||||
$importnowstring = get_string('aftersaving...', 'enrol_imsenterprise').' <a href="../enrol/imsenterprise/importnow.php">'.get_string('doitnow', 'enrol_imsenterprise').'</a>';
|
||||
$settings->add(new admin_setting_heading('enrol_imsenterprise_doitnowmessage', '', $importnowstring));
|
||||
|
||||
@@ -1,2 +0,0 @@
|
||||
<h1>Capita</h1>
|
||||
<p>The student data system produced by Capita has been found to have one slight error in its XML output. If you are using Capita you should activate this option - otherwise leave it un-ticked.</p>
|
||||
@@ -1,7 +0,0 @@
|
||||
<h1>Automatic Categorisation</h1>
|
||||
|
||||
<p>If the <org><orgunit> element is present in a course's incoming data, its content will be used to specify a category if the course is to be created from scratch.</p>
|
||||
|
||||
<p>The plugin will NOT re-categorise existing courses.</p>
|
||||
|
||||
<p>If no category exists with the desired name, then a HIDDEN category will be created.</p>
|
||||
@@ -1,9 +0,0 @@
|
||||
<h1>Automatic creation of new courses</h1>
|
||||
|
||||
<p>The IMS Enterprise enrolment plugin can create new courses for any it finds in the IMS data but not in Moodle's database, if this setting is activated.</p>
|
||||
|
||||
<p>Courses are first queried by their "idnumber" - an alphanumeric field in Moodle's course table, which can specify the code used to identify the course in the Student Information System (for example). If that is not found, the course table is searched for the "short description", which in Moodle is the short course identifier as displayed in the breadcrumbs etc. (In some systems these two fields may well be identical.) Only when that search has failed can the plugin optionally create new courses.</p>
|
||||
|
||||
<p>Any newly-generated courses are HIDDEN when created. This is to prevent the possibility of students wandering into completely empty courses that the teacher may be unaware of.</p>
|
||||
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
<h1>Automatic creation of user accounts</h1>
|
||||
|
||||
<p>IMS Enterprise enrolment data typically describes a set of users. If this setting is turned on, accounts can be created for any users not found in Moodle's database.</p>
|
||||
|
||||
<p>Users are searched for first by their "idnumber", and second by their Moodle username.</p>
|
||||
|
||||
<h1>Passwords</h1>
|
||||
<p>Passwords are not imported by the IMS Enterprise plugin. We recommend using Moodle's authentication plugins to authenticate users.</p>
|
||||
@@ -1,5 +0,0 @@
|
||||
<h1>Automatic deletion of user accounts</h1>
|
||||
|
||||
<p>IMS Enterprise enrolment data can specify the deletion of user accounts (if the "recstatus" flag is set to 3, which represents deletion of an account), if this setting is turned on.</p>
|
||||
|
||||
<p>As is standard in Moodle, the user record isn't actually deleted from Moodle's database, but a flag is set to mark the account as deleted.</p>
|
||||
@@ -1,87 +0,0 @@
|
||||
<h1>Format overview</h1>
|
||||
<p>Below is a simple guide to the basic structure of a typical IMS Enterprise
|
||||
data file. Much more information is available on the <a href="http://www.imsglobal.org/enterprise/">IMS Enterprise official website</a>.</p>
|
||||
|
||||
<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>
|
||||
|
||||
|
||||
<h1>Basic guide to IMS Enterprise file format</h1>
|
||||
|
||||
<p>For any IMS-style enrolment you need a <group> tag which specifies the course, a <person> tag which specifies the user account, and a <membership> tag containing <member> tags which specify a person's role within a given course.</p><p>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<group><br />
|
||||
<sourcedid><br />
|
||||
<source>MyDataSystem</source><br />
|
||||
<id>MOODLE101</id><br />
|
||||
</sourcedid><br />
|
||||
<description><br />
|
||||
<short>Moodle 101</short><br />
|
||||
</description><br />
|
||||
</group><br />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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 "jmoodle":</p><p>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<person><br />
|
||||
<sourcedid><br />
|
||||
<source>MyDataSystem</source><br />
|
||||
<id>jmoodle</id><br />
|
||||
</sourcedid><br />
|
||||
<userid>jmoodle</userid><br />
|
||||
<name><br />
|
||||
<fn>Joe Moodle</fn><br />
|
||||
<n><br />
|
||||
<family>MOODLE</family><br />
|
||||
<given>JOE</given><br />
|
||||
</n><br />
|
||||
</name><br />
|
||||
</person><br />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If Joe doesn't already have an account, the script can (optionally) create an account for him.</p>
|
||||
|
||||
|
||||
<p>
|
||||
Let's now look at the membership, adding the person to the course:</p><p>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<membership><br />
|
||||
<sourcedid><br />
|
||||
<source>MyDataSystem</source><br />
|
||||
<id>MOODLE101</id><br />
|
||||
</sourcedid><br />
|
||||
<member><br />
|
||||
<sourcedid><br />
|
||||
<source>MyDataSystem</source><br />
|
||||
<id>jmoodle</id><br />
|
||||
</sourcedid><br />
|
||||
<role roletype="01"><br />
|
||||
<status>1</status><br />
|
||||
<extension><cohort>unit 2</cohort></extension><br />
|
||||
</role><br />
|
||||
</member><br />
|
||||
</membership><br />
|
||||
</p>
|
||||
|
||||
<p>
|
||||
The IMS Enterprise specification does offer a facility for specifying start/end dates for enrolments, so those can be included using the <timeframe> tag if needed.</p><p>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
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>
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
<h1>Photo's</h1>
|
||||
<p>When creating a new user account based on the Enterprise data, it's possible that a photo is specified for the user - usually by giving a URL to the image file.</p>
|
||||
|
||||
<p>If <photo> data is supplied, then Moodle can attempt to download the image file and turn it into the user-picture displayed within Moodle.</p>
|
||||
|
||||
<p><strong>PLEASE NOTE:</strong> This can add a significant additional burden to the process if there are a lot of user accounts, because of the need to download, modify, and store the images. It is not recommended to activate this option in a context with a very large number of accounts to be created.</p>
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
<h1>SourceID as fallback</h1>
|
||||
<p>In IMS data, the <strong><sourcedid></strong> field represents the persistent ID code
|
||||
for a person as used in the source system. The <strong><userid></strong>
|
||||
field is a separate field which should contain the ID code used by
|
||||
the user when logging in.</p>
|
||||
<p>In many cases these two codes may be the same - but not always.</p>
|
||||
<p>Some student information systems fail to output the <userid> field.
|
||||
If this is the case, you should activate this setting to allow for using the
|
||||
<sourcedid> as the Moodle user ID.</p>
|
||||
<p>Otherwise, leave this setting turned off.</p>
|
||||
@@ -1,5 +0,0 @@
|
||||
<h1>Targets</h1>
|
||||
<p>An IMS Enterprise data file could be intended for multiple "targets" - different LMSes, or different systems within a school/university. It's possible to specify in the Enterprise file that the data is intended for one or more named target systems, by naming them in <target> tags contained within the <properties> tag.</p>
|
||||
|
||||
<p>In many cases you don't need to worry about this. Leave the config setting blank and Moodle will always process the data file, no matter whether a target is specified or not. Otherwise, fill in the exact name that will be output inside the <target> tag.
|
||||
</p>
|
||||
@@ -1,2 +0,0 @@
|
||||
<h1>Truncate course codes</h1>
|
||||
<p>In some situations you may have course codes which you wish to truncate to a specified length before processing. If so, enter the number of characters in this box. Otherwise, leave the box <strong>blank</strong> and no truncation will occur.</p>
|
||||
@@ -1,19 +0,0 @@
|
||||
<h1>Unenrolling students/teachers</h1>
|
||||
|
||||
<p>The Enterprise data can add as well as remove course enrolments - for students and for teachers. If this setting is turned on, then Moodle will carry out unenrolments when specified in the data.</p>
|
||||
|
||||
<p>There are three ways of unenrolling students within the IMS data:</p>
|
||||
|
||||
<ul><li>A <member> element which specifies the given student and course, and with the "recstatus" attribute of the <role> element set to 3 (which means "delete"). THIS IS NOT YET IMPLEMENTED IN THE MOODLE PLUGIN.</li>
|
||||
|
||||
<li> A <member> element which specifies the given student and course, and with the <status> element set to 0 (which means "inactive").</li>
|
||||
</ul>
|
||||
|
||||
<p>The third method is slightly different. It does not require this config setting to be activated, and can be specified well in advance of the unenrolment date:</p>
|
||||
|
||||
<ul>
|
||||
<li>A <member> element which specifies a <timeframe> for the enrolment can specify the begin and/or end dates for enrolment of this particular student. These dates are loaded into Moodle's enrolment data table if present, and so after the end-date, a student will no longer be able to access that particular course.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user