loncom/enrollment/localenroll.pm - diff

Return to localenroll.pm CVS log

Up to [LON-CAPA] / loncom / enrollment

Diff for /loncom/enrollment/localenroll.pm between versions 1.52 and 1.59

-version 1.52, 2015/05/30 18:01:12
+version 1.59, 2018/06/14 04:11:49
  Line 39  described at http://www.lon-capa.org.
  =head1 NOTABLE SUBROUTINES
- =over
  =cut
  package localenroll;
- Line 48  package localenroll;
+ Line 46  package localenroll;
  use strict;
  =pod
+ =over
  =item run()
   set this to return 1 if you want the auto enrollment to run
  Line 258  sub get_sections {
   username:domain
   (c) the LON-CAPA domain that contains the course
-  new_course also takes a fourth (optional) argument -
+  new_course also takes optional fourth and fifth arguments -
   (d) the course co-owners, as a comma-separated list of username:domain for
   any co-owners.
+  (e) database handle (might be set when new_course() is called by check_section
+  routine within localenroll.pm).
  =cut
- Line 347  automatically, or held in a queue pendin
+ Line 349  automatically, or held in a queue pendin
  the institution.
  Course requests will trigger this check if the process type has been set
- to 'validate' for the course type (official, unofficial or community) and
+ to 'validate' for the course type (official, unofficial, textbook,
- the requestor's affiliation.  Whether "validate" is an available option
+ placement or community) and the requestor's affiliation.  Whether
- in the Domain Configuration menu is controlled by auto_courserequest_checks().
+ "validate" is an available option in the Domain Configuration menu
+ is controlled by auto_courserequest_checks().
  One scenario is where the request is for an official course, in which case
  a check could be made that the requestor is listed as instructor of
  record for the course in the institution's course schedule/database.
- Line 361  given the data passed in to the routine.
+ Line 364  given the data passed in to the routine.
  validate_crsreq takes seven arguments -
   (a) the LON-CAPA domain that will contain the course.
   (b) the username:domain for the course owner.
-  (c) the course type (official, unofficial or community)
+  (c) the course type (official, unofficial,textbook, placement or community)
   (d) a comma-separated list of institutional affiliations of
       the course owner.
   (e) the institutional code (in the MSU case this is a concatenation of
- Line 408  This is used to determine whether the "v
+ Line 411  This is used to determine whether the "v
  possible choices for course request processing in the Domain Configuration
  menu for Course Requests. Ultimately it is called by domainprefs.pm (via:
  lonnet -> lond -> localenroll.pm) The domain configuration menu includes
- a table where columns are course type (official, unofficial or community)
+ a table where columns are course type (official, unofficial, textbook,
- and rows are institutional affiliations (e.g., Faculty, Staff, Student etc.).
+ placement or community) and rows are institutional affiliations
+ (e.g., Faculty, Staff, Student etc.).
  crsreq_checks() takes three arguments: $dom, $reqtypes, $validations.
  $dom - the domain for which validation options are needed.
- Line 540  sub crsreq_updates {
+ Line 544  sub crsreq_updates {
  =pod
+ =item export_grades()
+ This routine can be customized to push grade information to some other gradebook,
+ LCMS, or administrative system external to LON-CAPA.
+ export_grades() takes five arguments -
+ (a) the LON-CAPA course ID
+ (b) the LON-CAPA course domain
+ (c) a hash reference containing the following:
+     scope    => scope of the grades (e.g., course, map or resource).
+     instcode => institutional course code (if an official course)
+     crstype  => course type -- Course, Community or Placement
+     context  => calling context, e.g., "completion" when a student completes a placement test.
+ (d) a perl data structure (hash of a hash) containing the grade data.
+     in the outer hash, the keys are student's username:domain
+     in the inner hash, keys are:
+     id        => student/employee ID
+     lastname  => student's last name
+     firstname => student's first name
+     email     => student's "permannent" e-mail address
+     section   => student's LON-CAPA course section
+     total     => total points earned
+     bytitle   => reference to a hash (keys are question titles, values are points
+     bysymb    => reference to a hash (keys are symbs, i.e., unique resource identifiers).
+ (e) reference to a hash which will contain information to return.
+     keys will be the student's username:domain. Value of 1 to show grades pushed
+     successfully.
+ =cut
+ sub export_grades {
+     my ($cnum,$cdom,$hashref,$dataref,$outgoing) = @_;
+     my %info;
+     if (ref($hashref) eq 'HASH') {
+         %info = %{$hashref};
+     }
+     if ((ref($dataref) eq 'HASH') && (ref($outgoing) eq 'HASH')) {
+         foreach my $key (keys(%{$dataref})) {
+             $outgoing->{$key} = 1;
+         }
+         return 'ok';
+     } else {
+         return 'error';
+     }
+ }
+ =pod
+ =item check_instclasses()
+  This is used to supply information about which instituional course sections
+  and cross-listings are available to supply enrollment data, given the current
+  list of owner and co-owners. The data are used to populate the column titled:
+  "Auto-enrollment of registered students" when showing full detailed for a course
+  in the course catalog.
+  This subroutine takes four arguments -
+  (a) $owners - comma-separated list of username:domain for course owner
+      and co-owners.
+  (b) $dom - domain of course.
+  (c) $classes - reference to hash of institutional course sections and
+      crosslistings for which access to enrollment data is being checked.
+  (d) $validated - reference to hash which will be populated with all
+      keys from incoming $classes hashref, for which one or more of the
+      owner/co-owners has rights to access enrollment data. For each
+      key included in $validated hashref, corresponding value will be set to 1.
+  The subroutine returns 'ok' if there is no processing error.
+ =cut
+ sub check_instclasses {
+     my ($owners,$dom,$classes,$validated) = @_;
+     if ((ref($classes) eq 'HASH') && (ref($validated) eq 'HASH')) {
+         foreach my $class (keys(%{$classes})){
+             if (&check_section($class,$owners,$dom) eq 'ok') {
+                 $validated->{$class} = 1;
+             }
+         }
+     }
+     return 'ok';
+ }
+ =pod
  =item create_password()
   This is called when the authentication method set for the automated
- Line 905  sub allusers_info {
+ Line 997  sub allusers_info {
                institutional types to check.
   (g) $srchby - optional if $uname or $id defined, otherwise required.
                 Allowed values include: 1. lastfirst, 2. last, 3. uname
-                corresponding to searches by 1. lastname,firstname;
+. email, corresponding to searches by 1. lastname,firstname;
-. lastname; 3. username
+. lastname; 3. username; 4. e-mail address
   (h) $srchterm - optional if $uname or $id defined, otherwise required
                  String to search for.
   (i) $srchtype - optional. Allowed values: contains, begins (defaults
- Line 935  sub get_userinfo {
+ Line 1027  sub get_userinfo {
      return $outcome;
  }
+ =pod
+ =item get_multusersinfo
+  (a) $dom - domain
+  (b) $type - username or id
+  (c) $unamenames - reference to hash containing usernames of users
+  (d) $instusers - reference to hash which will contain info for user
+                  as key = value; keys will be one or all of:
+                  lastname,firstname,middlename,generation,id,inststatus -
+                  institutional status (e.g., faculty,staff,student)
+                  Values are all scalars except inststatus,
+                  which is an array.
+  (e) $instids - reference to hash which will contain ID numbers -
+                  keys will be unique IDs (student or faculty/staff ID)
+                  values will be either: scalar (username) or an array
+                  if a single ID matches multiple usernames.
+  returns 1 parameter - 'ok' if no processing error, or other value
+                        if an error occurred.
+  side effects - populates the $instusers and $instids refs to hashes.
+                 with information for specified username, or specified
+                 id, if fifth argument provided, from all available, or
+                 specified (e.g., faculty only) institutional datafeeds,
+                 if sixth argument provided.
+  WARNING: You need to set $outcome to 'ok' once you have customized
+           this routine to communicate with an instititional
+           directory data source, otherwise retrieval of institutional
+           user information will always be reported as being unavailable
+           in domain $dom.
+ =cut
+ sub get_multusersinfo {
+     my ($dom,$type,$usernames,$instusers,$instids) = @_;
+     my $outcome = 'unavailable';
+     return $outcome;
+ }
  =pod
  =item inst_usertypes()

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.52
changed lines
	Added in v.1.59