Ingest

Introduction

MD Import Profile

Metadata files

Each ingest must contain at least one metadata file and the files which are meant to be ingested into Alma. Records in the metadata files are matched or created in Alma in accordance with the configuration of the MD import profile. The expected metadata filename pattern is also set in the MD import profile configuration. Note that UTF-8 encoding is expected for all schemata.

XML Format

For Dublin Core, the following conventions are used:

• dc.xml file may contain a single DC record in a <record> tag, or one or more DC records wrapped by a <collection> tag.
• If a single dc.xml file with a single DC record is provided and the file order is of no importance, the files do not need to be referenced. Any files found in the folder will be added to the matched or created BIB.
• If a single dc.xml file with a single DC record is provided and the file order is of importance, files should be referenced using the dc:identifier property and a file:// prefix. File order will be preserved.
• If multiple DC records are provided, the files may be enumerated in the metadata, using the dc:identifier property and a file:// prefix. Alternatively, a “streams” attribute can be added to the <record> tag, with the folder containing the files for the given record. The streams folder(s) should be in the same folder as the metadata file.

<?xml version="1.0" encoding="UTF-8" ?>
<collection xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/1.1/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://purl.org/dc/terms/1.1/ http://dublincore.org/schemas/xmls/qdc/2008/02/11/dcterms.xsd http://purl.org/dc/elements/1.1/ http://dublincore.org/schemas/xmls/qdc/2008/02/11/dc.xsd">
    <record streams="">
        <dc:title>Towards paperless information systems</dc:title>
        <dc:creator>Lancaster, Frederick Wilfrid</dc:creator>
        <dc:subject>Information Transfer and Management</dc:subject>
        <dc:subject>theology</dc:subject>
        <dc:description>179 pp.</dc:description>
        <dc:publisher>New York, NY : Academic Press</dc:publisher>
        <dc:date>1978</dc:date>
        <dc:type>Text</dc:type>
        <dc:identifier>file://paperless.pdf</dc:identifier>
        <dc:language>eng</dc:language>
    </record>
        <record>
        <dc:title>Special Collections at the Cusp of the Digital Age: A Credo</dc:title>
        <dc:creator>Lynch, Clifford A.</dc:creator>
        <dc:description>Research Library Issues, no. 267</dc:description>
        <dc:publisher>Association of Research Libraries</dc:publisher>
        <dc:date>December 2009</dc:date>
        <dc:type>Text</dc:type>
        <dc:identifier>file://lynch.pdf</dc:identifier>
        <dc:language>eng</dc:language>
        <dcterms:bibliographicCitation>Clifford A. Lynch, “Special Collections at the Cusp of the Digital Age: A Credo,” Research Library Issues, no. 267 (December 2009).</dcterms:bibliographicCitation>
    </record>
</collection>

For MARCXML, the following conventions are used:

• A single MARC record in a <record> tag, or one or more MARC records wrapped by a <collection> tag.
• If a single MARCXML file with a single MARC record is provided, the files do not need to be referenced. Any files found in the folder will be added to the matched or created BIB. The following MARCXML file will create a BIB with all files found in the folder:

  <?xml version="1.0" encoding="UTF-8" ?>
  <collection>
     <record>
        <leader>     aas          a     </leader>
        <datafield tag="100" ind1="1" ind2=" ">
          <subfield code="a">AUTHOR</subfield>
        </datafield>
        <datafield tag="245" ind1="1" ind2="2">
          <subfield code="a">TITLE</subfield>
        </datafield>
        <datafield tag="260" ind1=" " ind2=" ">
          <subfield code="c">DATE</subfield>
        </datafield>
     </record>
   </collection>

• If multiple MARC records are provided, the files may be enumerated in the metadata. The field and subfield can be configured in the MD import profile configuration. For example:

  <collection>
     <record>
        <leader>     aas          a     </leader>
        <datafield tag="100" ind1="1" ind2=" ">
          <subfield code="a">AUTHOR1</subfield>
        </datafield>
        <datafield tag="245" ind1="1" ind2="2">
          <subfield code="a">TITLE1</subfield>
        </datafield>
        <datafield tag="260" ind1=" " ind2=" ">
          <subfield code="c">DATE1</subfield>
        </datafield>
        <datafield tag="856" ind1=" " ind2=" ">
          <subfield code="u">TITLE1/image.jpg</subfield>
        </datafield>
     </record>
  <record>
        <leader>     aas          a     </leader>
        <datafield tag="100" ind1="1" ind2=" ">
          <subfield code="a">AUTHOR2</subfield>
        </datafield>
        <datafield tag="245" ind1="1" ind2="2">
          <subfield code="a">TITLE2</subfield>
        </datafield>
        <datafield tag="260" ind1=" " ind2=" ">
          <subfield code="c">DATE2</subfield>
        </datafield>
        <datafield tag="856" ind1=" " ind2=" ">
          <subfield code="u">TITLE2/image.jpg</subfield>
        </datafield>
     </record>
   </collection>

Alternatively, a “streams” attribute can be added to the <record> tag, with the folder containing the files for the given record. The streams folder(s) should be in the same folder as the metadata file.

For MODS (v3.0 and higher), the following conventions are used:

• mods.xml file may contain a single MODS record in a <mods:mods> tag, or one or more DC records wrapped by a <mods:modsCollection> tag.
• If a single mods.xml file with a single MODS record is provided and the file order is of no importance, the files do not need to be referenced. Any files found in the folder will be added to the matched or created BIB.
• If a single mods.xml file with a single MODS record is provided and the file order is of importance, files may be referenced in the location/url element (file order will be preserved). Alternatively, a “streams” attribute can be added to the <record> tag, with the folder containing the files for the given record. The streams folder(s) should be in the same folder as the metadata file.
• If multiple MODS records are provided, the files must be enumerated in the metadata, using the location/url element.
  The access=”raw object” attribute may be used.File labels taken from the ‘displayLabel’ attribute of the respective location/url.

<?xml version="1.0" encoding="UTF-8"?>
<modsCollection xmlns="http://www.loc.gov/mods/v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-7.xsd" version="3.7">
	<mods>
		<titleInfo>
			<nonSort xml:space="preserve">Das </nonSort>
			<title>Lied von der Erde</title>
		</titleInfo>
		<titleInfo type="alternative">
			<title>Song of the earth</title>
		</titleInfo>
		<name type="personal" usage="primary" nameTitleGroup="1">
			<namePart>Mahler, Gustav</namePart>
			<namePart type="date">1860-1911</namePart>
		</name>
		<name type="personal">
			<namePart>Forrester, Maureen.</namePart>  <namePart type="date">1930-2010</namePart>
		</name>
		<name type="personal">
			<namePart>Lewis, Richard</namePart>
			<namePart type="date">1914-1990</namePart>
		</name>
		<name type="personal">
			<namePart>Szell, George</namePart>
			<namePart type="date">1897-1970</namePart>
		</name>
		<name type="corporate">
			<namePart>Cleveland Orchestra</namePart>
		</name>
		<typeOfResource>sound recording-musical</typeOfResource>
		<language>
			<languageTerm type="code" authority="iso639-2b">eng</languageTerm>
		</language>
		<language>
			<languageTerm type="code" authority="iso639-2b">und</languageTerm>
		</language>
		<note>Maureen Forrester, contralto; Richard Lewis, tenor; Cleveland Orchestra; George Szell, conductor.</note>
		<note>Sung in German.</note>
		<note>Playable also on monaural equipment.</note>
		<subject authority="lcsh">
			<topic>Song cycles</topic>
		</subject>
		<subject authority="lcsh">
			<topic>Songs (Low voice) with orchestra</topic>
		</subject>
		<subject authority="lcsh">
			<topic>Songs (High voice) with orchestra</topic>
		</subject>
		<location>
			<url displayLabel="I. Das Trinklied von Jammer der Erder">Das Trinklied von Jammer der Erder.mp3</url>
			<url displayLabel="II. Der Einsame im Herbst">Der Einsame im Herbst.mp3</url>
			<url displayLabel="III. Von der Jugend">Von der Jugend.mp3</url>
			<url displayLabel="IV. Von der Schönheit">Von der Schönheit.mp3</url>
			<url displayLabel="V. Der Trunkene in Frühling">Der Trunkene in Frühling.mp3</url>
			<url displayLabel="VI. Der Abschied">Der Abschied.mp3</url>
		</location>
	</mods>
</modsCollection>

CSV Format

A CSV file can be submitted, and its columns will be mapped by Alma to Dublin Core or MARC, depending on the configured target format in the MD Import Profile (CSV-MODS mapping is currently not supported). The following table lists the supported fields and how they are mapped.

All fields are optional, expect where otherwise noted.

Only one CSV file per ingest should be submitted. A CSV template is available for downloading from here.

Each ingest is prepared in a separate folder. The directory structure for ingest folders is as follows:

INSTITUTION_CODE/upload/MD_IMPORT_PROFILE_ID/INGEST_ID

• INSTITUTION_CODE: The code of the institution, for example 01UNI_INST
• upload: Hardcoded for the upload folder
• MD_IMPORT_PROFILE_ID: The ID of the relevant MD import profile. Can be retrieved from the Import Profile UI (by clicking the ‘i’ icon in the upper right corner of the screen) or by using the MD Import Profile List API (see above)
• INGEST_ID: A random unique identifier for the ingest. This folder name has no significance

Alma will process files in any subfolder within the ingest folder, but the metadata file must be in the root of the ingest folder.

While preparing the ingest, a .lock file should be placed in the root of the ingest folder. This will indicate to Alma that the ingest is not ready to be processed. When ready, the .lock file should be removed. The next time the MD import job is run, the ingest will be processed by Alma.

upload/991234567890/abcd-efgh-ijkl-mnop/myfile.doc

upload/991234567890/abcd-efgh-ijkl-mnop/myfile.doc.thumb

upload/991234567890/abcd-efgh-ijkl-mnop/data/myfile.ppt

upload/991234567890/abcd-efgh-ijkl-mnop/data/myfile.ppt.thumb