SUMS-import

History

Version (most recent first)

Date

Changer

Change

v1.0

2008-10-10

Jim Briggs

First draft

Introduction

Aim

SUMS-import is the part of the overall SUMS system that allows the import and export of data to/from PUMS.

Key personnel

Responsible owner

Jim Briggs

Design authority

Jim Briggs

Development team

Maciej Milgiewicz

Future proofing

SUMS-import must integrate with the overall SUMS system.

Requirements

Entities and attributes

As for other modules

Functionality

1 Requirement Type Status Change request(s)
1 Import a list of students into SUMS from a PUMS cohort. M1    
1.1

The format of a PUMS student file is:

  • text file
  • one line per record (i.e. per student)
  • fields separated by colon (:)
  • the fields of a record are specified here and appear in the order specified

An example of a record is

Student, Test 299999:WM1-ISY:PJE60P::Jim.Briggs:Tineke.Fitch:Test critical categories:::::::::test30954::White::

M1    
1.2

It should be possible to import a cohort either:

  1. by uploading a cohort student file to the application while specifying the cohort that it relates to, e.g. a user interface containing:
    1. a listbox that allows the user to select one of the already existing cohorts in the SUMS database; and
    2. a file control that allows the user to choose the appropriate file
  2. by specifying the name of the cohort and leaving the application to find the files for that cohort in its native filesystem
    1. the root of the cohort tree should be specified as a system parameter
    2. the student file for a particular cohort will always be found in the file [ROOT]/[COHORT]/students
M2
 
1.3

When importing a list of students, there should be two modes of operation (chosen by the user e.g. by radio buttons)

  1. create mode - student records will only be created in SUMS if they do not already exist - default mode
  2. update mode - student records in SUMS will be updated with the information imported - this may overwrite information in SUMS
M2    
2 Export a list of students from SUMS to a PUMS cohort in the specified format M3    
2.1

It should be possible to export a cohort either:

  1. by downloading a cohort student file to the user's machine by specifying the cohort that it relates to, e.g. by a listbox that allows the user to select one of the already existing cohorts in the SUMS database
  2. by specifying the name of the cohort and leaving the application to find the files for that cohort in its native filesystem
    1. the root of the cohort tree should be specified as a system parameter
    2. the student file for a particular cohort will always be found in the file [ROOT]/[COHORT]/students
M3    

Additional notes

User and project matching

It is very possible that when importing a student record, a record for that student may already exist in SUMS. There are two sub-cases of this:

  1. the student exists in SUMS doing a project in the specified cohort - in this case a new record in SUMS will not be created (though an existing one might be updated)
  2. the student exists in SUMS because they have done a project in another cohort - in which case a new record for the specified cohort will be created, and linked to the already existing student

There must NEVER be 2 or more PERSON entities in SUMS corresponding to the same individual.

When importing student identities, an imported record will be considered as matching an existing PERSON entity if:

When importing projects, an imported record will be considered as match an existing PROJECT entity if: