Field Details for the Spreadsheet Ingest

Last Updated, April 29, 2024.

 

Included below are details on the accepted values for each field within the spreadsheet ingest template and details on what and when delimiters and sub-delimiters can be utilized. For details on how to populate the spreadsheet, we recommend viewing the Spreadsheet Ingest Templates available from the CTDA Support Center.

For more detailed examples see CTDA Spreadsheet Ingest Templates

 

 

 

Field Details

Field NameRequired FieldValidated FieldDelimiters AllowedSubdelimiters AllowedField Details
ID*YesYesNANAAlways start with one and number consecutively to the last row of the spreadsheet which includes metadata for ingest.
member_of NoNANARefers to number in the ID column. Used to identify parent repository item for a new repository item when its parent is being ingested at the same time.
member_of_existing_entity_id NoNANAUse the Drupal NODE ID of the parent repository item when ingesting additional repository items to a repository item that is already in the system Use EITHER columns A & B OR Columns B & C OR Columns A & C but NEVER ALL THREE. 
publish*YesYesNANADefaults to 'Y'. Value must be either 'Y' or 'N' to set the object as published (Y) or not published (N) on ingest.
model*YesYesNANA

This is the "Content Type" that defines the behaviors, derivatives, and viewers of the repository item. Accepted values include:

Audio
Binary
Collection
Compound
Digital Document
Image
Newspaper
Page
Paged Content
Publication Issue
Video

held_by*YesYesNANAThis is the name of the owning organization for this object. The name of the organization must be in the system for this to field to be valid. Can verify the name using the Add Content form which includes a drop down menu for this field.
title*YesYes^^|

This required field needs just a title entered but if you have additonal titles, want to have non-sort titles, and other additions to your record for the object you are ingesting, the following syntax should be utilized.

title
title type

Available values for title types:
alternative
translated
uniform
abbreviated

title supplied

Available values for field supplied:
yes

no

title non sort
title part name
title part number
title subtitle

Syntax for this field in the spreadsheet is: 
field_title|title_type|title_supplied|title_non_sort|title_part_name|title_part_number|title_subtitle

Example: My title|alternative|yes|The|this is a title part name|this is a title part number|this is a title subtitle

Example with 2 titles:
CTDA TEST - Monthly record, 1936-11||yes|The|a monthly journal devoted to the interests of the inmates of the Connecticut State Prison|||^^Monthly record (Connecticut State Prison (Somers, Conn.))|uniform|yes||||

rights_statement*YesYesNANA

Values in this column must one of the following based on rightsstatement.org. If you are created a collection utilize RIGHTS DETERMINED AT ITEM LEVEL.

COPYRIGHT NOT EVALUATED
COPYRIGHT UNDETERMINED
IN COPYRIGHT
IN COPYRIGHT - EU ORPHANED WORK
IN COPYRIGHT - RIGHTS-HOLDER(S) UNLOCATABLE OR UNIDENTIFIABLE
NO COPYRIGHT - CONTRACTUAL RESTRICTIONS
NO COPYRIGHT - OTHER KNOWN LEGAL RESTRICTIONS
NO COPYRIGHT - UNITED STATES
NO KNOWN COPYRIGHT
RIGHTS DETERMINED AT ITEM LEVEL

digital_fileNoNoNANAPath to the file to be ingested. Required for: Audio, Binary, Image, Page, and Video models.

Example of a file for the Woodbury Public Library to be ingested in this field would be as follows:
/opt/ingest_data/uploads/1/postcards/postcard_woodbury_1939_front.JPG
media_useNoYesNANA

Indicates the use of the media in the system. Reqiuired  for: Audio, Binary, Image, Page, and Video models. Original File is the option most frequently used as it enables derivatives to be generated upon ingest. Options include:

Extracted Text
Intermediate File
Original File
Preservation Master File
Service File
Thumbnail Image
Transcript

digital_originNoYesNANA

Valid values include:

None
born digital
reformatted digital
digitized microfilm
digitized other analog

use_and_reproductionNoNoNANAText description of the use and reproduction for the object.
creative_commonsNoYesNANA

Must be one of the following terms for Creative Commons licenses:

Attribution 4.0 International (CC BY 4.0)
Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
Attribution-NonCommercial-NoDerivatives 4.0 International (CC BY-NC-ND 4.0)
Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)
Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)

resource_typeNoYesNANA

The following values are valid for this field:

Artifact
Audio
Audio musical
Audio non-musical
Book
Cartographic
Collection
Dataset
Digital
Manuscript
Mixed material
Moving image
Multimedia
Notated music
Photograph
Software
Still image
Tactile
Text
Unspecified

descriptionNoNoNANAA narrative description of the item. NO HTML code can be included in the description.
local_identifierNoNo^^NAExample: 425objectIdentifier789^^MyObjectInventoryNumber2347891
personsNoNo^^|keys:
- name
- role
An agent, e.g. person or organization, with a specific relationship to the item being catalogued. The 'name' is a new or existing name in the 'Persons' taxonomy^^ the 'role' must be one of the available roles and to assign this role, you will use the abbreviation. When entering this in the spreadsheet it will be the name followed by the pipe (|) then type relators: and then add the abbreviation for the role.

Example: Husky, Jonathan as a Creator would be Husky, Jonathan|relators:cre

Example with multiple person entries: Husky, Jonathan|relators:cre^^Dan, Handsome|relators:ctb

The list of available values for roles are included in the Validation List (do not edit) sheet within the Spreadsheet Ingest template.
organizationsNoNo^^|keys:
- name
- role
An agent, e.g. person or organization, with a specific relationship to the item being catalogued. The 'name' is a new or existing name in the 'Persons' taxonomy^^ the 'role' must be one of the available roles and to assign this role, you will use the abbreviation. When entering this in the spreadsheet it will be the name followed by the pipe (|) then type relators: and then add the abbreviation for the role.

The list of available values for roles are included in the Validation List (do not edit) sheet within the Spreadsheet Ingest template.
languageNoNo^^NATerm(s) in the 'Language' taxonomy. (Can be existing or new terms)
genreNoNo^^NATerm(s) in the 'Genre' taxonomy (Can be existing or new terms)
subjectNoNo^^|Term(s) in the 'Subject' taxonomy. (Can be existing or new terms)
temporal_subjectNoNo^^NATerm(s) in the 'Temporal' taxonomy. (Can be existing or new terms)
geographic_subjectNoNo^^NATerm(s) in the 'Geographic' taxonomy. (Can be existing or new terms)
coordinatesNoNo^^|Enter either in decimal (51.47879) or sexagesimal format (51° 28' 43.644"). For subdelimited pieces use the following mapping: latitude|longitude
origin_informationNoNo^^|The sequence of subfields is as follows (use a pipe | with no spaces to populate the subfields correctly:

event_type|place|date_created|date_issued|date_captured|date_valid| date_modified|other_date|copyright_date|publisher|edition|issuance|frequency

All 'date' fields must be EDTF. Valid values for 'issuance' are: monographic single unit multipart monograph continuing serial integrating resource.

Example of this field being populated for an object in Storrs, CT created in 2023 with a publisher of the University of Connecticut and is an issuance of monograph would be as follows:
|Storrs, CT|2023|||||||University of Connecticut||monographic

Example where I have an object that was created on October 5, 1903 and was digitized on May 1, 2023 would be as follows:
||1903-10-05||2023-05-01
extentNoNo^^NASize or duration of a resource
notesNoNo^^|

keys:
- note_type
- note

Valid values for note_type:

acquisition
action
additional physical form
bibliography
biographical/historical
creation/production credits
date/sequential designation
exhibitions
funding
language
numbering
original location
ownership
performers
preferred citation
provenance
publications
reproduction
statement of responsibility
system details
thesis
venue
version identification
local
source note

family_nameNoNo^^|keys:
- name
- role
An agent, e.g. person or organization, with a specific relationship to the item being catalogued. The 'name' is a new or existing name in the 'Persons' taxonomy^^ the 'role' must be one of the available roles and to assign this role, you will use the abbreviation. When entering this in the spreadsheet it will be the name followed by the pipe (|) then type relators: and then add the abbreviation for the role.

The list of available values for roles are included in the Validation List (do not edit) sheet within the Spreadsheet Ingest template.
location_urlNoNoNANAThis field can only include one URL.
record_informationNoNo^^|The sequence of subfields is as follows (use a pipe | with no spaces to populate the subfields correctly:
record_content_source|record_creation_date|record_change_date|record_identifier|record_origin |record_information_note|record_cataloging_language|description_standard

Note: 'record_creation_date' and 'record_change_date' must be EDTF format. 'record_cataloging_language' is an existing Term in the 'Language' Taxonomy.

Example where you have a record creation date and a record identifier you want to populate it would be entered as follows:
|2023-12-15||1234arc94
scaleNoNoNANA 
kingdom_dwrNoNoNANA 
phylum_dwrNoNoNANA 
class_dwrNoNoNANA 
order_dwrNoNoNANA 
family_dwrNoNoNANA 
genus_dwrNoNoNANA 
sci_name_auth_dwrNoNoNANA 
locality_dwrNoNoNANA 
location_remarks_dwrNoNoNANA 
recorded_by_dwrNoNoNANA 
degree_nameNoNoNANA 
degree_levelNoNoNANA 
degree_disciplineNoNoNANA 
west_bounding_coordinateNoNoNA|Subdelimiter: '|' Enter either in decimal (51.47879) or sexagesimal format (51° 28' 43.644"). Each value's subdelimited pieces use the following mapping: latitude|longitude
east_bounding_coordinateNoNoNA|Subdelimiter: '|' Enter either in decimal (51.47879) or sexagesimal format (51° 28' 43.644"). Each value's subdelimited pieces use the following mapping: latitude|longitude
north_bounding_coordinateNoNoNA|Subdelimiter: '|' Enter either in decimal (51.47879) or sexagesimal format (51° 28' 43.644"). Each value's subdelimited pieces use the following mapping: latitude|longitude
south_bounding_coordinateNoNoNA|Subdelimiter: '|' Enter either in decimal (51.47879) or sexagesimal format (51° 28' 43.644"). Each value's subdelimited pieces use the following mapping: latitude|longitude
creative_commonsNoYesNANATerm in the 'Creative Commons Licenses 4.0' Taxonomy