Difference between revisions of "Resources/CSV templates"

From AtoM wiki
m (→‎AtoM 2.8 CSV templates)
 
(26 intermediate revisions by 4 users not shown)
Line 16: Line 16:
 
'''Page organization'''
 
'''Page organization'''
  
−
This page has been divided first by type - archival description or other CSV import type - and then by release.
+
This page has been divided first by type and then by release.
  
 
If there are no changes to the CSV templates for a major release, a link or section will not be included - you can then use the templates from the previous release. Be sure to review the CSV import documentation in the AtoM [https://accesstomemory.org/docs User manual] for your release.
 
If there are no changes to the CSV templates for a major release, a link or section will not be included - you can then use the templates from the previous release. Be sure to review the CSV import documentation in the AtoM [https://accesstomemory.org/docs User manual] for your release.
Line 25: Line 25:
  
 
At this time, we provide templates for the ISAD(G) and RAD descriptive templates in AtoM. If you are using a different content standard (e.g. DACS, DC, or MODS), we recommend using the ISAD(G) template and ignoring any fields that do not crosswalk. Information about crosswalk mappings can be found in the Data Entry / Templates section of the AtoM [https://accesstomemory.org/docs User manual.]
 
At this time, we provide templates for the ISAD(G) and RAD descriptive templates in AtoM. If you are using a different content standard (e.g. DACS, DC, or MODS), we recommend using the ISAD(G) template and ignoring any fields that do not crosswalk. Information about crosswalk mappings can be found in the Data Entry / Templates section of the AtoM [https://accesstomemory.org/docs User manual.]
 +
 +
===AtoM 2.8 CSV templates===
 +
 +
<admonition type="important">
 +
There have been '''no changes to the columns''' in these updated templates. Instead, the sample data has been updated to include references to the relevant standard element, and columns previously not included in the examples have been added. You can still use the 2.3 templates with AtoM 2.3, 2.4, 2.5, 2.6, 2.7, and 2.8  however!
 +
</admonition>
 +
 +
'''Change log'''
 +
 +
* Updated image URLs to point to valid images in CSVs. See issue [https://github.com/artefactual/atom/issues/1781 #1781]
 +
 +
<admonition type="seealso">
 +
See the 2.8 CSV import documentation [https://www.accesstomemory.org/docs/2.8/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_authority_records-2.8.csv|Authority Records 2.8 CSV template]]
 +
* [[media:example_information_objects_isad-2.8.csv|ISAD 2.8 CSV template]]
 +
* [[media:example_information_objects_rad-2.8.csv|RAD 2.8 CSV template]]
 +
 +
===AtoM 2.6 CSV templates===
 +
 +
<admonition type="important">
 +
There have been '''no changes to the columns''' in these updated templates. Instead, the sample data has been updated to include references to the relevant standard element, and columns previously not included in the examples have been added. You can still use the 2.3 templates with AtoM 2.3, 2.4, 2.5, and 2.6, however!
 +
</admonition>
 +
 +
'''Change log'''
 +
 +
* Added missing columns from examples - <code>accessionNumber</code> and <code>digitalObjectPath</code>. See issue #13300
 +
* Updated the example data to include references to the related standard element number wherever possible. See issue #10070
 +
 +
<admonition type="seealso">
 +
See the 2.6 CSV import documentation [https://www.accesstomemory.org/docs/2.6/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_information_objects_isad-2.6.csv|ISAD 2.6 CSV template]]
 +
* [[media:example_information_objects_rad-2.6.csv|RAD 2.6 CSV template]]
  
 
===AtoM 2.3 CSV templates===
 
===AtoM 2.3 CSV templates===
Line 99: Line 139:
 
* [[media:example_information_objects_rad-2.0.csv|RAD CSV template]]
 
* [[media:example_information_objects_rad-2.0.csv|RAD CSV template]]
  
 +
==Accessions==
  
−
==Accessions CSV templates==
+
===AtoM 2.6 CSV templates===
 +
 
 +
'''Change log'''
 +
* new <code>donorNotes</code> column added. See issue #12799
 +
* new <code>donorContactPerson</code> and <code>donorFax</code> columns added. See issue #13310
 +
* Alternative identifier support added to Accessions module. New columns added for <code>alternativeIdentifiers</code>, <code>alternativeIdentifierTypes</code>, and <code>alternativeIdentifierNotes</code>. These columns support the use of pipe <code>|</code> separators for multiple values in a row. See issue #13262
 +
* Physical storage linking now added to Accessions module. New columns added for <code>physicalStorageName</code>, <code>physicalStorageLocation</code>, and <code>physicalStorageType</code>. See issue #13268
 +
* Other changes to import behavior:
 +
** Previously, new terms in the <code>resourceType</code> or <code>acquisitionType</code> columns would trigger an error and halt the import. Now, they will be added to the related taxonomy
 +
** When a duplicate accessionNumber is encountered during an import, the console log will now include the accession number of the conflict for reference
 +
 
 +
<admonition type="seealso">
 +
See the 2.6 CSV import documentation [https://www.accesstomemory.org/docs/2.6/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 
 +
'''Templates'''
 +
 
 +
* [[media:example-accessions-2.6.csv|Accessions 2.6 CSV template]]
  
 
===AtoM 2.3 CSV templates===
 
===AtoM 2.3 CSV templates===
Line 160: Line 218:
 
* [[media:example_accessions-2.0.csv|Accession CSV template]]
 
* [[media:example_accessions-2.0.csv|Accession CSV template]]
  
 +
==Deaccession records==
 +
 +
Below you'll find copies of the CSV template examples for deaccession records, organized by each major release. A change log is included so that you can quickly determine what has changed. The ability to import deaccession records via CSV was first introduced in the AtoM [[Releases/Release announcements/Release 2.5|2.5 release]].
 +
 +
'''Templates'''
 +
 +
* [[media:example_deaccessions-2.5.csv|2.5 Deaccession CSV template]]
 +
 +
 +
==Authority records==
 +
 +
In AtoM, there are 2 CSV templates for importing authority records - a primary template, as well as one optional secondary template to add relationships between actors (the Relationships CSV).
 +
 +
<admonition type="see also">
 +
See the latest CSV import documentation [https://www.accesstomemory.org/docs/latest/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
===AtoM 2.6 CSV templates===
 +
 +
Prior to 2.6, alternative forms of name could only be imported via a separate CSV imported at the same time as new authority record data in the primary template, using the CSV import command-line task. We have overhauled the CSV import templates, merging the alias fields into the primary template, revising the relationships CSV, and adding support for importing relationships via the user interface. Users can also add relationships to existing authority records - previously, the relationships CSV could only be imported at the same time as new data in the primary authority record template, using the CSV import command-line task. We've also added the ability to link digital objects to authority records via CSV import and we fixed a bug where new entity types (or a mismatch in capitalization for existing entity types) would cause a CSV import to fail.
  
−
==Authority record CSV templates==
+
<admonition type="important">
 +
The alias CSV template has been '''deprecated''' and the relationships CSV has been significantly overhauled. Be sure to use the latest templates when importing data into a 2.6 AtoM installation!
 +
</admonition>
  
−
The AtoM authority record CSV templates have not changed since AtoM 2.0.0. The following CSV templates should work for any AtoM or ICA-AtoM release that supports CSV import.
+
'''Change log'''
 +
 
 +
* Deprecate the Aliases CSV template. Merge the alias CSV fields into the primary authority record CSV template - add new multi-value columns for <code>parallelNames</code>, <code>standardizedNames</code>, and <code>otherFormsOfName</code> to the primary authority record CSV template. See issue #13277
 +
* Include digital objects on CSV import and export templates. Since release 2.5 authority records can be linked to a digital object (e.g. a profile picture of the authority record subject). These can be imported on the CSV template using a local file path (<code>digitalObjectPath</code>) or an external URI (<code>digitalOjbectURI</code>). Any linked digital objects are included on CSV export as a URI to the AtoM path for the digital object. See issue #13249
 +
* Overhaul the Relationships CSV template. Rename <code>source</code> and <code>target</code> columns to <code>subjectAuthorizedFormOfName</code> and <code>objectAuthorizedFormOfName</code>. Replace <code>category</code> column with <code>relationType</code> and support use of bi-directional relationship terms (e.g. "controls" / "is controlled by") as values. See issue #13279
 +
* Allow the Relationships CSV to be used to add relationships between existing authority records. See issue #13280
 +
* Add support for importing relationships via the user interface. See issue #13286
 +
* Fix issue with new entity types or variations in capitalization for existing entity type names causing the import to fail. See issue #13295
 +
* Update the sample data in the authority record example template to reference related ISAAR-CPF standard element numbers wherever possible
 +
 
 +
'''Templates'''
 +
 
 +
* [[media:example_authority_records-2.6.csv|2.6 Authority record CSV template]]
 +
* [[media:example_authority_record_relationships-2.6.csv|2.6 Authority record relationships CSV template]]
  
 
<admonition type="see also">
 
<admonition type="see also">
−
See the 2.0 CSV import documentation [https://www.accesstomemory.org/docs/2.0/user-manual/import-export/csv-import/ here.]
+
See the 2.6 CSV import documentation [https://www.accesstomemory.org/docs/2.6/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 
 +
===AtoM 2.5 CSV template===
 +
 
 +
'''Change log'''
 +
 
 +
* Add 2 new fields to the actor CSV import template for <code>subjectAccessPoints</code> and <code>placeAccessPoints</code>. For more details, see issue #[https://projects.artefactual.com/issues/12647 12647].
 +
 
 +
'''Template'''
 +
 
 +
* [[media:example-authority-records-2.5.csv|2.5 Authority record CSV template]]
 +
 
 +
 
 +
===AtoM 2.4 CSV template===
 +
 
 +
'''Change log'''
 +
 
 +
* Add 2 new fields to the actor CSV import template for occupations data: <code>actorOccupations</code> and <code>actorOccupationNotes</code>. For more details, see issue #[https://projects.artefactual.com/issues/11081 11081].
 +
 
 +
'''Template'''
 +
 
 +
* [[media:example-authority-records-2.4.csv|2.4 Authority record CSV template]]
 +
 
 +
===AtoM 2.0 CSV templates===
 +
 
 +
The primary authority record template found below should work with all releases up to version 2.3. The Aliases and Relationships CSV templates should work for command-line imports on all versions of AtoM.
 +
 
 +
'''Templates'''
 +
 
 +
* [[media:example_authority_records-2.0.csv|2.0 Authority record CSV template]]
 +
* [[media:example_authority_record_aliases-2.0.csv|2.0 Authority record aliases CSV template]]
 +
* [[media:example_authority_record_relationships-2.0.csv|2.0 Authority record relationships CSV template]]
 +
 
 +
==Archival Institutions==
 +
 
 +
CSV import and export for archival institutions (aka repository records) was introduced in the 2.4 release.
 +
 
 +
<admonition type="important">
 +
There was a bug in the 2.4.0 release that prevented some fields from importing and exporting in the archival institution CSV. This has been fixed in the 2.4.1 bug fix release. For more details, see issue #[https://projects.artefactual.com/issues/10853 10853].
 +
</admonition>
 +
 
 +
'''Templates'''
 +
 
 +
* [[media:example-repositories-2.4.csv|Archival Institutions CSV template]]
 +
 
 +
<admonition type="see also">
 +
See the latest CSV import documentation [https://www.accesstomemory.org/docs/latest/user-manual/import-export/csv-import/ here.]
 
</admonition>
 
</admonition>
 +
 +
==Physical storage containers and locations==
 +
 +
The ability to import physical storage data was added to AtoM in the 2.6 release.
  
 
'''Templates'''
 
'''Templates'''
  
−
* [[media:example_authority_records-2.0.csv|Authority record CSV template]]
+
* [[media:example-physicalobject-2.6.csv|Physical storage CSV template]]
−
* [[media:example_authority_record_aliases-2.0.csv|Authority record aliases CSV template]]
 
−
* [[media:example_authority_record_relationships-2.0.csv|Authority record relationships CSV template]]
 
  
−
==Events CSV templates==
+
==Events==
  
 
The AtoM events CSV templates have not changed since AtoM 2.0.0. The following CSV templates should work for any AtoM or ICA-AtoM release that supports CSV import.
 
The AtoM events CSV templates have not changed since AtoM 2.0.0. The following CSV templates should work for any AtoM or ICA-AtoM release that supports CSV import.
  
 
<admonition type="see also">
 
<admonition type="see also">
−
See the 2.0 CSV import documentation [https://www.accesstomemory.org/docs/2.0/user-manual/import-export/csv-import/ here.]
+
See the latest CSV import documentation [https://www.accesstomemory.org/docs/latest/user-manual/import-export/csv-import/ here.]
 
</admonition>
 
</admonition>
  
Line 187: Line 329:
 
* [[media:example_events-2.0.csv|Events CSV template]]
 
* [[media:example_events-2.0.csv|Events CSV template]]
  
−
==Digital object CSV template==
+
==Digital objects==
  
 
It is possible to link digital objects to existing descriptions using a CSV template, but we do not provide an example template because the format is very simple. For further information, please see the relevant section in the CSV import documentation:
 
It is possible to link digital objects to existing descriptions using a CSV template, but we do not provide an example template because the format is very simple. For further information, please see the relevant section in the CSV import documentation:
  
−
* https://accesstomemory.org/docs/2.3/user-manual/import-export/csv-import/#load-digital-objects-via-the-command-line
+
* https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-import-export/#load-digital-objects-via-the-command-line
  
 
<br />
 
<br />

Latest revision as of 14:56, 17 May 2024

Main Page > Resources > Resources/CSV templates

On this page you will find copies of the CSV templates we provide for use when importing data into AtoM. As the CSV files change over versions, we will add sections, so that you can be sure you are using the right template for your AtoM installation.

For more information on CSV import, see the Import/Export section of our User manual. Links directly to each major release's CSV import documentation are included in the relevant sections below.

Tip

Did you know you can also find all the CSV import templates inside AtoM? They are located in lib/task/import/example.

See Also

Migrating data to AtoM? Check out the CSV transformation page for information on transformation scripting!

Page organization

This page has been divided first by type and then by release.

If there are no changes to the CSV templates for a major release, a link or section will not be included - you can then use the templates from the previous release. Be sure to review the CSV import documentation in the AtoM User manual for your release.

Archival descriptions

Below you'll find copies of the CSV template examples for archival descriptions, organized by each major release. A change log is included so that you can quickly determine what has changed.

At this time, we provide templates for the ISAD(G) and RAD descriptive templates in AtoM. If you are using a different content standard (e.g. DACS, DC, or MODS), we recommend using the ISAD(G) template and ignoring any fields that do not crosswalk. Information about crosswalk mappings can be found in the Data Entry / Templates section of the AtoM User manual.

AtoM 2.8 CSV templates

Important

There have been no changes to the columns in these updated templates. Instead, the sample data has been updated to include references to the relevant standard element, and columns previously not included in the examples have been added. You can still use the 2.3 templates with AtoM 2.3, 2.4, 2.5, 2.6, 2.7, and 2.8 however!

Change log

  • Updated image URLs to point to valid images in CSVs. See issue #1781

Seealso

See the 2.8 CSV import documentation here.

Templates

AtoM 2.6 CSV templates

Important

There have been no changes to the columns in these updated templates. Instead, the sample data has been updated to include references to the relevant standard element, and columns previously not included in the examples have been added. You can still use the 2.3 templates with AtoM 2.3, 2.4, 2.5, and 2.6, however!

Change log

  • Added missing columns from examples - accessionNumber and digitalObjectPath. See issue #13300
  • Updated the example data to include references to the related standard element number wherever possible. See issue #10070

Seealso

See the 2.6 CSV import documentation here.

Templates

AtoM 2.3 CSV templates

Important

The AtoM 2.3 release includes CSV export functionality. During roundtrip testing, it was discovered that events which were not "creation" were not properly roundtripping (e.g. exporting and re-importing properly). Consequently, to better support users importing and exporting data about events and actors who are not creators (but might be accumulators, manufacturers, broadcasters, etc), major changes have been made to the 2.3 CSV template relating to actors and events. This means that 2.2 and earlier CSV templates may no longer import properly. Please see the 2.3 CSV import documentation for further guidance.

Change log

  • Changes to how Actors and events (e.g. creators, creation events, etc) are implemented to better support roundtripping of non-creation events (e.g. accumulation, broadcasting, etc)
    • creators, creatorHistories, creationDates, creationDatesStart, and creationDatesEnd columns removed
    • eventActors, eventActorHistories, eventTypes, eventDates, eventDatesStart, and eventDatesEnd columns added to replace previous columns
    • In RAD template, eventDescriptions replaces creationDateNotes, and eventPlaces has been added
  • Added new genreAccessPoints column to support genre access points - see issue #9390
  • Removed duplicate column radNoteOnPublishersSeries - see issue #9762
  • Updated the sample data for better mapping to related standards fields - see issue #10070

Seealso

See the 2.3 CSV import documentation here.

Templates

AtoM 2.2 CSV templates

Change log

  • Change creatorDates column header and related columns labels to creationDates - see issue #6526
  • Add new columns to allow import of alternativeIdentifiers and alternativeIdentifierLabels - see issue #7388

Seealso

See the 2.2 CSV import documentation here.

Templates

AtoM 2.1 CSV templates

Change log

  • digitalObjectURI and digitalObjectPath columns added for importing digital objects with archival descriptions - see issue #6525
  • Cast, Credits, and Signatures columns added to RAD CSV template - see issue #7130

Seealso

See the 2.1 CSV import documentation here.

Templates

AtoM 2.0 and earlier CSV templates

These archival description CSV templates should work for AtoM 2.0.0, 2.0.1, 2.0.2, and any earlier version of ICA-AtoM that supports CSV import.

Seealso

See the 2.0 CSV import documentation here.

Templates

Accessions

AtoM 2.6 CSV templates

Change log

  • new donorNotes column added. See issue #12799
  • new donorContactPerson and donorFax columns added. See issue #13310
  • Alternative identifier support added to Accessions module. New columns added for alternativeIdentifiers, alternativeIdentifierTypes, and alternativeIdentifierNotes. These columns support the use of pipe | separators for multiple values in a row. See issue #13262
  • Physical storage linking now added to Accessions module. New columns added for physicalStorageName, physicalStorageLocation, and physicalStorageType. See issue #13268
  • Other changes to import behavior:
    • Previously, new terms in the resourceType or acquisitionType columns would trigger an error and halt the import. Now, they will be added to the related taxonomy
    • When a duplicate accessionNumber is encountered during an import, the console log will now include the accession number of the conflict for reference

Seealso

See the 2.6 CSV import documentation here.

Templates

AtoM 2.3 CSV templates

Change log

  • Changes to actor/event handling columns in Accessions CSV template:
    • Removed creationDates, creationDatesStart, creationDatesEnd and creationDatesType
    • Added eventDates, eventDatesStart, eventDatesEnd. and eventDatesEnd

Seealso

See the 2.3 CSV import documentation here.

Templates

AtoM 2.2 CSV templates

Change log

  • Add 4 new columns to Accessions CSV import template to allow for creation date imports - see issue #8463

Seealso

See the 2.2 CSV import documentation here.

Templates

AtoM 2.1 CSV templates

Change log

  • Add qubitParentSlug to accessions CSV import to allow accessions import to link to existing descriptions - see issue #6752
  • Add identifier as an option for the second column in the digital object CSV import task - see the related documentation here.

Seealso

See the 2.1 CSV import documentation here.

Templates

AtoM 2.0.0 and earlier CSV templates

The following CSV templates should work for AtoM 2.0.0, 2.0.1, and 2.0.2, as well as any previous ICA-AtoM release that supports CSV import.

See Also

See the 2.0 CSV import documentation here.

Templates

Deaccession records

Below you'll find copies of the CSV template examples for deaccession records, organized by each major release. A change log is included so that you can quickly determine what has changed. The ability to import deaccession records via CSV was first introduced in the AtoM 2.5 release.

Templates

Authority records

In AtoM, there are 2 CSV templates for importing authority records - a primary template, as well as one optional secondary template to add relationships between actors (the Relationships CSV).

See Also

See the latest CSV import documentation here.

AtoM 2.6 CSV templates

Prior to 2.6, alternative forms of name could only be imported via a separate CSV imported at the same time as new authority record data in the primary template, using the CSV import command-line task. We have overhauled the CSV import templates, merging the alias fields into the primary template, revising the relationships CSV, and adding support for importing relationships via the user interface. Users can also add relationships to existing authority records - previously, the relationships CSV could only be imported at the same time as new data in the primary authority record template, using the CSV import command-line task. We've also added the ability to link digital objects to authority records via CSV import and we fixed a bug where new entity types (or a mismatch in capitalization for existing entity types) would cause a CSV import to fail.

Important

The alias CSV template has been deprecated and the relationships CSV has been significantly overhauled. Be sure to use the latest templates when importing data into a 2.6 AtoM installation!

Change log

  • Deprecate the Aliases CSV template. Merge the alias CSV fields into the primary authority record CSV template - add new multi-value columns for parallelNames, standardizedNames, and otherFormsOfName to the primary authority record CSV template. See issue #13277
  • Include digital objects on CSV import and export templates. Since release 2.5 authority records can be linked to a digital object (e.g. a profile picture of the authority record subject). These can be imported on the CSV template using a local file path (digitalObjectPath) or an external URI (digitalOjbectURI). Any linked digital objects are included on CSV export as a URI to the AtoM path for the digital object. See issue #13249
  • Overhaul the Relationships CSV template. Rename source and target columns to subjectAuthorizedFormOfName and objectAuthorizedFormOfName. Replace category column with relationType and support use of bi-directional relationship terms (e.g. "controls" / "is controlled by") as values. See issue #13279
  • Allow the Relationships CSV to be used to add relationships between existing authority records. See issue #13280
  • Add support for importing relationships via the user interface. See issue #13286
  • Fix issue with new entity types or variations in capitalization for existing entity type names causing the import to fail. See issue #13295
  • Update the sample data in the authority record example template to reference related ISAAR-CPF standard element numbers wherever possible

Templates

See Also

See the 2.6 CSV import documentation here.

AtoM 2.5 CSV template

Change log

  • Add 2 new fields to the actor CSV import template for subjectAccessPoints and placeAccessPoints. For more details, see issue #12647.

Template

AtoM 2.4 CSV template

Change log

  • Add 2 new fields to the actor CSV import template for occupations data: actorOccupations and actorOccupationNotes. For more details, see issue #11081.

Template

AtoM 2.0 CSV templates

The primary authority record template found below should work with all releases up to version 2.3. The Aliases and Relationships CSV templates should work for command-line imports on all versions of AtoM.

Templates

Archival Institutions

CSV import and export for archival institutions (aka repository records) was introduced in the 2.4 release.

Important

There was a bug in the 2.4.0 release that prevented some fields from importing and exporting in the archival institution CSV. This has been fixed in the 2.4.1 bug fix release. For more details, see issue #10853.

Templates

See Also

See the latest CSV import documentation here.

Physical storage containers and locations

The ability to import physical storage data was added to AtoM in the 2.6 release.

Templates

Events

The AtoM events CSV templates have not changed since AtoM 2.0.0. The following CSV templates should work for any AtoM or ICA-AtoM release that supports CSV import.

See Also

See the latest CSV import documentation here.

Templates

Digital objects

It is possible to link digital objects to existing descriptions using a CSV template, but we do not provide an example template because the format is very simple. For further information, please see the relevant section in the CSV import documentation:


Retrieved from "http://wiki.accesstomemory.org/index.php?title=Resources/CSV_templates&oldid=3599"

Account

Page

Search