Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

What this does

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.

...

Multiexcerpt include
MultiExcerptNameBatch ingest general instructions
PageWithExcerptBatch ingest simple assets

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

...

Code Block
titleSample 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.

...

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

Manifest Arguments

Refer to Anatomy of DAMS digital assets and Content models for a list of allowed/expected datastreams per content model. Consult with the DAMS Management Team for use cases not covered by the datastreams listed in this documentation.

Warning

DO NOT use any of the Restricted Datastream IDs.

Manifest generator script

Multiexcerpt include
MultiExcerptNamedatastreams generator script
PageWithExcerptDAMS datastreams.txt generator

Sample manifests

Code Block
languagetext
titleSample generic 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
COMPONENT2==componentfile2.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!
MEDIAPHOTOGRAPH==anymediaphotographfile.ext 
# optional, can be used for images documenting physical media, cases, covers, etc.; use MEDIAPHOTOGRAPH if there is one image only
MEDIAPHOTOGRAPH1==anymediaphotographfile.ext
MEDIAPHOTOGRAPH2==anymediaphotographfile.ext
# optional, can be used for images documenting physical media, cases, covers, etc.; increment for multiple images documenting the physical carrier(s)

...

Code Block
languagetext
titleSample datastreams.txt manifest file for audio content
OBJ==audiofile.wav
MODS==metadata.xml
# optional, if no MODS file is included, minimal metadata is automatically generated during ingest
TRANSCRIPT==audiotranscript.txt
# Textual representation of linguistic content in audio and video assets. REQUIRED for audio assets to be publishable. Transcripts MUST be in plain text.
PROXY_MP4==audioderivative.mp4
# optional; audio content can be provided as streaming media, which adds a limited technical hurdle against a simple download of a complete MP3 audio file. If you prefer to deliver audio content as streaming media, you need to externally create an MP4 derivative and ingest it into a datastream labeled PROXY_MP4.

...

Code Block
languagetext
titleSample datastreams.txt manifest file for video content
OBJ==videofile.mpg
MODS==metadata.xml
# optional, if no MODS file is included, minimal metadata is automatically generated during ingest
CAPTIONS==videocaptions.vtt
# Timed textual representation of linguistic content in audio and video assets. REQUIRED for video assets to be publishable. Captions MUST be provided in WebVTT format.
TRANSCRIPT==audiotranscript.txt
# optional; textual representation of linguistic content in audio and video assets. Transcripts MUST be in plain text.

Step 3: Upload batch job to Jscape

Multiexcerpt include
MultiExcerptNameBatch ingest upload
PageWithExcerptBatch ingest simple assets

Step 4: Set up collection and submit form in DAMS interface

Multiexcerpt include
MultiExcerptNamebatch ingest queue
PageWithExcerptBatch ingest simple assets