Changeset 3217 for WAeUP_Doc

Timestamp:

25 Feb 2008, 11:44:50 (17 years ago)

Author:

Henrik Bettermann

Message:

rewrite ImportNew?.txt

Location:

WAeUP_Doc

Files:

• Makefile (deleted)
• NewDocumentation/ImportNew.html (added)
• NewDocumentation/ImportNew.txt (modified) (1 diff)
• NewDocumentation/Makefile (added)
• NewDocumentation/Readme.txt (added)
• NewDocumentation/rst2html.bat (added)
• NewDocumentation/rst2html.py (added)
• Readme.txt (deleted)
• rst2html.bat (deleted)
• rst2html.py (deleted)

WAeUP_Doc/NewDocumentation/ImportNew.txt

@@ +1 @@
+================================== 
+Import of data into the portal 
 ==================================
-Import of massdata into the portal
-==================================
-General procedure
+
+General procedure 
 ----------------------------------
 
-A record is read from the input-source-file and the data is checked. If the
-record can be imported, it is **appended** to the file XXX_imported.csv,
-otherwise it is **inserted** into the file XXX_pending.csv, if no record
-with the exact same date already exists in the XXX_pending.csv. The check is
-done by comparing the md5-digests of the new record with the existing records.
+A 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.
 
-When doing the import in pending-only-mode the XXX_pending.csv is taken as
-input-source-file and if a record can now be imported it is appended to the
-XXX_imported.csv file and removed from XXX_pending.csv.
+The 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'.
 
-**Caveat**:
+There following import modes are recognized: edit, create and remove. The latter deletes the whole record. This mode is available for course results only.
 
-  if an record is inserted into XXX_pending, it will only be removed by
-  importing in pending-only-mode. If a new input-file contains a record for
-  the same object, with different data, that will not be detected at the
-  moment.
+Single fields can be cleared in edit mode by inserting 'XXX' in the respective field. Empty fields are ignored. 
 
-The XXX_imported.csv and XXX_pending file has these columns added:
 
-:imported_by:
-
- the member who did the import
- 
-:import_mode:
-
- edit, create, delete
- 
-:import_date:
-
- the date and time of the import
- 
-:imported_from:
-
- the filename of the input-source-file
- 
-:error:
-
- the error message (empty in XXX_imported)
- 
-