Archivematica 0.9 Micro-services

Main Page > Documentation > Technical Architecture > Micro-services > Archivematica 0.9 Micro-services

This page describes the key micro-services that are undertaken during transfer and ingest.

Transfer

Micro-service	Description
Approve transfer	Once the transfer has all its digital objects and has been formatted for processing, the user selects "Transfer complete" from the Actions drop-down menu.
Verify transfer compliance	Verifies that the transfer conforms to the folder structure required for processing in Archivematica. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/.
Rename with transfer UUID	Adds a unique universal identifier to the transfer folder name.
Include default Transfer processingMCP.xml	Adds defaultTransferProcessing.xml file from /sharedDirectoryStructure/sharedMicroServiceTasksConfigs/ to the transfer directory. This xml file can configure workflow options such as creating transfer backups, quarantining the transfer and selecting a SIP creation option.
Workflow decision - create transfer backup	The user can choose to create a complete backup of the transfer in case transfer or ingest are interrupted or fail. The transfer backup is placed in /sharedDirectoryStructure/transferBackups/ and will automatically be deleted once the AIP has been moved into storage.
Assign file UUIDs to objects	Assigns a unique universal identifier to each file in the /objects/ directory.
Assign checksums and file sizes to objects	Assigns a sha-256 checksum to each file in the /objects/ directory and calculates file sizes.
Verify metadata directory checksums	Checks any checksum files that were placed in the /metadata/ folder of the SIP prior to ingest. Note that the filenames need to be named based on their algorithm: checksum.sha1, checksum.sha256, checksum.md5.
Generate METS.xml document	Generates a basic mets file with a fileSec and structMap to record the presence of all objects in the /objects/ directory and their location in any subdirectories. Designed to capture the original order of the transfer in the event the user chooses subsequently to delete, rename or move files or break the transfer into multiple SIPs. The mets file is automatically added to any SIP generated from the transfer.
Extract packages	Extracts objects from any zipped files or other packages.
Scan for viruses	Uses ClamAV, parses the output and creates a PREMIS event. If a virus is found, the SIP is automatically placed in /sharedDirectoryStructure/failed/.
Sanitize object's file and directory names	Some file systems do not support unicode or other special characters in filenames. This micro-service removes prohibited characters and replaces them with dashes. Original filenames are preserved in the PREMIS metadata.
Sanitize transfer name	Same as above except does it for the transfer folder name.
Characterize and extract metadata	Identifies and validates formats and extracts object metadata using the File Information Tool Set (FITS). Adds output to the PREMIS metadata.
Create SIP(s)	The user chooses among a number of SIP creation options. See the user manual for details.

Ingest

Micro-service	Description
Verify SIP compliance	Verifies that the SIP conforms to the folder structure required for processing in Archivematica. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/.
Rename SIP directory with SIP UUID	Adds a unique universal identifier to the SIP folder name.
Include default SIP processingMCP.xml	Adds defaultSIPProcessing.xml file from /sharedDirectoryStructure/sharedMicroServiceTasksConfigs/ to the transfer directory. This xml file canbe used to configure SIP workflow options.
Remove thumbs.db files	Removes any Thumbs.db files. May be expanded to others in future releases.
Sanitize object's file and directory names	If user created new folder and/or file names during SIP creation, any prhobited characters are removed from these names and replaced with dashes.
Sanitize SIP name	Same as above except that it's done for the SIP folder name.
Check for Service directory	For digitization output workflows, checks to see if the SIP contains any service copies of master files. See the user manual for details.
Check for Access directory	For digitization output workflows, checks to see if the SIP contains any access copies of master files. See the user manual for details.
Normalize	The user can choose to create preservation and/or access copies of the ingested files based on rules in the transcoder database. These rules can be seen under the Preservation planning tab in the Archivematica dashboard.
Normalize access	Creates access copies to be added to the DIP.
Normalize preservation	Creates preservation copies to be included in the AIP along with the original files.
Approve normalization	If desired, the user can verify the quality of normalized files in /sharedDirectoryStructure/watchedDirectories/approveNormalization/.
Check for submission documentation	Checks for files in /metadata/submissionDocumentation/.
Move submission documentation to objects directory	Moves the /submissionDocumentation/ directory from /metadata/ to /objects/ for ingest processing.
Assign file UUIDs to submission documentation	Assigns a unique universal identifier to each file in the /objects/submissionDocumentation/ directory.
Assign checksums and filesizes to submission documentation	Assigns a sha-256 checksum to each file in the /objects/submissionDocumentation directory and calculates file sizes.
Extract packages in submission documentation	Extracts objects from any zipped files or other packages in the /objects/ directory.
Characterize and extract metadata on submission documentation	Identifies and validates formats and extracts object metadata for files in the /objects/submissionDocumentation directory using the File Information Tool Set (FITS). Adds output to the PREMIS metadata.
Normalize submission documentation to preservation format	Creates preservation copies of all files in the /objects/submissionDocumentation directory to be included in the AIP along with the original files.
Verify checksums generated on ingest	Verifies checksums that were generated during transfer processing to ensure that the files have not been corrupted during transfer or ingest.
Remove empty directories	Removes any empty directories from the SIP.
Generate METS.xml document	Generates a METS file with PREMIS metadata. For more information on the METS file, see METS.
Copy transfers metadata and logs	Copies all submission documentation included in the original transfer to the SIP. Copies all logs generated during transfer processing to the SIP.
Copy METS to DIP directory	Creates a copy of the METS file in the DIP directory.
Generate DIP	Moves the DIP to the DIP upload directory.
Upload DIP	The user uploads the DIP to a selected description in the access system. See the user manual for details.
Prepare AIP	Packages the SIP into an AIP using BagIt
Compress AIP	Losslessly compresses the AIP for storage using p7zip.
Store AIP	Moves the AIP to a specified directory. In the demo version of Archivematica the directory is /sharedDirectoryStructure/www/AIPsStore/. In other environments it can be a remote network mounted directory. The directory structure of the AIP store contains UUID quad directories and an index.html file listing the AIPs in storage. The index.html file is displayed in the dashboard in the Archival storage tab. Once the AIP has been stored, a copy of the AIP is extracted from storage to a local temp directory, and is validated with the various BagIt checks: verifyvalid, checkpayloadoxum, verifycomplete, verifypayloadmanifests, verifytagmanifests.

0.9

Micro-service	Description
ExpandApprove Transfer Set file permissions	Once the transfer has all its digital objects and has been formatted for processing, the user selects "Transfer complete" from the Actions drop-down menu.
ExpandVerify transfer compliance Set file permissions Move to processing directory Set transfer type Remove hidden files and directories Attempt restructure for compliance Verify transfer compliance	Verifies that the transfer conforms to the folder structure required for processing in Archivematica. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/. Standard transfers are restructured for compliance if pessary.
ExpandRename with transfer UUID Rename with transfer UUID	Directly associate the transfer with it's metadata by appending the transfer UUID to the transfer directory name.
ExpandInclude default Transfer processingMCP.xml Include default Transfer processingMCP.xml	Includes a file named processingMCP.xml in the root of the transfer. This is a configurable xml file to pre-configure processing decisions.
ExpandAssign file UUIDs and checksums Designate to process as a standard transfer
ExpandAssign file UUIDs and checksums Move to workFlowDecisions-createTransferBackup directory
ExpandAssign file UUIDs and checksums Find type to process as
ExpandAssign file UUIDs and checksums Workflow decision - create transfer backup
ExpandAssign file UUIDs and checksums Create transfer backup (sharedDirectory/transferBackups)
ExpandAssign file UUIDs and checksums Move to processing directory
ExpandAssign file UUIDs and checksums Set file permissions
ExpandAssign file UUIDs and checksums Assign file UUIDs to objects
ExpandAssign file UUIDs and checksums Assign checksums and file sizes to objects
ExpandVerify transfer checksums Verify metadata directory checksums
ExpandGenerate METS.xml document Generate METS.xml document
ExpandQuarantine Designate to process as a standard transfer
ExpandQuarantine Move to workFlowDecisions-quarantineSIP directory
ExpandQuarantine Find type to process as
ExpandQuarantine Workflow decision - send transfer to quarantine
ExpandQuarantine Set quarantine permissions on transfer
ExpandQuarantine Create quarantine PREMIS events
ExpandQuarantine Designate to process as a standard transfer when unquarantined
ExpandQuarantine Move to quarantine
ExpandQuarantine Find type to remove from quarantine as
ExpandQuarantine Remove from quarantine
ExpandQuarantine Set unquarantined file permissions on Transfer
ExpandQuarantine Move to processing directory
ExpandQuarantine Create unquarantine PREMIS events
ExpandExtract packages Move to processing directory
ExpandExtract packages Extract packages
ExpandScan for viruses Scan for viruses
ExpandClean up names Sanitize object's file and directory names
ExpandClean up names Sanitize Transfer name
ExpandCharacterize and extract metadata Characterize and extract metadata
ExpandCharacterize and extract metadata Identify Files ByExtension
ExpandCharacterize and extract metadata Load labels from metadata/file_labels.csv
ExpandComplete transfer Set file permissions
ExpandComplete transfer Move to completedTransfers directory
ExpandComplete transfer Index transfer contents
ExpandCreate SIP from Transfer Check transfer directory for objects
ExpandCreate SIP from Transfer Create SIP(s)
ExpandCreate SIP from Transfer Move to processing directory
ExpandCreate SIP from Transfer Create SIP from transfer objects
ExpandCreate SIP from Transfer Move to completedTransfers directory
ExpandReject transfer Move to the rejected directory
ExpandFailed transfer Move to the failed directory
ExpandApprove SIP creation Approve SIP Creation
ExpandVerify SIP compliance Set file permissions
ExpandVerify SIP compliance Move to processing directory
ExpandVerify SIP compliance Verify SIP compliance
ExpandVerify transfer compliance Verify mets_structmap.xml compliance
ExpandFailed compliance Failed compliance. See output in dashboard. SIP moved back to SIPsUnderConstruction
ExpandRename SIP directory with SIP UUID Rename SIP directory with SIP UUID
ExpandInclude default SIP processingMCP.xml Include default SIP processingMCP.xml
ExpandRemove cache files Remove cache files
ExpandClean up names Set file permissions
ExpandClean up names Sanitize SIP name
ExpandNormalize Check for Service directory
ExpandNormalize Check for Access directory
ExpandNormalize Grant normalization options for pre-existing DIP
ExpandNormalize Grant normalization options for no pre-existing DIP
ExpandNormalize Move to workFlowDecisions-createDip directory
ExpandNormalize Find options to normalize as
ExpandNormalize Normalize
ExpandProcess submission documentation Remove files without linking information (failed normalization artifacts etc.)
ExpandProcess submission documentation Normalize submission documentation to thumbnail format
ExpandNormalize Verify checksums generated on ingest
ExpandNormalize Copy transfers metadata and logs
ExpandNormalize Generate METS.xml document
ExpandNormalize Normalize service files for access
ExpandNormalize Normalize access
ExpandNormalize Create DIP directory
ExpandNormalize Normalize for preservation and access
ExpandNormalize Normalize preservation
ExpandNormalize Remove files without linking information (failed normalization artifacts etc.)
ExpandNormalize Move to approve normalization directory
ExpandNormalize Approve normalization
ExpandNormalize Move to processing directory
ExpandNormalize Set file permissions
ExpandNormalize Create thumbnails directory
ExpandNormalize Normalize thumbnails
ExpandProcess submission documentation Move to processing directory
ExpandProcess submission documentation Set file permissions
ExpandProcess submission documentation Copy transfer submission documentation
ExpandProcess submission documentation Check for submission documentation
ExpandProcess submission documentation Move submission documentation into objects directory
ExpandProcess submission documentation Assign file UUIDs to submission documentation
ExpandProcess submission documentation Assign checksums and file sizes to submissionDocumentation
ExpandProcess submission documentation Extract packages in submission documentation
ExpandProcess submission documentation Sanitize file and directory names in submission documentation
ExpandProcess submission documentation Scan for viruses in submission documentation
ExpandProcess submission documentation Characterize and extract metadata on submission documentation
ExpandProcess submission documentation Identify Files ByExtension
ExpandProcess submission documentation Normalize submission documentation to preservation format
ExpandPrepare AIP Remove files without linking information (failed normalization artifacts etc.)
ExpandPrepare AIP Verify checksums generated on ingest
ExpandPrepare AIP Copy transfers metadata and logs
ExpandPrepare AIP Generate METS.xml document
ExpandPrepare DIP Copy thumbnails to DIP directory
ExpandPrepare DIP Copy METS to DIP directory
ExpandPrepare DIP Set file permissions
ExpandPrepare DIP Generate DIP
ExpandPrepare AIP Index AIP contents
ExpandPrepare AIP Prepare AIP
ExpandPrepare AIP Select compression algorithm
ExpandPrepare AIP Select compression level
ExpandPrepare AIP Compress AIP
ExpandPrepare AIP Set bag file permissions
ExpandPrepare AIP Removed bagged files
ExpandStore AIP Move to the store AIP approval directory
ExpandStore AIP Store AIP
ExpandStore AIP Store AIP location
ExpandStore AIP Move to processing directory
ExpandStore AIP Store the AIP
ExpandStore AIP Remove the processing directory
ExpandUpload DIP Select target CONTENTdm server
ExpandUpload DIP Get list of collections on server
ExpandUpload DIP Select destination collection
ExpandUpload DIP Select upload type (Project Client or direct upload)
ExpandUpload DIP Restructure DIP for CONTENTdm upload
ExpandUpload DIP Upload DIP to contentDM
ExpandUpload DIP Upload DIP
ExpandUpload DIP Move to the uploadedDIPs directory
ExpandReject DIP Move to the rejected directory
ExpandReject SIP Move to the rejected directory
ExpandFailed SIP Move to the failed directory
ExpandNormalize Find preservation links to run.
ExpandNormalize Find access links to run.
ExpandNormalize Find thumbnail links to run.
ExpandProcess submission documentation Find thumbnail links to run.
ExpandProcess submission documentation Find preservation links to run. |