source: WAeUP_Doc/NewDocumentation/ImportData.txt @ 3513

Last change on this file since 3513 was 3512, checked in by Henrik Bettermann, 16 years ago

Import Instructions reworked

File size: 7.9 KB
Line 
1Import of data into the portal
2++++++++++++++++++++++++++++++
3
4General procedure
5-----------------
6
7A record is read from the input source file located in the import folder of the Zope instance (or uploaded by the upload manager in the Upload Section. The data format is validated against the import data layout selected. If the record can be imported, it is **appended** to the file [layout]_imported.csv (in the same folder), otherwise it is **inserted** into the file [layout]_pending.csv, if no record with exactly the same data already exists. Technically speaking, the md5-digests of the new record is being compared with the existing records.
8
9The report files have five additional columns: import_mode, imported_by (the member who did the import), import_date, import_from (input source file name) and error (error message). The pending file can be edited and re-imported by selecting 'pending data only'.
10
11The following import modes are recognized: edit, create and remove. The latter deletes the whole record. This mode is available for course results only.
12
13Single fields can be cleared in edit mode by inserting 'XXX' in the respective field. Empty fields are ignored.
14
15The following import layouts are available:
16
171. Student Section
18++++++++++++++++++
19
20import_application
21------------------
22
23
24This data layout is meant for updating the applicants_catalog which is completely separated from the object-based part of the portal. An important role has the field 'status'. It should be either 'admitted', 'not admitted' or empty. If student objects have already been created, the status field can no longer be modified. If student_id and matric_no are specified, it is checked, if the student_id and matric_no belong to the same student.
25
26::
27
28 import_mode        String
29 course1            String
30 course2            String
31 course3a           String
32 course_admitted    String
33 department         String
34 faculty            String
35 firstname          String
36 eng_score          Int
37 subj1              Int
38 subj1score         Int
39 subj2              Int
40 subj2score         Int
41 subj3              Int
42 subj3score         Int
43 aggregate          Int
44 lastname           String
45 middlenames        String
46 email              String
47 phone              String
48 pin                String
49 reg_no             String
50 date_of_birth      DateTime
51 jamb_age           String
52 jamb_state         String
53 jamb_lga           String
54 application_date   DateTime
55 sex                Boolean
56 lga                String
57 screening_date     DateTime
58 screening_type     String
59 passport           String
60 status             String
61 screening_venue    String
62 aos                String
63 screening_score    String
64 notice             String
65 student_id         String
66 fst_sit_fname      String
67 fst_sit_no         String
68 fst_sit_date       DateTime
69 fst_sit_type       String
70 fst_sit_results    StringList
71 scd_sit_fname      String
72 scd_sit_no         String
73 scd_sit_date       DateTime
74 scd_sit_type       String
75 scd_sit_results    StringList
76 hq_type            String
77 hq_grade           String
78 hq_school          String
79 hq_matric_no       String
80 hq_session         String
81 hq_disc            String
82 serial             String
83
84
85import_student
86--------------
87
88This is the most powerful import layout. It's a brute-force method which can be used to create student objects or to overwrite existing student objects (and the associated records in the students_catalog). The reg_transition can be either 'admit' or 'return'. The students will be in state admitted or returning respectively. Don't use this method to import current verdicts. Use the import_verdict layout instead.
89
90::
91
92 id                 String
93 import_mode        String
94 reg_transition     String
95 firstname          String
96 middlename         String
97 lastname           String
98 sex                String
99 birthday           String
100 matric_no          String
101 jamb_reg_no        String
102 entry_mode         String
103 entry_session      String
104 jamb_score         Int
105 jamb_age           String
106 jamb_lga           String
107 jamb_state         String
108 jamb_sex           String
109 lga                String
110 state              String
111 study_course       String
112 nationality        String
113 lga                String
114 phone              String
115 email              String
116 app_email          String
117 current_level      String
118 current_session    String
119 current_verdict    String
120 previous_verdict   String
121 current_mode       String
122 perm_address       String
123
124
125import_student_study_level           
126--------------------------
127
128This layout can be used to create or overwrite old study levels and to import their verdicts. The field 'code' corresponds with the study level. It can be either '000', '100', ..., '900'.
129
130::
131
132 import_mode        String
133 id                 String
134 matric_no          String
135 code               String
136 session            String
137 verdict            String
138 validated_by       String
139 validation_date    DateTime
140
141
142import_verdict
143--------------
144
145The import_verdict layout should be used to import the current verdict, i.e. the verdict of the current session and current level. This layout is special. It does not only import data but also performs a workflow transition. The student must be in state 'courses_validated' (all other states will be rejected) and will be moved to state 'return'. 
146
147::
148
149 import_mode        String
150 id                 String
151 matric_no          String
152 current_level      String
153 current_session    String
154 current_verdict    String
155
156
157course_result           
158-------------
159
160This layout creates or edits course results. The 'create' mode should only be used in old levels rather than in current levels which have been validated by course advisers. Creating course results in validated course lists is possible but counteracts the whole course registration policy.
161
162::
163
164 import_mode        String
165 id                 String
166 matric_no          String
167 code               String
168 session_id         String
169 level_id           String
170 credits            Int
171 score              String
172 grade              String
173 carry_over         Boolean
174 core_or_elective   Boolean
175 semester           Int
176
177
1782. Academic Section
179+++++++++++++++++++
180
181The following import layouts can be used to create or edit faculties, departments, certificates, certificates courses and or course objects respectively. There are quite a few dependencies which result from the nature of the academic section. For example, a certificate can only be created, if the respective department exists.
182
183import_faculty
184--------------
185
186::
187           
188 import_mode        String
189 code               String
190 title              String
191 title_prefix       String
192
193
194import_department           
195-----------------
196
197::
198
199 import_mode        String
200 code               String
201 faculty_code       String
202 title              String
203 title_prefix       String
204
205
206certificate
207-----------
208
209::
210           
211 import_mode        String
212 title              String
213 admin_status       String
214 category           String
215 department_code    String
216 code               String
217 end_level          String
218 max_load           Int
219 max_pass           Int
220 nr_years           Int
221 probation_credits  Int
222 promotion_credits  Int
223 start_level        String
224 study_mode         String
225 application_category  String
226
227
228certificate_course
229------------------
230
231::
232           
233 import_mode        String
234 code               String
235 certificate_code   String
236 level              String
237 core_or_elective   Boolean
238
239
240course           
241------
242
243::
244
245 import_mode        String
246 title              String
247 department_code    String
248 code               String
249 credits            Int
250 passmark           Int
251 semester           Int
252 level              String
253
254
Note: See TracBrowser for help on using the repository browser.