Difference between revisions of "Resources/CSV templates"

From AtoM wiki
(Add links to each section for CSV import.)
(Archival Institutions: Add link to related issue in admonition)
(37 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
[[Main Page]] > [[Resources]] > Resources/CSV templates
 
[[Main Page]] > [[Resources]] > Resources/CSV templates
  
On this page you'll 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.  
+
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 [https://accesstomemory.org/docs User manual.] Links directly to each major release's CSV import documentation are included in the relevant sections below.
 +
 
 +
<admonition type="tip">
 +
Did you know you can also find all the CSV import templates inside AtoM? They are located in <code>lib/task/import/example</code>.
 +
</admonition>
 +
 
 +
<admonition type="see also">
 +
Migrating data to AtoM? Check out the [[Resources/CSV transformation|CSV transformation]] page for information on transformation scripting!
 +
</admonition>
 +
 
 +
'''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 [https://accesstomemory.org/docs 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 [https://accesstomemory.org/docs User manual.]
 +
 
 +
===AtoM 2.3 CSV templates===
 +
 
 +
<admonition type="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.
 +
</admonition>
 +
 
 +
'''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)
 +
** <code>creators</code>, <code>creatorHistories</code>, <code>creationDates</code>, <code>creationDatesStart</code>, and <code>creationDatesEnd</code> columns removed
 +
** <code>eventActors</code>, <code>eventActorHistories</code>, <code>eventTypes</code>, <code>eventDates</code>, <code>eventDatesStart</code>, and <code>eventDatesEnd</code> columns added to replace previous columns
 +
** In RAD template, <code>eventDescriptions</code> replaces <code>creationDateNotes</code>, and <code>eventPlaces</code> has been added
 +
* Added new <code>genreAccessPoints</code> column to support genre access points - see issue #9390
 +
* Removed duplicate column <code>radNoteOnPublishersSeries</code> - see issue #9762
 +
* Updated the sample data for better mapping to related standards fields - see issue #10070
  
At this time, we provide templates for the ISAD(G) and RAD descriptive templates in AtoM. If you are wanting to import data but are using a different content standard (e.g. DACS, DC, or MODS), we recommend using the ISAD(G) template, and simply ignoring any fields that do not crosswalk. We will be adding crosswalking mappings from each content standard to the relevant ISAD template CSV column in the Data entry section of our AtoM [https://accesstomemory.org/docs User manual.]
 
  
 
<admonition type="seealso">
 
<admonition type="seealso">
For more information on CSV import, see the CSV section of our [https://accesstomemory.org/docs User manual.] Links directly to each major release's CSV import documentation are included in the relevant sections below.
+
See the 2.3 CSV import documentation [https://www.accesstomemory.org/docs/2.3/user-manual/import-export/csv-import/ here.]
 
</admonition>
 
</admonition>
  
===AtoM 2.0 and earlier CSV templates===
+
'''Templates'''
 +
 
 +
* [[media:example_information_objects_isad-2.3.csv|ISAD 2.3 CSV template]]
 +
* [[media:example_information_objects_rad-2.3.csv|RAD 2.3 CSV template]]
 +
 
 +
===AtoM 2.2 CSV templates===
 +
 
 +
'''Change log'''
 +
 
 +
* Change <code>creatorDates</code> column header and related columns labels to <code>creationDates</code> - see issue [https://projects.artefactual.com/issues/6526 #6526]
 +
* Add new columns to allow import of <code>alternativeIdentifiers</code> and <code>alternativeIdentifierLabels</code> - see issue [https://projects.artefactual.com/issues/7388 #7388]
  
These CSV template should work for AtoM 2.0.0, 2.0.1, 2.0.2, and any earlier version of ICA-AtoM that supports CSV import.
 
  
 
<admonition type="seealso">
 
<admonition type="seealso">
See the 2.0 CSV import documentation [https://www.accesstomemory.org/docs/2.0/user-manual/import-export/csv-import/ here.]
+
See the 2.2 CSV import documentation [https://www.accesstomemory.org/docs/2.2/user-manual/import-export/csv-import/ here.]
 
</admonition>
 
</admonition>
  
* ISAD
+
'''Templates'''
* RAD
 
  
 +
* [[media:example_information_objects_isad-2.2.csv|ISAD 2.2 CSV template]]
 +
* [[media:example_information_objects_rad-2.2.csv|RAD 2.2 CSV template]]
  
 
===AtoM 2.1 CSV templates===
 
===AtoM 2.1 CSV templates===
  
Describe changes here
+
'''Change log'''
 +
 
 +
* <code>digitalObjectURI</code> and <code>digitalObjectPath</code> columns added for importing digital objects with archival descriptions - see issue [https://projects.artefactual.com/issues/6525 #6525]
 +
* Cast, Credits, and Signatures columns added to RAD CSV template - see issue [https://projects.artefactual.com/issues/7130 #7130]
 +
 
  
 
<admonition type="seealso">
 
<admonition type="seealso">
Line 30: Line 81:
 
</admonition>
 
</admonition>
  
 +
'''Templates'''
 +
 +
* [[media:example_information_objects_isad-2.1.csv|ISAD 2.1 CSV template]]
 +
* [[media:example_information_objects_rad-2.1.csv|RAD 2.1 CSV template]]
 +
 +
===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.
 +
 +
<admonition type="seealso">
 +
See the 2.0 CSV import documentation [https://www.accesstomemory.org/docs/2.0/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_information_objects_isad-2.0.csv|ISAD CSV template]]
 +
* [[media:example_information_objects_rad-2.0.csv|RAD CSV template]]
 +
 +
 +
==Accessions==
 +
 +
===AtoM 2.3 CSV templates===
 +
 +
'''Change log'''
 +
* Changes to actor/event handling columns in Accessions CSV template:
 +
** Removed <code>creationDates</code>, <code>creationDatesStart</code>, <code>creationDatesEnd</code> and <code>creationDatesType</code>
 +
** Added <code>eventDates</code>, <code>eventDatesStart</code>, <code>eventDatesEnd</code>. and <code>eventDatesEnd</code>
 +
 +
 +
<admonition type="seealso">
 +
See the 2.3 CSV import documentation [https://www.accesstomemory.org/docs/2.3/user-manual/import-export/csv-import/ here.]
 +
</admonition>
  
* ISAD
+
'''Templates'''
* RAD
 
  
 +
* [[media:example_accessions_2.3.csv|Accessions 2.3 CSV template]]
  
 
===AtoM 2.2 CSV templates===
 
===AtoM 2.2 CSV templates===
  
Describe changes here
+
'''Change log'''
 +
* Add 4 new columns to Accessions CSV import template to allow for creation date imports - see issue #8463
 +
 
  
 
<admonition type="seealso">
 
<admonition type="seealso">
Line 43: Line 128:
 
</admonition>
 
</admonition>
  
 +
'''Templates'''
 +
 +
* [[media:example_accessions-2.2.csv|Accessions 2.2 CSV template]]
 +
 +
===AtoM 2.1 CSV templates===
 +
 +
'''Change log'''
 +
* Add <code>qubitParentSlug</code> to accessions CSV import to allow accessions import to link to existing descriptions - see issue [https://projects.artefactual.com/issues/6752 #6752]
 +
* Add <code>identifier</code> as an option for the second column in the digital object CSV import task - see the related documentation [https://accesstomemory.org/docs/2.1/user-manual/import-export/csv-import/#load-digital-objects-via-the-command-line here.]
 +
 +
 +
<admonition type="seealso">
 +
See the 2.1 CSV import documentation [https://www.accesstomemory.org/docs/2.1/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_accessions-2.1.csv|Accessions 2.1 CSV template]]
 +
 +
 +
===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.
 +
 +
<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.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_accessions-2.0.csv|Accession CSV template]]
 +
 +
 +
==Authority records==
 +
 +
In AtoM, there are 3 CSV templates for importing authority records - a primary template, as well as two optional secondary templates that can be imported at the same time (when using the command-line only) to add further forms of name (the Aliases CSV), or relationships between actors (the Relationships CSV).
 +
 +
These two supplementary AtoM authority record CSV templates have not changed since AtoM 2.0.0, and should work for any AtoM or ICA-AtoM release that supports CSV import. Note that currently the aliases and relationships CSV templates can '''only''' be imported via the command-line.
 +
 +
In the [[Releases/Release_announcements/Release_2.4|2.4 release]] 2 new fields were added to the primary authority records CSV template, to support the import and export of Occupation access point data.
 +
 +
<admonition type="see also">
 +
See the latest CSV import documentation [https://www.accesstomemory.org/docs/latest/user-manual/import-export/csv-import/ here.]
 +
 +
For instructions on importing the supplementary authority record CSVs, see the command-line import documentation [https://www.accesstomemory.org/docs/latest/admin-manual/maintenance/cli-import-export/ here]
 +
</admonition>
 +
 +
===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|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|Authority record 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]]
 +
 +
==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 2.4 CSV import documentation [https://www.accesstomemory.org/docs/2.4/user-manual/import-export/csv-import/ here.]
 +
</admonition>
 +
 +
==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.
 +
 +
<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.]
 +
</admonition>
 +
 +
'''Templates'''
 +
 +
* [[media:example_events-2.0.csv|Events 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:
  
* ISAD
+
* https://accesstomemory.org/docs/2.3/user-manual/import-export/csv-import/#load-digital-objects-via-the-command-line
* RAD
 
  
 +
<br />
 +
-----
  
* [[#Resources/CSV templates|Back to top]]
+
* [[Resources|Back to Resources]]
 +
* [[Main Page|Back to AtoM wiki home]]
  
  
 
[[Category:Resources]]
 
[[Category:Resources]]

Revision as of 12:24, 30 January 2018

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.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.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

Authority records

In AtoM, there are 3 CSV templates for importing authority records - a primary template, as well as two optional secondary templates that can be imported at the same time (when using the command-line only) to add further forms of name (the Aliases CSV), or relationships between actors (the Relationships CSV).

These two supplementary AtoM authority record CSV templates have not changed since AtoM 2.0.0, and should work for any AtoM or ICA-AtoM release that supports CSV import. Note that currently the aliases and relationships CSV templates can only be imported via the command-line.

In the 2.4 release 2 new fields were added to the primary authority records CSV template, to support the import and export of Occupation access point data.

See Also

See the latest CSV import documentation here.

For instructions on importing the supplementary authority record CSVs, see the command-line import documentation here

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 2.4 CSV import documentation here.

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 2.0 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: