User Tools

Site Tools


Adding new collections to Credo

Adding new collections to Credo is a multiple step process and each step is necessary to ensure that the collection is properly represented in Credo's collection hierarchy and that our collections play well with Digital Commonwealth and the DPLA.

1. Add <relatedItem> to MODS records

For an individual item in Credo to be part of a collection, it needs to have a MODS <relatedItem> element pointing to that collection. You can find more information about <relatedItem> use in SCUA's Best Practices for MODS. Here's an example:

<mods:relatedItem type="host">
     <mods:title>W. E. B. Du Bois Papers</mods:title>
  <mods:typeOfResource>mixed material</mods:typeOfResource>
  <mods:identifier type="local">MS 312</mods:identifier>
  <mods:identifier type="uri">mums312</mods:identifier>

The three requirements for the item to be properly attached to its collection are 1) the @type=“host” in <mods:relatedItem>, 2) the unique ID for the collection in <mods:identifier type=“uri”>, and 3) the title of the collection in <mods:title>. The title must be consistent across all records.

2. Create collection-level record in Credo

A collection-level record in Credo creates a page like this for each collection, The collection page is generated from an EAD/XML finding aid, placed at the top-level of a directory on oubliette. The name of the file must have the following structure:


For example, collection_mums312.xml in the mums312 directory in oubliette will be used to generate the HTML for the mums312 collection page. In most cases, all you need to do is copy the collection's existing EAD finding aid and rename accordingly. To link to the full finding aid, add <otherfindaid><extref href=”[collID]”>[Coll name]</extref></otherfindaid> to <archdesc>.

:!: Do not add a collection-level record to the ingest folder. Ingesting these records will wreak unfortunate havoc on Credo. It's enough to simply name the file correctly and add it to the collection top-level folder. It might take some time for a new collection record to appear but it should show up after an ingest (but again, these files don't need to be ingested!)

If you want to add a collection page for a collection that does not yet have a full finding aid, it's easy enough to create a stub EAD record using the information in UMarmot. For a good example of a stub collection-level record, look at collection_mums700.xml on oubliette.

3. Update collection map

The collection map file helps sort collections in Credo's browse view. You can find the file in the ingest folder named, collmap.txt. Each line of the file contains the display name of the collection followed by the name you want the collection to sort on in the browse view. Typically, this is the authorized form of the collection's primary provenance. Each name is wrapped in double quotes (”) and delimited by a colon (:), e.g.

“W. E. B. Du Bois Papers”:“Du Bois, W. E. B. (William Edward Burghardt), 1868-1963”

The line above will sort the collection under “D” for Du Bois but display the collection title, W. E. B. Du Bois Papers. Changes to this file usually take effect after ingest.

4. Add collection information to the OAI-PMH endpoint

This last step is critical for successful harvest by Digital Commonwealth and DPLA, which depend on the collections appearing in the OAI-PMH endpoint in a specific way in order to properly display the collection hierarchies in those systems.

In OAI-PMH, we represent collections as “Sets” and a complete listing of the collections each of our digital objects belong to can be viewed in the response to the OAI-PMH verb ListSets.

Here is a typical set entry:

  <setName>Frances and Mary Allen Collection of Photographs of Deerfield, 1900-1910</setName>
    <oai_dc:dc xmlns:dc="" xmlns:oai_dc=""    xmlns:xsi="" xsi:schemaLocation="">
Influenced by the arts and crafts movement, Frances and Mary Allen began taking photographs of their native Deerfield, Mass., in the mid-1880s. Displaying a finely honed pictorialist aesthetic, the sisters specialized in views of Deerfield and surrounding towns, posed genre scenes of life in colonial times, and the local scenery, earning a reputation as among the best women photographers of the period. The Allen sisters photograph album contains ten gelatin developing out prints of street scenes in Deerfield, ca.1900-1910. Among these are two shots of the house they inherited from their aunt Kate in 1895, which thereafter became their home and studio.

It is critical that the unique ID for the collection that appears in <mods:identifier type=“uri”> of each record in that collection matches the unqiue ID in <setSpec>. A <dc:description> is not required but strongly preferred. All set entries live in a single static XML file kept on the OAI-PMH server.

The server can be accessed via SFTP with the address:

user: localadminuser

Please ask Aaron R. for a password.

The file can be found at ~/solr/solr-5.2.1/server/solr/oai and is called ListSets.xml. Download this file and edit to add the new <set>. Once added, re-upload the edited file. In order for these changes to take effect, the OAI-PMH web server will need to be restarted. Please ask Aaron R. to restart the server. In Aaron R.'s absence, create a syshelp ticket in LibWire and Aaron A. will restart.

new_collections.txt · Last modified: 2019/01/07 12:22 (external edit)