Importing works via Bulk Import (CSV parser)

Importing works via Bulk Import (CSV parser)

The Bulkrax importer will create works in Hyku based on a CSV file.

  • If you upload a CSV file alone, works will be created as metadata-only records. The item column should be omitted in this case.

  • If you upload a ZIP file containing both a CSV and a files folder, works will be created with associated files.

    • The CSV and files folder must be directly inside the ZIP file.

    • Do not place them inside another folder before zipping.

Correct: ZIP contains the CSV and files folder at the top level
Incorrect: ZIP contains a folder, and that folder contains the CSV and files


Running an Import

  1. Go to Dashboard → Importers

  2. Click New

  3. Fill out the importer form:

    • Name

    • Administrative Set

    • Frequency

    • Limit

    • Parser (choose CSV)

    • Visibility (default: Public)

    • Rights Statement (optional default or override)

    • Upload the CSV file

  4. Choose one of the following:

    • Upload CSV only for metadata-only import (omit item column)

    • Upload a ZIP file with CSV + files folder for metadata + files import

  5. Click Create and Import


Administrative Fields

The following columns in the CSV control how the importer behaves:

  • item – the name of a file from the files folder (e.g. file.jpg)

  • source_identifier – a persistent identifier for the work when referenced within the importer dashboard; re-using the same identifier will overwrite the work

  • model – the worktype (e.g. GenericWork, Image, Oer, Etd, FileSet, Collection). Capitalization matters in this field.

  • parents – optional; establishes relationships with other works or collections. For example, to add works to a collection, supply the collection’s ID number in the parents column for that work. You can find the ID through export or, in a default installation, in the work or collection's URL (e.g., cd58772b-f631-4c3c-8d4f-b3fc3bc00d0f).


Required Metadata

Which fields are required is set up according to your settings. Any required fields must contain entries in the csv or the import will fail to import that work. All worktypes require:

  • title

  • creator

  • rights statement

Multiple values can be entered with a pipe (|) separator.
Controlled vocabularies (Rights Statements, Licenses, Resource Types) must use the values listed.


OER Worktype

OER works require additional fields, though this is configurable:

  • Audience – Student, Instructor, or Administrator

  • Education Level – options such as graduate / professional or adult education

  • Learning Resource Type – options such as Activity/lab, Lecture, or Textbook

  • Discipline – from the discipline list

Optional OER fields include:

  • oer size, table of contents, rights holder

  • accessibility features, accessibility hazards, accessibility summary

  • previous/newer/alternate/related version references


ETD Worktype

ETDs require additional fields, though this is configurable:

  • Degree – e.g. Masters in Operations Research

  • Level – e.g. Undergraduate, Masters, Doctoral

  • Discipline – e.g. History

  • Grantor – the awarding institution

Optional ETD fields include:

  • format (MIME type), advisor, committee member, department