Avalon's Batch Ingest feature provides a method of building one or more media objects at a time from uploaded content and metadata outside the user interface. A batch ingest is started by uploading an Ingest Package consisting of one Manifest File and zero or more Content Files to the Avalon dropbox.
An Ingest Package is the combination of content and metadata that make up a single batch.
The package must be uploaded somewhere within the
batch subdirectory of the Avalon dropbox. It can either be at the root of the batch directory, or in any subdirectory thereof. The following is a very simple Package that has been uploaded:
Manifest File Format
The manifest file is a spreadsheet (
ods) containing the metadata for the objects to be created, as well as the names of the content files that make up each object. In this case, the manifest file is named
|1||Michael's First Test Batchfirstname.lastname@example.org|
|2||Main Title||Creator||Date Created|
|3||Test Object 1||Klein, Michael B.||2012||content/file_1.mp3||content/file_2.mp4|
|4||Test Object 2||Northwestern||1951||content/file_3.mp4|
Row 1, Column A contains a reference name for the batch.
Row 1, Column B contains the submitter's email address (to be used for notifications and exceptions).
Row 2 specifies the names of the metadata fields supplied in the following rows. Main Title, Creator, and Date Created are required. Each subsequent row represents a single MediaObject to be created. Metadata values are specified first, followed by a list of content files to be attached to each object. (It is important that the content file columns not have headers, or they will be misinterpreted as metadata.) Content filenames are relative to the location of the manifest file itself.
Multivalued fields are specified by multiple columns with the same header, e.g.:
|1||Michael's Second Test Batchemail@example.com|
|2||Main Title||Creator||Date Created||Topical Subject||Topical Subject|
|3||Nachos: A Memoir||Klein, Michael B.||2012-12-22||Meat||Cheese||tasty_tasty_nachos.mp4|
Supported Field Names (required fields in bold)
- Main Title
- Alternative Title
- Translated Title
- Uniform Title
- Statement of Responsibility
- Resource Type
- Place of Origin
- Date Created
- Date Issued
- Copyright Date
- Language Code
- Language Text
- Topical Subject
- Geographic Subject
- Temporal Subject
- Occupation Subject
- Person Subject
- Corporate Subject
- Family Subject
- Title Subject
- Related Item ID
In addition to the descriptive fields, there is one supported operational field, Publish (default: false) for which a value of "True" will cause the newly ingested media object to be published immediately after ingest.
The batch ingest process will verify that the package is complete (i.e., all content files specified in the manifest are present and not open by any other processes) before attempting to ingest it. If the package is incomplete, it will be skipped and returned to on a subsequent pass.