Ingest

During ingest, digital objects are packaged into SIPs and run through several micro-services, including normalization, packaging into an AIP and generation of a DIP.

If you would like to skip some of the default decision points or make preconfigured choices for your desired workflow, see User administration - Processing configuration.

Should you run into an error during ingest, please see Error handling.

On this page:

Create a SIP

  1. Process transfers as described in Transfers.
  2. Click on the Ingest tab.
  3. The single SIP will move through a number of micro-services. If the user has preconfigured Archivematica to do so, processing will stop at a decision point that allows the user to choose a file identification method to base normalization upon or to choose to use pre-existing data gathered during identification at the transfer stage. Archivematica default is to use pre-existing data. For more about this option, see Administer — Processing configuration.
  4. Wait until the SIP reaches “Normalize” and a bell icon appears.
Archivematica Normalization micro-service

Normalization micro-service

  1. To add descriptive metadata, see Add metadata, below.
  2. To add PREMIS rights information, see Add PREMIS rights, below.
  3. For selecting a normalization option, see Normalization, below.

Arrange a SIP from backlog

  1. First, retrieve content from transfer backlog. Use the Transfer backlog search bars at the top of the Ingest tab to find the transfer(s) and/or object(s)you’d like to ingest, or browse the entire backlog by clicking Search transfer backlog with a blank search. This will populate the Originals pane of the Ingest dashboard. Note: Multi-item select is not yet included in this feature, though entire folders/directories can be moved.
Transfer backlog search showing population of the Originals pane

Transfer backlog search results in populating Originals pane

Archivematica will display the directories in Transfer backlog including the number of objects in each directory. To hide directories from the Originals pane, click on the directory and click Hide.

  1. Drag and drop the transfer directory(ies) and/or object(s) you wish to arrange and ingest as a SIP from the Originals pane to the Arrange pane, or create an arrangement structure for your SIP (see step 4, below).
Dragging and dropping directories from Originals pane to Arrange pane

Drag and drop from Originals pane to Arrange pane

Note

There will be a discrepancy between the object count in the originals pane vs the arrange pane after a directory is dragged over. This is because the originals pane is counting metadata and submission documentation, including the METS file created during Transfer.

  1. Click on the directory in the Arrange pane to select, and then click Create SIP. Archivematica will confirm that you wish to create a SIP, and then continue through the ingest process.
  2. To arrange your SIP, create one or more directories in the Arrange pane by clicking on the Add Directory button. You can add separate directories or directories nested inside of each other. Note: You cannot rename a directory once you have created it; you must delete it and create a directory with a new name.
Creating a new directory in the Arrange pane

Create a new directory in Arrange pane

  1. Click and drag files from the Originals pane into your desired directory in the arrange panel. You can move either individual files or entire directories. Note: All files must be in a directory inside of Arrange. “Arrange” cannot be used as the top directory.
  2. When you have completed moving files and directories into the Arrange pane, click on the top level directory which you wish to include in your SIP. Click on Create SIP. Any files or directories which are not inside the directory you chose will remain in the Arrange pane until you create a SIP using these files and directories.
Create a new SIP in Arrange pane

Create a new SIP by clicking on a directory within Arrange pane

Archivematica will confirm that you wish to create a SIP and after receiving confirmation, proceed to the next micro-services to create AIPs and DIPs as selected by the user.

Arranging a SIP for AtoM

If you plan to create a DIP to Upload to AtoM, you may wish to add levels of description to your directories and/or objects. Archivematica will add a logical structMAP to the METS file, which AtoM will use to create information objects, applying the chosen levels of description. Note that if you do not apply a level of description to a digital object, AtoM will automatically assign it the level of “item”.

This functionality is supported in AtoM 2.2 and higher.

  1. Click to select a directory or object, then click Edit metadata to choose the level of description.
Choosing the AtoM level of description
  1. As you add levels of description they will be shown in the arrange pane for you to review before finalizing your SIP.
Viewing levels of description applied to SIP

Note

To have the AtoM levels of description appear you must have entered your AtoM credentials in Administration. See Administer, AtoM DIP upload.

Levels of description in AtoM are managed as a taxonomy. To edit, see Terms.

Tip

If you choose not to assign levels of description to directories in SIP arrange, AtoM will flatten the DIP so that all digital objects are child-level descriptions of the target description.

Add metadata

In Archivematica, metadata can be added either prior to the normalization step or after. Archivematica will prompt you with a reminder to add metadata if desired during the Process metadata directory micro-service. See :ref:`AtoM Dublin Core <atom:dc-template>`for information about the Dublin Core elements available.

See also

If you are importing lower-level metadata (i.e. metadata to be attached to subdirectories and files within a SIP) see also:

  1. Click on the template icon.
Location of the template icon

To add metadata, click on the template icon

  1. This will take you to the SIP detail panel. On the left-hand side, under metadata click Add.
SIP detail panel

SIP detail panel

  1. Add metadata as desired and save it by clicking the Create button at the bottom of the screen. Hovering in a field will activate tooltips that define the Dublin Core element and provide a link to ISO 15836 Dublin Core Metadata Element Set. Note that you can only add metadata at the SIP level when using the template. If you would like to add metadata to a digital object, you will need to do that once the object has been uploaded to your access system.
SIP metadata entry form

SIP metadata entry form

  1. When you click Create, you will see the metadata entry in the list page. To edit it further, click Edit on the right-hand side. To delete it, click Delete. To add more DC metadata, click the Add button below the list.
SIP metadata list

SIP metadata list

  1. Return to the ingest tab to continue processing the SIP.

Add PREMIS rights

Archivematica allows you to add PREMIS rights either prior to the normalization step or after. Archivematica will prompt you with a reminder to add rights information if desired during the Process metadata directory micro-service. For more information about the PREMIS rights fields, see PREMIS template

  1. Click on the template icon.
Location of the template icon

To add rights, click on the template icon

  1. This will take you to the SIP detail panel. On the left-hand side, under Rights, click Add.
SIP detail panel

SIP detail panel

  1. Add rights as desired and save it by clicking the Save button at the bottom of the screen, or clicking Next if you are finished and ready to move on to the second page of data entry. Rights entries are made up of two pages of content.
SIP rights template- first page

SIP rights template- first page

To get to the second page to complete data entry, click Next. Note that you can only add rights at the SIP level. If you would like to add rights to an individual digital object, you will need to do that once the object has been uploaded to your access system.

SIP rights template- second page

SIP rights template- second page

  1. When you click Save on the second page, you will be given the option to add another act with its associated grants and/or restrictions.
Button to repeat acts in rights template

Repeatable acts in rights template

  1. If you have finished adding acts, click Done. You will see the rights entry in the list page . To edit it further, click Edit on the right-hand side.
SIP detail panel with rights

SIP detail panel with rights

  1. Return to the ingest tab to continue processing the SIP.

Normalize

Normalizing is the process of converting ingested digital objects to preservation and/or access formats. Note that the original objects are always kept along with their normalized versions. For more information about Archivematica’s preservation strategy, go to the Preservation Planning section of the manual.

  1. At the normalization step, the SIP will appear in the dashboard with a bell icon next to it. Select one of the normalization options from the Actions drop-down menu:
Selecting a normalization option

Selecting a normalization option

  • Normalize for preservation and access: creates preservation copies of the objects plus access copies which will be used to generate the DIP.
  • Normalize for access: no preservation copies are created. Creates access copies which will be used to generate the DIP.
  • Normalize for preservation: creates preservation copies. No access copies are created and no DIP will be generated.
  • Do not normalize: no preservation copies are created. No access copies are created and no DIP will be generated.
  • You may also Reject SIP at this stage.
  1. Once normalization is completed you can review the results in the normalization report. Click on the report icon next to the Actions drop-down menu.
Location of the report icon to open the normalization report

Click on the report icon to open the normalization report

The report shows what has been normalized and what is already in an acceptable preservation and access format:

Normalization report
  1. You may review the normalization results in a new tab by clicking on Review. If your browser has plug-ins to view a file, you may open it in another tab by clicking on it. If you click on a file and your browser cannot open it, it will download locally so you can view it using the appropriate software on your machine.
Review normalization results in new tab

Review normalization results in new tab

  1. Approve normalization in the Actions drop-down menu to continue processing the SIP. You may also Reject the SIP or re-do normalization. If you see errors in normalization, follow the instructions in Error handling to learn more about the problem.

Transcribe SIP contents

Archivematica gives users the option to Transcribe SIP contents using Tesseract OCR tool. If Yes is selected by the user during this micro-service, an OCR file will be included in the DIP and stored in the AIP.

Note

This feature is designed to transcribe the text from single images (e.g. individual pages of a book scanned as image files). It does not support transcription of multi-page objects or word processing files, PDF files, etc.

Store AIP

  1. After normalization is approved, the SIP runs through a number of micro-services, including processing of the submission documentation, generation of the METS file, indexing, generation of the DIP and packaging of the AIP.
Archivematica ready to store AIP and upload DIP

Archivematica ready to store the AIP and upload the DIP

  1. If desired, review the contents of the AIP in another tab by clicking on Review. More information on Archivematica’s AIP structure and the METS/PREMIS file is available in the Archivematica documentation: see AIP structure. You can download the AIP at this stage by clicking on it.
  2. From the Action dropdown menu, select “Store AIP” to move the AIP into archival storage. You can store an AIP in any number of preconfigured directories. For instructions to configure AIP storage locations, see Administrator manual - Storage Service.
  3. From the Action dropdown menu, select the AIP storage location from the pre-configured set of options.

Note

We recommend storing the AIP before uploading the DIP. If there is a problem with the AIP at this point and the DIP has already been uploaded, you will have to delete the DIP from the upload location.

For information on viewing and managing stored AIPs go to Archival storage.

Upload DIP

Archivematica supports DIP uploads to AtoM, ArchivesSpace, CONTENTdm and Archivists’ Toolkit. For information about uploading DIPs to your access system, see Access.

Reingest AIP

In Archivematica, AIP reingest is supported for the purpose of adding metadata and normalizing for access. There are three methods of starting AIP reingest: through the dashboard, through the Storage Service, or through the API.

Dashboard

  1. In the Archival Storage tab, find the AIP you wish to reingest by searching or browsing. Click on Reingest
Click on reingest beside the AIP
  1. Choose if you wish to reingest the metadata only, or reingest the metadata and objects.
Choose type of reingest

Click on Re-ingest package. Archivematica will tell you that the AIP has been sent to the pipeline for reingest.

Note

If you attempt to reingest an AIP which is already in the process of being reingested in the pipeline, Archivematica will alert you with an error.

  1. Proceed to the Ingest tab and approve the AIP reingest.
Approve AIP reingest in Ingest tab.
  1. When the package proceeds to Normalization:

For metadata only choose “Do not normalize”

For metadata and objects choose “Normalize for access”

Important

All normalization options will appear as for any SIP being normalized, but only the two normalization paths above are operational for AIP reingest in version 1.5. Choosing another normalization path will result in errors!

  1. To add new metadata or edit existing metadata, click on the metadata report icon:
Click on the metadata report icon

Tip

You can update the metadata either before or after Normalization, but to ensure the metadata is written to the database before the AIP METS is prepared, it is recommended practice to add the metadata before Normalization, or set the metadata reminder to unchecked in Processing Configuration.

Descriptive or rights metadata can updated or deleted. metadata.csv files can also be added by clicking on Add Metadata files. This will launch a file browser with the same locations available as configured for Transfer Source.

Add new metadata files
  1. After normalization and metadata updating, continue processing the SIP as normal. Note that when performing a metadata-only reingest, there will be no objects in your AIP in the review stage- Archivematica replaces the METS file in the existing AIP upon storage.

Storage Service

  1. From the Packages tab in the Storage Service, click on Re-ingest beside the AIP you wish to reingest.
Reingest link in Storage Service Packages tab
  1. The Storage Service will ask you to choose a pipeline, and the types of reingest (metadata only or metadata and objects in version 1.5)
Screen to choose pipeline and type of reingest
  1. The Storage Service will confirm that the AIP has been sent to the pipeline for reingest. Proceed to the Ingest tab of your pipeline, and follow steps 3-6 above.

Back to the top