Archivematica documentation¶

Overview¶

The overview section provides a definition of Archivematica and a description of the OAIS model on which it is based, its technical architecture, the microservices framework, and information about system requirements for deploying Archivematica.

• What is Archivematica?
• Web-based dashboard
• Technical architecture
• Microservices
• External tools
• System requirements

Quick-start guide¶

This section is intended to introduce prospective users to Archivematica for testing purposes, using either the Archivematica sandbox or a local virtual machine. This is not a guide to installing Archivematica for development or production - please see the Administrator manual for full installation instructions.

• Archivematica quick-start guide
• Configuration

Troubleshooting¶

The troubleshooting section contains information on how Archivematica handles errors, as well as how to report errors

• Error handling
• Error reporting
• FAQ

Transfer¶

The Transfer tab is the place where an Archivematica transfer begins. Along with the transfer widget, this tab displays microservices and jobs that act upon content to prepare your transfer to become a SIP (submission information package).

• General description
• Preparing digital objects for transfer
• Processing a transfer
• Cleaning up the Transfer tab
• Import metadata
• Bags (Library of Congress Bagit format)
• Forensic disk images
• DSpace exports
• Dataverse transfers
• ContentDM (transfer and ingest)
• Scan for viruses

Backlog¶

The Backlog tab displays content that has been added to the Archivematica backlog and allows users to search, download and delete transfers from the backlog location.

• General description
• Searching for transfers and files
• Downloading transfers or files
• Deleting transfers from the backlog
• Retrieving transfers from the backlog

Appraisal¶

The Appraisal and Arrangement tab is used to analyze and arrange material which has been placed in backlog. It can also be used to arrange materials directly to resources in ArchivesSpace.

• General description
• Backlog pane
• Analysis pane
• File list pane
• ArchivesSpace pane
• Arrangement pane

Ingest¶

The Ingest tab displays the microservices and jobs that take place to turn a SIP into an AIP or a DIP. This tab also contains the backlog widget.

• Create a SIP
• Add descriptive metadata
• Add PREMIS rights
• Normalize
• Bind PIDs
• Transcribe SIP contents
• Store AIP
• Upload DIP
• Reingest AIP
• Clean up the ingest dashboard

Archival Storage¶

The Archival Storage tab displays AIPs that have been processed by the Archivematica pipeline and related metadata such as size of AIP, UUID and date stored.

• General description
• Searching the AIP store
  • Conducting a search
  • Searching for AICs
• AIP information page
  • Downloading an AIP
  • Metadata-only DIP upload
  • AIP reingest
  • Deleting an AIP
• AIP encryption
• AIP structure
• AICs - managing multi-part AIPs

Access¶

Most of Archivematica’s access integrations take place within the Ingest tab. The Access tab displays DIPs which have been sent to AtoM.

• General description
• Access systems
• Upload a DIP to AtoM
• Upload a DIP to ArchivesSpace
• Upload a DIP to ContentDM
• Store DIP
• Review and download DIPs
• Access tab

Preservation planning¶

The Preservation Planning tab is the de facto user interface for the Format Policy Registry (FPR), the extensive format database that controls how Archivematica handles file formats. The Preservation Planning tab allows users to add or edit format policies for normalization, characterization, validation, and other tools and workflows that act upon content preserved through Archivematica.

• General description
• Definitions
• Preservation policies
• Altering rules and commands

Administration¶

The Administration tab allows administrative users to set processing configurations, transfer and storage locations, DIP upload configurations, and to add and remove users, among other things.

• Dashboard administration tab
• Storage service documentation

Metadata¶

Archivematica employs several metadata standards. This section describes how Archivematica implements and makes use of them.

• Import metadata
• METS
• PREMIS
• Dublin Core

Translations¶

Beginning with Archivematica 1.6.1, the community has been able to support the project by volunteering their time and effort to translate the Archivematica documentation, the interface, and the Storage Service into other languages.

• Contributing translations to the Archivematica project

Installation and setup¶

• Installing Archivematica
• Upgrading Archivematica
• Customization and automation
• Setting up integrations
• Administering the Storage Service
• Preservation planning

Maintenance¶

• Management commands
• Maintaining Elasticsearch
• Data backup
• FAQ

Security¶

• Elasticsearch
• MySQL
• AtoM
• Gearman
• Authentication backends
• Password validation
• Cookie and session security
• Content Security Policy (CSP)
• CA certificates