Archivematica 0.9 Micro-services

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

A micro-service may consist of a number of discrete tasks, or jobs. In the Archivematica 0.9 dashboard, micro-services are always shown, while jobs may be viewed by expanding the micro-service (i.e. by clicking on the grey background behind the micro-service name).

Arhivematica dashboard showing a micro-service and its jobs

The table below shows micro-services and jobs in Archivematica 0.9.

Transfer

Micro-service	Description
Approve Transfer Set file permissions	This is the approval step that moves the transfer into the Archivematica processing pipeline.
Verify transfer compliance Set file permissions Move to processing directory Set transfer type Remove hidden files and directories Attempt restructure for compliance Verify transfer compliance	Moves the transfer to a processing directory based on selected transfer type (standard, zipped bag, unzipped bag, DSPace export or maildir). Verifies that the transfer conforms to the folder structure required for processing in Archivematica and restructures if required. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/.
Rename with transfer UUID Rename with transfer UUID	Directly associates the transfer with its metadata by appending the transfer UUID to the transfer directory name.
Include 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. It can configure workflow options such as creating transfer backups, quarantining the transfer and selecting a SIP creation option.
Assign file UUIDs and checksums Assign file UUIDs to objects Assign checksums and file sizes to objects	Assigns a unique universal identifier and sha-256 checksum to each file in the /objects/ directory.
Verify transfer checksums Verify metadata directory checksums	Checks any checksum files that were placed in the /metadata/ folder of the transfer prior to moving the transfer into Archivematica.
Generate METS.xml document 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 locations 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. A copy of the METS file is automatically added to any SIP generated from the transfer.
Extract packages Extract packages Extract attachments	Extracts objects from any zipped files or other packages. Extracts attachments from maildir transfers.
Scan for viruses Scan for viruses	Uses ClamAV to scan for viruses and other malware. If a virus is found, the transfer is automatically placed in /sharedDirectoryStructure/failed/ and all processing on the transfer is stopped.
Clean up names Sanitize object's file and directory names Sanitize Transfer name	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.
Characterize and extract metadata Characterize and extract metadata Identify Files ByExtension Load labels from metadata/file_labels.csv	Identifies and validates formats and extracts object metadata using the File Information Tool Set (FITS). Also identities file extensions, which are used for selecting normalization paths.
Complete transfer Index transfer contents Set file permissions Move to completedTransfers directory	Indexes transfer contents, then marks the transfer as complete.
Create SIP from Transfer Check transfer directory for objects Create SIP(s) Create SIP from transfer objects	This is the approval step that moves the transfer to the SIP packaging micro-services.

Ingest

Micro-service	Description
Verify SIP compliance Set file permissions Move to processing directory 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 Rename SIP directory with SIP UUID	Directly associates the SIP with its metadata by appending the SIP UUID to the SIP directory name.
Include default SIP processingMCP.xml Include default SIP processingMCP.xml	Copies the processing config file added to the transfer in Include default Transfer processingMCP.xml, above, to the SIP.
Remove cache files Remove cache files	Removes any Thumbs.db files
Normalize Check for Service directory Check for Access directory Find options to normalize as Create DIP directory Normalize Normalize access Normalize preservation Remove files without linking information (failed normalization artifacts etc.) Create thumbnails directory Normalize thumbnails Verify checksums generated on ingest Approve normalization	Determins which normalization options are available for the SIP and presents them to the user as choices. Normalizes based on selection, and generates a DIP if access normalization is selected. Thumbnail files are also generated during this micro-service.
Process submission documentation Check for submission documentation Copy transfer submission documentation Move to processing directory Set file permissions Assign file UUIDs to submission documentation Assign checksums and file sizes to submissionDocumentation Extract packages in submission documentation Sanitize file and directory names in submission documentation Scan for viruses in submission documentation Characterize and extract metadata on submission documentation Identify Files ByExtension Normalize submission documentation to preservation format	Process the submission documentation as an object, but submission documentation only enters the DIP, not the AIP, and is identified in the METS.xml by the fileGrp "submissionDocumentation".
Prepare DIP Copy thumbnails to DIP directory Copy METS to DIP directory Set file permissions Generate DIP	Create the DIP with copies of the METS file, and thumbnails. Moves the DIP to the upload DIP watched directory.
Prepare AIP Copy transfers metadata and logs Remove files without linking information (failed normalization artifacts etc.) Verify checksums generated on ingest Generate METS.xml document Index AIP contents Prepare AIP Select compression algorithm Select compression level Compress AIP Set bag file permissions Removed bagged files	Create an AIP in Bagit format. Index the AIP, then losslessly compress it.
Store AIP Move to the store AIP approval directory Store AIP Store AIP location Store the 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.
Upload DIP to contentDM Restructure DIP for CONTENTdm upload Select upload type (Project Client or direct upload) Select target CONTENTdm server Get list of collections on server Select destination collection Upload DIP to contentDM Move to the uploadedDIPs directory	It is now possible to upload to ContentDM.
Upload DIP to ICA-Atom Upload DIP Move to the uploadedDIPs directory	The user uploads the DIP to a selected description in the access system. See the user manual for details.