Skip to content

CSV Exporter

Julie Hardesty edited this page Jul 11, 2025 · 11 revisions

Exporting

The Bulkrax exporter will use the same field mappings that were established in the import.

  • If the exporter is configured to export only metadata or works that have no attached files, a CSV alone will be generated
  • If the exporter is configured to export metadata and files, a zip file will be generated. Inside this zip file will be a csv with the metadata and a "files" folder. Inside the "files" folder are uniquely named files that correlate to the file_# values in the csv.

The exported CSV should look similar to the imported one (if this data was imported) with a few exceptions:

  • If we previously imported a CSV that had headers with multiple values that were (;) or (|) separated, they will now be numerated headers
  • If the works were imported with remote files (file_url_# or remote_files), those will now be listed under file_#

Include Generated Metadata

See how to configure generated metadata here.

Although configurable, the idea of this option is to export fields that are not set by a user, but is instead generated and set by the system. Export these configured fields by selecting the checkbox, include generated metadata?, in the exporter form.

Currently this setting is not capable of round tripping. This setting work for CSV exports only.

Include Thumbnails

If include_thumbnails? is checked on the exporter form, a user will see a thumbnail_file column in the exported CSV that references a file found in the files directory, of the exported zip.

Currently this setting is not capable of round tripping.

Round Tripping

(Export then Import)

The concept of round tripping is that we can export a CSV, then import the same CSV (or zip) without the files being duplicated, If data was changed on the re-imported CSV, like the title, that will be updated though.

To verify this we can export a CSV, then import that exported CSV and see that we have the same amount of works as before.

See Exporters User Interface for details on creating a new export.

Examples of updating via round trip:

  • the title of a work can be updated by changing the value on an exported work and then importing
  • an exported work can be added to a collection by adding the Hyrax identifier for the collection (from the URL path) to the parents column on the work and then importing
  • likewise, an exported work can be removed from a collection by removing the value from the parents column on that work (leaving it blank) and then importing

See Interacting with Metadata for more explanation and examples of updating via round trip.

If descriptive metadata on works is the only information being updated (no files are being updated and no collection information is being updated), remove all Collection rows and Fileset rows from the updated export before importing the CSV.

See Importers User Interface for details on creating a new import. The CSV file for the import can be this updated export CSV file.

Downloadable files

A download of the zip file that was created on export is accessible from the index and exporter show pages.

  • A CSV containing the applicable models, and their metadata, and files, if applicable, according to the exporter options.

Clone this wiki locally