[LON-CAPA-cvs] cvs: loncom /enrollment localenroll.pm

[raeburn]

raeburn		Wed Mar 17 20:02:21 2004 EDT

  Modified files:              
    /loncom/enrollment	localenroll.pm 
  Log:
  Fixed some typos, and updated explanation of activation and expiration dates for student roles.Replaced reference to local authentication as 'local' with correct term: 'localauth'. 
  
  
Index: loncom/enrollment/localenroll.pm
diff -u loncom/enrollment/localenroll.pm:1.7 loncom/enrollment/localenroll.pm:1.8
--- loncom/enrollment/localenroll.pm:1.7	Thu Dec 11 14:01:33 2003
+++ loncom/enrollment/localenroll.pm	Wed Mar 17 20:02:20 2004
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.7 2003/12/11 19:01:33 matthew Exp $
+# $Id: localenroll.pm,v 1.8 2004/03/18 01:02:20 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -50,7 +50,7 @@
 # where DOMAIN = msu  COURSE = 43551dedcd43febmsul1 
 # INSTITUTIONALCODE = fs03nop590001 
 # (MSU's course naming scheme - fs03 = Fall semester 2003, nop =
-# department name, 590 = course number, 001 = section number.
+# department name, 590 = course number, 001 = section number.)
 #
 # fetch_enrollment requires three arguments -
 # $dom - DOMAIN e.g., msu
@@ -105,9 +105,13 @@
 #</students>
 #
 # The <startdate> and the <enddate> are the activation date and expiration date
-# for this student's role. If they are absent, then the date set for
-# first automated enrollment is used as the default activation date, and the
-# date set for last automated enrollment is used as the default expiration date.
+# for this student's role. If they are absent, then neither a start date nor an end
+# date will be set, and the student role will remain active until the role is 
+# explicitly expired using ENRL -> Drop students.    
+# An option to set a default activation date, and a default expiration date will
+# be added to loncreatecourse.pm, and lonpopulate.pm in a future release.
+# Once these default parameters are available, they will be used as the start date and
+# the end date in cases where the <startdate> and <enddate> fields are blank.
 # If dates are to included in the XML file, they should be in the format
 # YYYY:MM:DD:HH:MM:SS (: separators required).
 #
@@ -157,7 +161,7 @@
 # official sections and provides a checkbox to use to
 # select enrollment in the LON-CAPA course from each official section.  
 #
-# get_sections requires one argument - the instituional coursecode
+# get_sections requires one argument - the institutional coursecode
 # (in the MSU case this is a concatenation of semester code, department
 # and course number). 
 # 
@@ -181,7 +185,7 @@
 # lonpopulate.pm to record that fact that a new course section
 # has been added to LON-CAPA that requires access to institutional data
 # At MSU, this is required, as institutional classlists can only made
-# available to faculty who are officially assigned to a course
+# available to faculty who are officially assigned to a course.
 # 
 # The new_course subroutine is used to check that the course owner
 # of the LON-CAPA course is permitted to access the institutional
@@ -236,8 +240,8 @@
 # sub create_password 
 #
 # This is called when the authentication method set for the automated 
-# enrollment process when enrolling new users in the domain is "local".
-# This could be signalled for the specific user by the value of local
+# enrollment process when enrolling new users in the domain is "localauth".
+# This could be signalled for the specific user by the value of localauth
 # for the <authtype> tag from the classlist.xml files, or if this is blank,
 # the default authtype, set by the domain coordinator when creating the course
 # with loncreatecourse.pm.
@@ -252,11 +256,11 @@
 # (b) a flag to indicate whether a password had been created
 # 0 means no password created
 # 1 means password created.  In this case the calling module - Enrollment.pm
-# will send the LON-CAPA username and passwod to the new user's e-mail
+# will send the LON-CAPA username and password to the new user's e-mail
 # (if one was provided), or to the course owner (if one was not provided and
 # the new user was created by the automated process), or to the active
 # course coordinator (if the new user was created using the 'update roster
-# now' interface included in the Automated Enrollment Manager.  
+# now' interface included in the Automated Enrollment Manager).  
 # (c) a flag to indicate that the authentication method is correct - 'ok'.
 # If $authchk is not set to 'ok' then account creation and enrollment of the 
 # new user will not occur.