source: WAeUP_Doc/NewDocumentation/ImportNew.txt @ 3323

Last change on this file since 3323 was 3218, checked in by Henrik Bettermann, 17 years ago

further improvements

File size: 2.8 KB
Line 
1Import of data into the portal
2++++++++++++++++++++++++++++++++++
3
4
5General procedure
6----------------------------------
7
8A record is read from the input source file located in the import folder of the Zope instance. 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.
9
10The 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'.
11
12There following import modes are recognized: edit, create and remove. The latter deletes the whole record. This mode is available for course results only.
13
14Single fields can be cleared in edit mode by inserting 'XXX' in the respective field. Empty fields are ignored.
15
16
17
18The import form 
19---------------
20
21:Filename:
22  Select the file to be imported. This selct box shows all csv files in the import folder 
23:Import Layout:
24  Select the data layout of the import file.
25 
26If the button **Bypass QueueCatalog** is shown, click it!
27
28Click "Import" to start the import.
29
30
31Verdicts import
32----------------------------------
33
34
35The import csv file must have one of these headlines:
36
37| student_id, current_session, current_level, current_verdict
38|
39| matric_no, current_session, current_level, current_verdict
40|
41| student_id,matric_no, current_session, current_level, current_verdict
42
43
44:student_id:
45  the id of the student
46 
47:matric_no:
48  The student's matriculation number.
49  If student_id and matric_no are specified, it is checked, if the student_id
50  and matric_no belong to the same student.
51 
52:current_session:
53  The session key (e.g. 6) or session string (e.g. 2006/2007) the verdict refers to.
54 
55:current_level:
56  The level key the verdict refers to. On probation levels must be specified as
57  level number + 10 or +20 (e.g. 110 for students on first probation).
58
59:current_verdict:
60  The verdict key from the vocabulary *verdicts*.
61 
62
63Example file::
64
65 matric_no, current_session, current_level,current_verdict
66 MGS0602342,06,200,B
67 MGS0602346,06,200,A
68 MGS0602350,06,200,B
69 MGS0602360,06,200,A
70 MGS0602375,06,200,B
71 MGS0602388,06,200,A
72 MGS0602390,06,200,A
73 MGS0603494,06,200,B
74
75
76
77Logging messages
78----------------
79
80Start message
81
82|
83
84Successful import message
85
86|
87
88Unsuccessful import message
89
90|
91
92Commit message
93
94|
95
96Final message
97
98|
99
100Error messages in verdicts.pending
101----------------------------------
102
103|
104
105
106
Note: See TracBrowser for help on using the repository browser.