Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Tiered Ingest allows you to group all of the files corresponding to a simple asset's datastreams (including archival files, publication files, other derivatives created outside of Islandora, with the exception of RELS-EXT) into a sub-directory.

When ingesting derivative files, with this method, they may be overwritten by the DAMS software.

This tiered batch ingest method is NOT suitable for paged content (complex/compound assets with children). See Batch ingest complex assets (paged content) for instructions on how to ingest assets comprised of multiple pages.

The tiered ingest allows you to store additional files with a digital asset, and you can use this method to ingest externally created derivative datastreams (e.g. for streaming audio). See Content models for a breakdown of the expected datastreams per content model, and for information which datastreams can be published to e.g. the Collections Portal.

General information for batch ingest

The batch ingest process runs continuously, looking for newly queued batch jobs approximately every 5 minutes. You can add batch ingest jobs to the queue at any time.

Batch jobs are subject to the following batch job size and file size limitations:

  • max. 100GB/batch job
  • max. 10GB/file

Step 1: Stage files for batch ingest job

Organise files in a batch job folder, using subfolders if appropriate. Refer to the instructions/options listed below for preparing batch jobs.

Staging folder structure

  • All of the files you are ingesting as part of one asset will be staged in one directory per asset, as a sub-directory of a batch job folder.
  • Each sub-directory corresponds to one asset and must contain at least a manifest file for the key datastreams (datastreams.txt).
  • The batch job folder can contain just one asset folder, but would still need the extra nesting

Sample folder structure

eid1234_example-batch-submission/ (batch job folder)
├── asset1/
│   ├── datastreams.txt
│   ├── modsfile.xml
│	├── primaryfile.tif
│	├── anyarbitraryderivativefile.ext
│	├── anyarbitrarycomponentfile.ext
│   └── anymediaphotographfile.ext
├── asset2_audio_example/
│   ├── datastreams.txt
│   ├── modsfile.xml
│   ├── audiofile.wav
│   ├── derivative_audiofile_for_streaming.mp4 (e.g. for creating PROXY_MP4 datastream, which is required for streaming audio)
│   └── audio_transcript.txt
└──	asset3_video_example/
    ├── datastreams.txt
    ├── modsfile.xml
    ├── videofile.mp4
    ├── video_captions.vtt
    └── video_transcript.txt
    └── page02_custom_ocr.txt

Step 2: Create datastreams.txt manifest



Subdirectories in the batch job folder MUST each contain a manifest file named datastreams.txt. The manifest file specifies the intended structure of the DAMS asset, for instance pointing to the MODS XML containing the metadata for the asset, or specifying which additional datastreams should be created from staged files.

Each line of the manifest file contains an argument-value pair in the following format:

<ARGUMENT>==<VALUE> 

Use 2 (two) equal signs to separate arguments and values.

{ "errors": [ { "status": 404, "code": "NOT_FOUND", "title": "Not Found", "detail": null } ] }

If you're experiencing issues please see our Troubleshooting Guide.


Sample datastreams.txt manifest file
OBJ==primaryfile.ext
MODS==metadata.xml
# optional, if no MODS file is included, minimal metadata is automatically generated during ingest
PDF==custom.pdf
# optional
ARCHIVAL_FILE==originalversionof_primaryfile.ext
# optional, use for archival file (e.g. uncropped scan)
COMPONENT1==componentfile1.ext
# optional, can for instance be used in cases where a primary image is stitched from multiple component images; increment for additional files in same directory
# DO NOT use for complex objects that can be modeled as paged content or Islandora component assets!
MEDIAPHOTOGRAPH1==anymediaphotographfile.ext 
# optional, can be used for images documenting physical media, cases, covers, etc.; increment for additional files in same directory
DERIVATIVE1==anyarbitraryderivativefile.ext 
# optional, use for derivative files with direct descendant relationship from file designated OBJ; increment for additional in same directory
# CAUTION, do not duplicate derivative files that are automatically generated by the DAMS

Manifest Arguments

The manifest may contain instructions to create the following datastreams. Refer to Anatomy of DAMS digital assets and Content models for a list of allowed/expected datastreams per content model.

DO NOT use any of the Restricted Datastream IDs.

<ARGUMENT>Value AssociatedPurposeAccepted File TypesAdditional Notes
MODSMODS XML file nameprovide MODS metadata for an assetxmlCan be used for publication/series-level assets, book and issue-level assets.
TNthumbnail image file nameprovide a thumbnail picture for an assetpng, jpg, jpeg

Can be used for publication/series-level assets, book and issue-level assets.

If no thumbnail is provided during batch ingest, the DAMS will copy the thumbnail image of the first page of the asset to the book/issue level asset.

FULL_TEXT_CUSTOMname of text file with externally created full text (text extracted from PDF)allows you to provide your own FULL_TEXT datastream for a book/issuetxt

Can be used for book/issue-level assets.

Use only for assets where the primary source file is a PDF document and for full text produced with pdftotext. See page _Text extraction in DAMS for details on the different text extraction/recognition methods.

PDFname of your pdf filePDF for resourcepdf

Can be used for book/issue-level assets.

Use to add an externally created PDF document to an asset.

If no page images are specified in the manifest, the DAMS will render image files from the pages of the PDF document and use these images to create page-level assets.

For digitally reformatted (scanned) content, using a PDF as a source for creating page images is strongly discouraged, as the automatically created page images are almost invariably of lower quality than the original scan images. Contact the DAMS managers for a consultation (click here to submit a DAMS service request).

For born-digital content (for instance modern PDF ebooks or PDF documents directly exported from a word processor), other content models and ingest processes will be more appropriate. Contact the DAMS managers for a consultation (click here to submit a DAMS service request).


OBJ==primaryfile.ext [designation of primary file is at digital stewardship staff discretion, in consultation with requesting content holder]

DERIVATIVE1==anyarbitraryderivativefile.ext [use for derivative file with direct descendant relationship from file designated OBJ; increment for additional in same directory]

COMPONENT1==anyarbitrarycomponentfile.ext [use for cases such as a file comprising one piece of a stitched OBJ or one page image in a pdf OBJ; increment for additional in same directory]

MEDIAPHOTOGRAPH1==anymediaphotographfile.ext [use for images documenting physical media, cases, covers, etc.; increment for additional in same directory]

MODS==metadata.xml   [use for optional included metadata file, if not included then very minimal mods will be added]

Notes:  

  • [text] should not be included in datastreams.txt file, used above for explanatory purposes only.
  • Additions beyond the standard datastream IDs shown above are allowed.  Consult with DAMS Management Team for recommendations. 


Example Ingest:

User1 in Architecture has a collection and needs to ingest their media with extra datastreams

they use ftp to upload their files to the server in a directory called batch1


fill out form as follows:

>>> Architectural Collections

Enter identifer of sub-collection that will contain your batch of assets >>> utlarch:5a4f464a-b4d5-4dd7-b2c2-4562643ac1bd
  >>> batch1



  • No labels