Export

Available for admins and managers

Export SQL

  • Be aware, especially when sharing, that user data, e.g. email addresses, are included in the database backups

  • SQL dumps are saved in the files/sql/export folder

  • A warning will appear if the directory isn’t writable

  • File names begin with date and time e.g. 2018-08-23_1533_export.sql

  • Existing backups are shown in a list and can be downloaded or deleted

Export SQL

A SQL dump will be created with pg_dump in a plain text format. The resulting file can be used to fill an existing empty database, such as

psql openatlas < export.sql

Export database dump

A SQL dump will be created with pg_dump in a custom archiving format (-Fc). In this format pg_restore can be used to restore the database regardless of used operating system and if line breaks are used or not

pg_restore -d openatlas -1 export.dump

Export RDF/NT

  • RDF/NT dumps are saved in the files/rdf/export folder

  • A warning will appear if the directory isn’t writable

  • File names begin with date and time e.g. 2018-08-23_1533_export.nt

  • Existing backups are shown in a list and can be downloaded or deleted

  • Only N-Triples (NT) are available, because of its efficiency

Export CSV

When the Export CSV button is clicked, a ZIP file containing several CSV files is downloaded. The ZIP file contains:

  • All entities divided by their OpenAtlas class

  • Links

  • Properties

  • Hierarchy of properties

  • Classes

  • Hierarchy of classes

  • Geometries

The ZIP file’s name starts with the current date and time, for example 2022-10-04_1610-export.zip. This process can take some time.

Export JSON

When the Export JSON button is clicked, a JSON file is downloaded. This file contains the following keys:

  • Entities

  • Links

  • Properties

  • Hierarchy of properties

  • Classes

  • Hierarchy of classes

  • Geometries

The file name starts with the current date and time, for example 2022-10-04_1610-export.json. This process can take some time.

Export XML

When the Export XML button is clicked, an XML file is downloaded. This file contains the following tags:

  • Entities

  • Links

  • Properties

  • Hierarchy of properties

  • Classes

  • Hierarchy of classes

  • Geometries

The file name starts with the current date and time, for example 2022-10-04_1610-export.xml. This process can take some time.

Export ARCHE

A dedicated export is available to generate data suitable for ingestion into ARCHE, the ACDH repository system. This feature is intended for administrative use only.

See also:

  • ARCHE Deposition Process

  • ARCHE Metadata Schema

  • Only available for admin users

  • Generates a ZIP archive ready to be transferred to ARCHE

  • Output includes metadata, files, RDF and SQL dumps, and debug information in an ARCHE-compatible structure

  • The process may take significant time and consume large disk space

  • The ZIP file is saved in the files/arche/export directory

Note

This export is not listed among the standard user exports and is only available to administrators due to performance and data sensitivity concerns.

Tabs

  • Info Displays the data entered in production.py. Provides a button to check ARCHE files. Only files associated with typeIds (if any are defined) are checked. More information on the file checker can be found in Data integrity checks.

  • Export Shows the exported files. Allows administrators to start and manage the ARCHE export.

Configuration

To make use of the ARCHE export functionality, specific metadata must be provided in the production.py settings file using the ARCHE_METADATA dictionary.

Here is an example configuration:

ARCHE_METADATA = {
    'topCollection': 'OpenAtlas collection',
    'language': 'en',
    'depositor': [
        'Jane Doe',
        'https://orcid.org/0000-0000-0000-0000',
        'https://isni.org/isni/0000000121032683',
        'https://d-nb.info/gnd/123456789'
    ],
    'acceptedDate': "2024-01-01",
    'hasMetadataCreator': [
        'https://orcid.org/0000-0000-0000-1111',
        'https://orcid.org/0000-0000-0000-0000',
        'https://isni.org/isni/0000000121032683',
        'Jane Doe'
    ],
    'curator': [
        'https://orcid.org/0000-0000-0000-1111',
        'https://d-nb.info/gnd/123456789',
        'Jane Doe'
    ],
    'principalInvestigator': [
        'Researcher A',
        'Researcher B',
        'https://orcid.org/0000-0000-0000-1111'
    ],
    'relatedDiscipline': [
        'https://vocabs.acdh.oeaw.ac.at/oefosdisciplines/601003',
        'https://vocabs.acdh.oeaw.ac.at/oefosdisciplines/602001'
    ],
    'typeIds': [
        1234, 4567, 87656, 3252, 234
    ],
    'exclude_reference_systems': [
        'Internal catalogue', 'Inventory numbers'
    ]
}

Description of fields

Note

For all fields that refer to people (e.g., depositor, curator, hasMetadataCreator), you can use either a persistent identifier (preferably ORCID, but also GND, ISNI, VIAF, or Wikidata) or a plain name. Use persistent identifiers whenever possible for better interoperability.

  • topCollection: ARCHE top-level collection identifier (usually provided in coordination with the ARCHE team)

  • language: Language code of the metadata (e.g. 'en')

  • depositor: List of persons responsible for the deposit

  • acceptedDate: ISO date string of when the data was accepted for deposit

  • hasMetadataCreator: List of people responsible for the ARCHE metadata

  • curator: List of ARCHE curators

  • principalInvestigator: List of principal investigators for this project

  • relatedDiscipline: URLs to vocabularies defining the related disciplines

  • typeIds (optional): Restrict exported files to those linked with specific type IDs

  • excludeReferenceSystems (optional): List of reference system labels to be excluded from the export

Note

If typeIds or exclude_reference_systems are empty, all files and reference systems are considered.