2. Readings Import
The materials within eReserve Plus are called Readings. Each Reading displayed by eReserve Plus is a combination of a citation and bibliography. The citation is shown as the title of the reading and when clicked the bibliographic reference is displayed.
Readings are imported with link references in a CSV file, a mapping file, and a folder containing the physical files. The physical files are uploaded to Cloud Storage.
The import definition for Readings is strict and requires that data meets the eReserve validation rules for each kind of Reading (i.e. Books, Journal Articles, Websites, Motion Picture etc).
2.1 Pre-requisites
1.The Archive folder will need to be prepared as a .zip file which should contain the following elements:
a. The Data File: This is a CSV file in a UTF-8 file format - Filename = import_records.csv
b.The Mapping File: This is a YML file which references the data to map it to the correct fileds - Filename = csv_to_document_mapping.yml
c. The Resource Folder: This is a folder which should contain any physical files (e.g. PDFs, MGPs, JPG etc) referenced in the Data File. All resources should be saved with its reference in the Data File. e.g. thedish.pdf
The templates and a sample dataset for each genre are available for use here
2.2 Mandatory Data
The columns for the Data File can vary depending on the legacy data, however as a minimum it should contain the following:
| Column | Description | Type | Suggested Value |
|---|---|---|---|
| source_document_title | The title of the source document | Text | Data Dictionary |
| source_document_kind | The kind of source document associated with the reading (e.g. book, journal, etc.) | Text | Data Dictionary |
| source_document_licence | The licence for the source document | Text | Data Dictionary |
| source_document_genre | The genre for the source document (e.g. book, conference, report, legal case, etc) | Text | Data Dictionary |
| reading_title | The title of a reading | Text | Data Dictionary |
| reading_genre | The genre of the reading itself (e.g. chapter, journal article, legal article, etc.) | Text | Data Dictionary |
| reading_kind | Denotes whether the reading is a FILE or a LINK or needs to be located | Text | Data Dictionary |
| reading_reference | The file or link associated with the reading | Text | Data Dictionary |
These columns dictate how Readings are rendered in eReserve Plus and form the basis for copyright conflict detection.
2.3 Additional data requirements
Depending on the combination of the source_document_kind, source_document_genre and reading_genre there will be other required columns. There are also a number of optional columns which can enhance the metadata in eReserve Plus once imported. This optional metadata can be explored required_fields_for_flat_file_import.