!=============================================================================!
!  DIVISION   I	:				     HELP MODULE DECLARATION  !
!=============================================================================!
!									      !
!      -----------------------------------------------------------------      !
!      SECTION 01 :					 INITIAL VERSION      !
!      -----------------------------------------------------------------      !
!									      !
!      File Specification: ACCSRC_HELPSTAFF:ACCESSSYS.HLP		      !
!      Author		 : Marlys A. Nelson				      !
!      Initial version	 : 01.00.00 15-OCT-1984	VMS 3.6			      !
!									      !
!      -----------------------------------------------------------------      !
!      SECTION 02 :				    MODIFICATION HISTORY      !
!      -----------------------------------------------------------------      !
!									      !
!      01.00.01 29-OCT-1984 VMS 3.6: Marlys A. Nelson			      !
!		Added documentation for commands DELETE, DROP,  FORWARD,      !
!		  LIST, PATCH, PRINT, SET and SHOW.			      !
!									      !
!=============================================================================!
!  DIVISION  II	:				  HELP MODULE SPECIFICATIONS  !
!=============================================================================!
!									      !
!      Key 1 .......................... ACCESS_SYSTEM			      !
!        Key 2 ........................	  ASSIGN                              !
!        Key 2 ........................   CREATE			      !
!	 Key 2 ........................   DELETE		  (01.00.01)  !
!	 Key 2 ........................   DROP			  (01.00.01)  !
!        Key 2 ........................   EXIT				      !
!	 Key 2 ........................   FORWARD		  (01.00.01)  !
!	   Key 3 ......................     Parameters		  (01.00.01)  !
!        Key 2 ........................   HELP				      !
!	 Key 2 ........................   LIST			  (01.00.01)  !
!	 Key 2 ........................   PATCH			  (01.00.01)  !
!	   Key 3 ......................     Parameters		  (01.00.01)  !
!	 Key 2 ........................   PRINT			  (01.00.01)  !
!        Key 2 ........................   REMOVE    			      !
!	 Key 2 ........................   SET			  (01.00.01)  !
!	   Key 3 ......................     Parameters		  (01.00.01)  !
!	 Key 2 ........................   SHOW			  (01.00.01)  !
!									      !
!=============================================================================!
!  DIVISION III	:					       SPECIAL NOTES  !
!=============================================================================!
!									      !
!									      !
!=============================================================================!
!
!=============================================================================!
! Key 1							        Access_System !
!=============================================================================!
!
1 Access_System
Access_System is a program designed to allow  the  system  manager  to
maintain  the  Access  system  data  file.   Commands are available to
generate job  procedures  to  create  and  remove  student  usernames.
Initial  usernames  may  be  assigned  for  records retrieved from the
administrative data tape.  Complete records can also be  removed  from
the data file for dropped and removed students.   The "end-of-quarter"
username removal is accomplished by use of this program also.

Only the system manager may use this program.
!
!=============================================================================!
! Key 2							               Assign !
!=============================================================================!
!
2 Assign
Assigns VAX username information to  selected  student  records  which
have been recently retrieved from the administrative data tape.

Format:

     Assign

This  command  must  be  executed  once  each time student records are
retrieved from the administrative data tape.  Such student records  do
not  include username and password information.  Student records which
are added by the instructor via the  Access  program  do  include  the
username/password information.

The ASSIGN command will update all selected records on the system data
file which do not have a 'Y' in the 'assign' flag column.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2								       CREATE !
!=============================================================================!
!
2 Create
Generates procedure files to create usernames, directories, quotas and
all other  necessary  system  information  for  students  enrolled  in
courses requiring the use of the computer system.

Format:

     Create

Four procedure files  are  generated  for  each  selected  department,
course and section which requires at least one username to be created.
The files, identified by  the  filetypes  listed  below,  perform  the
following actions:

  o  .AUT  Commands to create the username via the AUTHORIZE utility.
  o  .DRC  Commands to create the  main  directory  for  the  username
           using the $CREATE/DIRECTORY command.
  o  .LGI  Commands to copy the initial  ALTLOGIN.COM  procedure  into
           the main directory  of  the  username.   This  ALTLOGIN.COM
           performs the initial password change commands.
  o  .QUO  Commands to add disk quota space  for  the  uic  using  the
           DISKQUOTA utility.

Each file has a  filename  corresponding  to  the  department  number,
course  number and section number to which it applies, i.e. 113017101.
The files are stored in the directory:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy.JOBS]

where 'ddmmmyy' indicates the current day, month and year on which the
access_system program is running, i.e. 10OCT84.

In  addition  to the actual job procedure files, a file containing the
commands necessary to submit the job  procedure  files  is  generated.
This file is created under the filespec:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy]CREATE.JOB

After  terminating  the access_system program, the system manager must
enter the command:

     $ @DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyyy]CREATE.JOB

to actually create the usernames and directories.

All job log files are written to disk (not printed) in the directory:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy.LOGS]

All directories required are automatically created  by  access_system,
if they do not already exist.

The CREATE command will update all selected records on the system data
file which have been assigned ('Y' in 'assign' column)  but  have  not
yet been created (' ' in 'create' column).

Each selected department name, course and section number on  the  data
file is displayed.  A count of the number of usernames created for the
dept., course and section is also shown.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2								       DELETE !
!=============================================================================!
!
2 Delete
Deletes the complete  system  data  file  record  for  those  selected
usernames which have been removed.

Format:

     DElete

The DELETE command will delete all selected records on the system data
file  which  have been assigned ('Y' in 'assign' column), created ('Y'
in 'create' column), dropped ('Y' in 'drop' column) and  removed  ('Y'
in 'remove' column).

Each  selected  department name, course and section number on the data
file is displayed.  A count of the number of records deleted  for  the
dept., course and section is also shown.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2									 DROP !
!=============================================================================!
!
2 Drop
Marks   all   selected   usernames   as  "dropped"  UNLESS  marked  as
"incomplete" or "permanent".

Format:

     DRop

The DROP command is used to prepare for the "end-of-quarter"  username
clean out.  By entering the DROP command, all selected usernames which
have not been marked as incomplete ('Y'  in  'incomplete'  column)  or
have  not been marked as permanent ('Y' in 'permanent' column) will be
marked as dropped ('Y' in 'drop' column).  A subsequent REMOVE command
will  create the necessary job files to actually delete the usernames.

Each  selected  department name, course and section number on the data
file is displayed.  A count of the number of records dropped  for  the
dept., course and section is also shown.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2							                 EXIT !
!=============================================================================!
!
2 Exit
Terminates the Access_System program.

Format:

     Exit
!
!=============================================================================!
! Key 2								      FORWARD !
!=============================================================================!
!
2 Forward
Transfers selected usernames from the currently set quarter  into  the
specified quarter.

Format:

     Forward quarter

The FORWARD command will  update  selected  records  which  have  been
assigned  ('Y'  in 'assign' column), created ('Y' in 'create' column),
not dropped (' ' in 'drop' column),  not  removed  ('  '  in  'remove'
column)  and  either marked as incomplete ('Y' in 'incomplete' column)
or permanent ('Y' in 'permanent' column).

All usernames which will exist on the computer in the new quarter MUST
be  transferred  forward  BEFORE  new  usernames  are  assigned in the
quarter.  This is the only way to prevent  duplicate  usernames.   The
FORWARD  command  should  be used during the "end-of-quarter" username
clean out.  A transferred record will contain 'Y' flags  in  both  the
old and new quarter columns.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!
3 Parameters
  quarter

    This specifies the  quarter  into  which  the  selected  usernames
    should  be  transferred.   This  should be specified as one of the
    following:

        FALL
        WINTER
        SPRING
        SUMMER

    You must specify this parameter.
!
!=============================================================================!
! Key 2							                 HELP !
!=============================================================================!
!
2 Help
Provides on-line  information  about  the  use  of  the  Access_System
program.

Format:

     Help
!
!=============================================================================!
! Key 2								         LIST !
!=============================================================================!
!
2 List
Lists, at the terminal, various information about the selected records
in the system data file.

Format:

     List

Each  selected  department name, course and section number on the data
file is displayed.  The total  number  of  records  in  each  selected
department,  course  and  section  is listed, as well as the number of
records in each  of  10  other  categories.   The  10  categories  are
determined by the various flag columns, as shown below:

  o  assigned                   o  marked as permanent
  o  created                    o  set for fall quarter
  o  dropped                    o  set for winter quarter
  o  removed                    o  set for spring quarter
  o  marked as incomplete       o  set for summer quarter

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2								        PATCH !
!=============================================================================!
!
2 Patch
Allows  certain flag columns to be 'editted' for all selected records.
This is similar to the EDIT command  in  ACCESS,  however,  the  PATCH
command  operates  on  all  records  in selected departments, courses,
sections and quarters.

Format:

     PAtch code column

The specified column is  set  ('Y'  in  column)  or  cleared  (' '  in
column),  depending  upon  the  code  specified.

Each  selected  department name, course and section number on the data
file is displayed.  A count of the number of records patched  for  the
dept., course and section is also shown.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!
3 Parameters
  code

    This specifies whether the patch to be applied is to set (enter  a
    'Y'  in  the column) or to clear (enter a ' ' in the column).  The
    valid patch codes are:

        CLEAR
        SET

    You must specify this parameter.

  column

    This  indicates  which column is to be patched.  The valid columns
    are:

      ASSIGN            PERMANENT
      CREATE            FALL
      DROP              WINTER
      REMOVE            SPRING
      INCOMPLETE        SUMMER

    You must specify this parameter.
!
!=============================================================================!
! Key 2								        PRINT !
!=============================================================================!
!
2 Print
Prints, on the line printer, various information  about  the  selected
records in the system data file.

Format:

     Print

Each selected department name, course and section number on  the  data
file  is  shown.   The  total  number  of  records  in  each  selected
department, course and section is shown, as  well  as  the  number  of
records  in  each  of  10  other  categories.   The  10 categories are
determined by the various flag columns, as given below:

  o  assigned                   o  marked as permanent
  o  created                    o  set for fall quarter
  o  dropped                    o  set for winter quarter
  o  removed                    o  set for spring quarter
  o  marked as incomplete       o  set for summer quarter

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2								       REMOVE !
!=============================================================================!
!
2 Remove
Generates procedure files to remove the usernames and  directories  of
'dropped' students.

Format:

     Remove

Three  procedure  files  are  generated  for each selected department,
course and section which requires at least one username to be removed.
The  files,  identified  by  the  filetypes  listed below, perform the
following actions:

  o  .REA  Commands to remove the username via the AUTHORIZE utility.
  o  .RED  Commands to delete all files within the user's main  direc-
           tory, as well as the main directory itself.
  o  .REQ  Commands to remove the disk quota entry for this  user  via
           the DISKQUOTA utility.

Each file has a  filename  corresponding  to  the  department  number,
course  number and section number to which it applies, i.e. 113017101.
The files are stored in the directory:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy.JOBS]

where 'ddmmmyy' indicates the current day, month and year on which the
access_system program is running, i.e. 10OCT84.

In  addition  to the actual job procedure files, a file containing the
commands necessary to submit the job  procedure  files  is  generated.
This file is created under the filespec:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy]REMOVE.JOB

After  terminating  the access_system program, the system manager must
enter the command:

     $ @DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyyy]REMOVE.JOB

to actually remove the usernames and directories from the system.

All job log files are written to disk (not printed) in the directory:

     DRA0:[ACC.BLACKHOLE.ACCESS.ddmmmyy.LOGS]

All directories required are automatically created  by  access_system,
if they do not already exist.

The  REMOVE  command  will  examine all selected records on the system
data file which have been assigned ('Y' in 'assign'  column),  created
('Y'  in  'create' column) and dropped ('Y' in 'drop' column), but not
yet removed (' ' in 'remove' column).

Each  department  name,  course and section number on the data file is
displayed.  A count of the number of usernames removed for the  dept.,
course and section is also shown.

The records selected by this command are determined by the department,
course,  section  and  quarter  specified  in  the  "set" command.  By
default, all departments, courses and sections on file for the current
quarter are selected.
!
!=============================================================================!
! Key 2							                  SET !
!=============================================================================!
!
2 Set
Identifies the department, course, section and quarter to be  used  to
select records in all subsequent commands.

Format:

     SET [department][,[course][,[section][,quarter]]]
     or
     SET DEFAULT

All commands, except EXIT and HELP,  perform  the  specified  task  in
relation  to  a specific department, course, section and quarter.  You
use the SET  command  to  identify  this  information  for  subsequent
commands.

You  do  not need to enter the SET command at all.  If you do not, the
following defaults will be used:

  o  all departments
  o  all courses
  o  all sections
  o  current quarter

You  only  need to specify, in any given SET command, those parameters
which you wish to  change.   The  values  for  unspecified  parameters
remain at the currently set value.
!
!
3 Parameters
  department

    The  name  of  the  department  in  which  the  course/section  is
    catalogued.   Each  department has a four-digit number assigned to
    it.  Some departments have  more  than  one  such  number  if  the
    department includes logically different courses.  For this reason,
    several departments may have more than one department  name  which
    can  be  entered in the SET command.  Please make sure you use the
    proper name.  Valid department names can be displayed  by  use  of
    the SHOW command.

    The department name can be  abbreviated  to  the  shortest  unique
    combination  of  letters.   For  example:  Computer_Systems can be
    entered simply as 'C'.

    The asterisk, *, may be used to specify all departments.
    
  course

    The course number.  This is  always  a  three-digit  number.   The
    asterisk, *, may be used to specify all courses.

  section

    The section number.  This can be entered as either a one-digit  or
    two-digit  number.   The  asterisk,  *, may be used to specify all
    sections.

  quarter

    The academic year quarter.  This should be specified by use of one
    of the following keywords:

        FALL
        WINTER
        SPRING
        SUMMER

    The asterisk, *, may be used to specify all quarters.

  DEFAULT

    Resets  all  values  to  the  default values: all departments, all
    courses, all sections and the current quarter.  This is equivalent
    to entering:

        SET *,*,*,current-quarter
!
!=============================================================================!
! Key 2							                 SHOW !
!=============================================================================!
!
2 Show
Displays the currently 'SET' department, course, section and quarter.

Format:

     SHOW
!
!=============================================================================!
!							   END OF HELP MODULE !
!=============================================================================!
