Forum archive 2000-2006

Arnold K. Pizer - Classlist format

Arnold K. Pizer - Classlist format

by Arnold Pizer -
Number of replies: 0
inactiveTopicClasslist format topic started 4/27/2000; 4:17:08 PM
last post 7/9/2004; 11:45:23 AM
userArnold K. Pizer - Classlist format  blueArrow
4/27/2000; 4:17:08 PM (reads: 7271, responses: 1)

For WeBWorK2.0 instructions for importing class lists see http://webhost.math.rochester.edu/webworkdocs/discuss/msgReader$2397

NOTE: Be sure you understand the difference between the classlist and the classlist database. This is a new feature, and might not be fully documented. Often, the database should be edited (through the Professor's Page), rather than the classlist file itself.

Classlist files reside in the templates directory and have a ".lst" extension. "The" classlist file (usually named e.g. "mth101.lst") is used to initialize the classlist database for mth101. The classlist database can be imported from and exported to a classlist file (and also updated over the web). Other classlist files (e.g. "test_email.lst", "my_section.lst") can be used to send email to selected students.

The class list file is an ascii file whose structure structure is as follows:

Every line is a separate record with fields separated by $delim. $delim is defined in the Global.pm file with default value a comma (","). No field should contain a $delim . Every record must contain $noOfFieldsInClasslist records. $noOfFieldsInClasslist is a positive integer defined in the Global.pm file. It's current default value is 9. There are no header lines in the file.

The studentID (the first field) and the login name (the last field) must be unique. Both can contain only upper and lower case letters, digits, -, . , and _ . The fields are studentID, lastName, firstName, status, comment, section, recitation, email, and login name. Only the studentID and login name fields are required to be non blank but certainly the lastName field should be filled in. Also, if a student's email field is blank, email will not be sent to that student. However, a student can enter his or her own email address from the web. Here is a sample classlist file.

 

000-00-000a  ,PRACTICE1  ,        ,C      ,         ,Pizer  ,        ,                                ,practice1    
000-00-000b ,PRACTICE2 , ,C , ,Pizer , , ,practice2
000-00-000c ,PRACTICE3 , ,C , ,Pizer , , ,practice3
000-00-000d ,PRACTICE4 , ,C , , , , ,practice4
000-00-000e ,PROBLEM ,RANDOM ,C , ,Gage , , ,practice5
000-00-000f ,PRACTICE6 , ,DROP , ,Gage , , ,practice6
000-00-000g ,PRACTICE7 , ,DROP , ,Gage , , ,practice7
000-00-000h ,PRACTICE8 , ,D , ,Gage , , ,practice8
000-00-000i ,PRACTICE9 , ,D , ,Pizer , , ,practice9
111-11-1111 ,PIZER ,ARNOLD ,C , ,Pizer , Rec. 1 ,apizer@math.rochester.edu ,apizer
222-22-2222 ,DOUGLASS ,SCOTT ,C , ,Pizer , Rec. 1 ,douglass@math.rochester.edu ,douglass
333-33-3333 ,MOUSSA ,BASEM ,C , ,Pizer , Rec. 1 ,moussa@math.rochester.edu ,moussa
444-44-4444 ,GAGE ,MIKE ,C , ,Gage , Rec. 1 ,gage@math.rochester.edu ,gage
010-01-0100 ,CABOTT ,JOHN ,DROP ,9/4/96 ,Gage , Rec. 2 ,jc001f@uhura.cc.rochester.edu ,jc001f
020-02-0200 ,BONET ,JANE ,DROP ,9/11/96 ,Gage , Rec. 2 ,jb004f@uhura.cc.rochester.edu ,jb004f



030-03-0300 ,HOYER ,MARK ,DROP , ,Gage , Rec. 2 ,mh010f@uhura.cc.rochester.edu ,mh010f
040-04-0400 ,RICHARD ,JOAN ,DROP , ,Pizer , Rec. 2 ,jr001f@uhura.cc.rochester.edu ,jr001f
060-06-0600 ,ROBERTS ,HAL ,DROP , ,Pizer , Rec. 3 ,hr002f@uhura.cc.rochester.edu ,hr002f
070-07-0700 ,MUELSON ,JOY ,DROP , ,Pizer , Rec. 3 ,jm002e@uhura.cc.rochester.edu ,jm002e
050-05-0500 ,SAMSON ,WENDY ,DROP , ,Pizer , Rec. 3 ,wsamson@frontiernet.net ,050-05-0500
080-08-0800 ,THOMAS ,SALLY ,audit , ,Gage , Rec. 4 ,st008c@uhura.cc.rochester.edu ,st008c
090-09-0900 ,SMITH ,DAVID ,DROP , ,Gage , Rec. 4 ,dsoo9e@uhura.cc.rochester.edu ,ds009e
009-09-0009 ,SMITH ,JUDY ,C , ,Gage , Rec. 4 ,js005e@uhura.cc.rochester.edu ,js005e

The perl script readURClassList.pl reads a semi-colon delimited file from the UR registrar and outputs a classlist file having the required format.

The fields of the class list file in left to right order are:

studentID
(normally a SSN in the format 123-45-6789 or a bogus SSN such as 000-00-000a. This must be unique and can contain only upper and lower case letters, digits, -, . , and _ . )
lastName
(e.g. Public)
firstName
(including middle names and initials, e.g. Jane Q.)
status
(usually blank or C (for current), but could be D, Drop, or Withdrawn. @statusDrop in Global.pm lists the words which indicate the student has dropped. Anything else indicates the student is active.)
comment
(a field for comments, e.g. "added 3/3/96")
section
(e.g. Pizer MWF9)
recitation
(e.g. Smith M 2:00)
e-mail
(student's e-mail address)
login name
(student's login name. This must be unique and can contain only upper and lower case letters, digits, -, . , and _ . )

 

<| Post or View Comments |>


userMichael Gage - Re: Classlist format  blueArrow
7/9/2004; 11:45:23 AM (reads: 5975, responses: 0)
These instructions are for WeBWorK 2.0

A more up-to-date description is on the twiki at http://devel.webwork.rochester.edu/twiki/bin/view/Webwork/ClasslistFileFormat

A classlist files resides in the templates directory and is a convenient way to add a large number of students to a course at once. A classlist file can be used to initialize the classlist database using the import function of the "Class List Editor".

The class list file can be created using a spread sheet application such as Excel and then saved as a text .csv (comma separated variables) file. This file can be uploaded to the WeBWorK server using the "File Manager" facility and from there it can be used to add students to the class with the "Classlist Editor" as described above.

The class list file is an ascii file whose structure structure is as follows:

Every line is a separate record with fields separated by a comma (","). No field should contain a comma . There are no header lines in the file.

The studentID (the first field) and the login name (the last field) must be unique. Both can contain only upper and lower case letters, digits, -, . , and _ . The fields are studentID, lastName, firstName, status, comment, section, recitation, email, and login name. Only the studentID and login name fields are required to be non blank but certainly the lastName field should be filled in. Also, if a student's email field is blank, email will not be sent to that student. However, a student can enter his or her own email address from the web. Here is a sample classlist file.

 

000-00-000a  ,PRACTICE1  ,        ,C      ,         ,Pizer  ,        ,                                ,practice1    
000-00-000b ,PRACTICE2 , ,C , ,Pizer , , ,practice2
000-00-000c ,PRACTICE3 , ,C , ,Pizer , , ,practice3
000-00-000d ,PRACTICE4 , ,C , , , , ,practice4
000-00-000e ,PROBLEM ,RANDOM ,C , ,Gage , , ,practice5
000-00-000f ,PRACTICE6 , ,DROP , ,Gage , , ,practice6
000-00-000g ,PRACTICE7 , ,DROP , ,Gage , , ,practice7
000-00-000h ,PRACTICE8 , ,D , ,Gage , , ,practice8
000-00-000i ,PRACTICE9 , ,D , ,Pizer , , ,practice9
111-11-1111 ,PIZER ,ARNOLD ,C , ,Pizer , Rec. 1 ,apizer@math.rochester.edu ,apizer
222-22-2222 ,DOUGLASS ,SCOTT ,C , ,Pizer , Rec. 1 ,douglass@math.rochester.edu ,douglass
333-33-3333 ,MOUSSA ,BASEM ,C , ,Pizer , Rec. 1 ,moussa@math.rochester.edu ,moussa
444-44-4444 ,GAGE ,MIKE ,C , ,Gage , Rec. 1 ,gage@math.rochester.edu ,gage
010-01-0100 ,CABOTT ,JOHN ,DROP ,9/4/96 ,Gage , Rec. 2 ,jc001f@uhura.cc.rochester.edu ,jc001f
020-02-0200 ,BONET ,JANE ,DROP ,9/11/96 ,Gage , Rec. 2 ,jb004f@uhura.cc.rochester.edu ,jb004f



030-03-0300 ,HOYER ,MARK ,DROP , ,Gage , Rec. 2 ,mh010f@uhura.cc.rochester.edu ,mh010f
040-04-0400 ,RICHARD ,JOAN ,DROP , ,Pizer , Rec. 2 ,jr001f@uhura.cc.rochester.edu ,jr001f
060-06-0600 ,ROBERTS ,HAL ,DROP , ,Pizer , Rec. 3 ,hr002f@uhura.cc.rochester.edu ,hr002f
070-07-0700 ,MUELSON ,JOY ,DROP , ,Pizer , Rec. 3 ,jm002e@uhura.cc.rochester.edu ,jm002e
050-05-0500 ,SAMSON ,WENDY ,DROP , ,Pizer , Rec. 3 ,wsamson@frontiernet.net ,050-05-0500
080-08-0800 ,THOMAS ,SALLY ,audit , ,Gage , Rec. 4 ,st008c@uhura.cc.rochester.edu ,st008c
090-09-0900 ,SMITH ,DAVID ,DROP , ,Gage , Rec. 4 ,dsoo9e@uhura.cc.rochester.edu ,ds009e
009-09-0009 ,SMITH ,JUDY ,C , ,Gage , Rec. 4 ,js005e@uhura.cc.rochester.edu ,js005e

The perl script readURClassList.pl reads a semi-colon delimited file from the UR registrar and outputs a classlist file having the required format.

The fields of the class list file in left to right order are:

studentID
(normally a SSN in the format 123-45-6789 or a bogus SSN such as 000-00-000a. This must be unique and can contain only upper and lower case letters, digits, -, . , and _ . )
lastName
(e.g. Public)
firstName
(including middle names and initials, e.g. Jane Q.)
status
(usually C (for current), but could be D, Drop, or Withdrawn. @statusDrop in Global.pm lists the words which indicate the student has dropped. !!!Anything else indicates the student is active. !! WARNING- this is supposed to be the case, but currently it can sometimes cause problems -- use C explicitly to indicate a student who is enrolled!!!!!!)
comment
(a field for comments, e.g. "added 3/3/96")
section
(e.g. Pizer MWF9)
recitation
(e.g. Smith M 2:00)
e-mail
(student's e-mail address)
login name
(student's login name. This must be unique and can contain only upper and lower case letters, digits, -, . , and _ . )

 

<| Post or View Comments |>