Tutorial@Custom Ingest

This tutorial shows how to set up Arclib to be able to ingest a new custom type of packages.

General info on Arclib ingest

Arclib can ingest any kind of package (so any kind of data) with at least one XML file which contains an identifier of the SIP package. However, the structure of the input package (SIP) has an impact on Arclib functionality (for example whether Arclib is able to do fixity checks). The more an input package follows the recommended format (see SIP), the more Arclib can do.

The process of adopting a new custom package type consists of several steps:

1. Creating and setting up SIP profile, especially SIP XSL to populate or create input METS metadata and set up paths to a unique SIP ID: Usage@Sip Profiles
2. Preparing validation profile to provides necessary checks of an input package (e.g. if there are metadata missing, files missing etc.): Usage@Validation Profiles
3. Creating/selecting workflow profile (defining what steps should be done with the input package): Usage@Workflow Definitions
4. (Fill in workflow configuration): Usage@Workflow Definitions
5. (Administrative task: set up producer and tight it with the profiles and workflows above): Usage@Producer Profiles

Creating SIP profile (XSL template)

Arclib ingest process works with the METS format which must be prepared via XSL template. If the SIP itself contains any METS metadata file then the process of creating new ingest type is easier and more straight forward, because most of the input METS can be just copied. If not, the METS must be created by transforming input XML (metadata) file.

The sample XSL templates are provided.

Only very few METS elements and attributes are mandatory.

Mandatory fields (XPath)

• /METS:mets/METS:metsHdr/METS:agent
• /METS:mets/METS:metsHdr/METS:agent/@ROLE
• /METS:mets/METS:metsHdr/METS:agent/@TYPE
• /METS:mets/METS:metsHdr/METS:agent/METS:name

It is recommended to provide the digital object description metadata in /METS:mets/METS:dmdSec because this is not created by Arrclib. The rest of metadata (e.g. /METS:mets/METS:amdSec/) section are added by Arclib, but there can be few sections related to ARClib namespace added.