Archivematica 0.9 Micro-services
Jump to navigation
Jump to search
Main Page > Documentation > Technical Architecture > Micro-services > Archivematica 0.9 Micro-services
Note: The documentation on this page is out of date. Please see the official documentation page for the latest.
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).
The table below shows micro-services and jobs in Archivematica 0.9. Note that this is is only a list of micro-services; detailed user instructions are available in the user manual.
Transfer[edit]
Micro-service | Description |
---|---|
ExpandApprove Transfer
|
This is the approval step that moves the transfer into the Archivematica processing pipeline. |
ExpandVerify 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/. |
ExpandRename with transfer UUID
|
Directly associates the transfer with its metadata by appending the transfer UUID to the transfer directory name. |
ExpandInclude default Transfer processingMCP.xml
|
Adds a file named processingMCP.xml to 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. |
ExpandAssign file UUIDs and checksums
|
Assigns a unique universal identifier and sha-256 checksum to each file in the /objects/ directory. |
ExpandVerify transfer checksums
|
Checks any checksum files that were placed in the /metadata/ folder of the transfer prior to moving the transfer into Archivematica. |
ExpandGenerate 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. |
ExpandExtract packages
|
Extracts objects from any zipped files or other packages. Extracts attachments from maildir transfers. |
ExpandScan 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. |
ExpandClean up 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. |
ExpandCharacterize and extract metadata
|
Identifies and validates formats and extracts object metadata using the File Information Tool Set (FITS). Also identifies file extensions, which are used for selecting normalization paths. |
ExpandComplete transfer
|
Indexes transfer contents, then marks the transfer as complete. |
ExpandCreate SIP from Transfer
|
This is the approval step that moves the transfer to the SIP packaging micro-services (Ingest). |
Ingest[edit]
Micro-service | Description |
---|---|
ExpandVerify 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/. |
ExpandRename SIP directory with SIP UUID
|
Directly associates the SIP with its metadata by appending the SIP UUID to the SIP directory name. |
ExpandInclude default SIP processingMCP.xml
|
Copies the processing config file added to the transfer in Include default Transfer processingMCP.xml, above, to the SIP. |
ExpandRemove cache files
|
Removes any Thumbs.db files. |
ExpandNormalize
|
Determines which normalization options are available for the SIP and presents them to the user as choices. Normalizes (i.e. generates preservation and/or access copies) based on selection. Thumbnail files are also generated during this micro-service. |
ExpandProcess submission documentation
|
Processes any submission documentation included in the SIP and adds it to the /objects/ directory. |
ExpandPrepare DIP
|
Creates a DIP containing access copies of the objects, thumbnails and a copy of the METS file. |
ExpandUpload DIP
|
Allows the user to choose to upload the DIP to either ICA-AtoM or CONTENTdm. |
ExpandUpload DIP to ICA-AtoM
|
The user uploads the DIP to a selected description in ICA-AtoM. |
ExpandUpload DIP to CONTENTdm
|
The user uploads the DIP to a selected description in CONTENTdm. |
ExpandPrepare AIP
|
Creates an AIP in Bagit format. Indexes the AIP, then losslessly compresses it. |
ExpandStore AIP
|
Moves the AIP to /sharedDirectoryStructure/www/AIPsStore/ or another specified directory. Once the AIP has been stored, a copy of it is extracted from storage to a local temp directory, where it is subjected to standard BagIt checks: verifyvalid, checkpayloadoxum, verifycomplete, verifypayloadmanifests, verifytagmanifests. |