Archivematica 0.9 Micro-services - Revision history

Ablewer at 20:14, 11 December 2019

2019-12-11T20:14:34Z

Evelyn: /* Transfer */

2012-08-28T22:57:27Z

Transfer

Evelyn: /* Ingest */

2012-08-28T22:54:32Z

Ingest

Evelyn: /* Transfer */

2012-08-28T22:49:05Z

Transfer

Evelyn: /* Transfer */

2012-08-28T22:48:10Z

Transfer

Evelyn: /* Transfer */

2012-08-28T22:44:12Z

Transfer

Evelyn at 22:29, 28 August 2012

2012-08-28T22:29:43Z

Evelyn at 22:05, 28 August 2012

2012-08-28T22:05:45Z

Evelyn at 21:59, 28 August 2012

2012-08-28T21:59:25Z

Evelyn at 21:51, 28 August 2012

2012-08-28T21:51:39Z

← Older revision		Revision as of 20:14, 11 December 2019
Line 1:		Line 1:
	[[Main Page]] > [[Documentation]] > [[Technical Architecture]] > [[Micro-services]] > Archivematica 0.9 Micro-services		[[Main Page]] > [[Documentation]] > [[Technical Architecture]] > [[Micro-services]] > Archivematica 0.9 Micro-services
		+
		+	<blockquote style="background-color:orange;">
		+	'''Note: The documentation on this page is out of date. Please see the [https://www.archivematica.org/docs official documentation page] for the latest.'''
		+	</blockquote>

	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).		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).

@@ Line 34: / Line 34: @@
 </div>
 </div>
-| 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/.
+| 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/''.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Rename with transfer UUID'''<div class="mw-collapsible-content">
@@ Line 53: / Line 53: @@
 </div>
 </div>
-| Assigns a unique universal identifier and sha-256 checksum to each file in the /objects/ directory.
+| Assigns a unique universal identifier and sha-256 checksum to each file in the ''/objects/'' directory.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Verify transfer checksums'''<div class="mw-collapsible-content">
@@ Line 59: / Line 59: @@
 </div>
 </div>
-| Checks any checksum files that were placed in the /metadata/ folder of the transfer prior to moving the transfer into Archivematica.
+| Checks any checksum files that were placed in the ''/metadata/'' folder of the transfer prior to moving the transfer into Archivematica.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Generate METS.xml document'''<div class="mw-collapsible-content">
@@ Line 65: / Line 65: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Extract packages'''<div class="mw-collapsible-content">
@@ Line 78: / Line 78: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Clean up names'''<div class="mw-collapsible-content">

@@ Line 128: / Line 128: @@
 </div>
 </div>
-| Verifies that the SIP conforms to the folder structure required for processing in Archivematica. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/.
+| Verifies that the SIP conforms to the folder structure required for processing in Archivematica. The structure is as follows: ''/logs/'', ''/metadata/'', ''/metadata/submissionDocumentation/'', ''/objects/''.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Rename SIP directory with SIP UUID'''<div class="mw-collapsible-content">
@@ Line 180: / Line 180: @@
 </div>
 </div>
-| Processes any submission documentation included in the SIP and adds it to the /objects/ directory.
+| Processes any submission documentation included in the SIP and adds it to the ''/objects/'' directory.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Prepare DIP'''<div class="mw-collapsible-content">
@@ Line 189: / Line 189: @@
 </div>
 </div>
-| Creates the DIP containing access copies of the objects, thumbnails and a copy of the [[METS]] file.
+| Creates a DIP containing access copies of the objects, thumbnails and a copy of the METS file.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Upload DIP'''<div class="mw-collapsible-content">
@@ Line 230: / Line 230: @@
 </div>
 </div>
-| Creates an AIP in [http://sourceforge.net/projects/loc-xferutils/ Bagit] format. Indexes the AIP, then losslessly compresses it.
+| Creates an AIP in Bagit format. Indexes the AIP, then losslessly compresses it.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Store AIP'''<div class="mw-collapsible-content">
@@ Line 239: / Line 239: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |}

@@ Line 46: / Line 46: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Assign file UUIDs and checksums'''<div class="mw-collapsible-content">

@@ Line 93: / Line 93: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Complete transfer'''<div class="mw-collapsible-content">
@@ Line 109: / Line 109: @@
 </div>
 </div>
-| This is the approval step that moves the transfer to the SIP packaging micro-services.
+| This is the approval step that moves the transfer to the SIP packaging micro-services (Ingest).
 |-
 |}

@@ Line 189: / Line 189: @@
 </div>
 </div>
-| Creates the DIP access copies of the objects, a copy of the [[METS]] file, and thumbnails.
+| Creates the DIP containing access copies of the objects, thumbnails and a copy of the [[METS]] file.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Prepare AIP'''<div class="mw-collapsible-content">
@@ Line 214: / Line 239: @@
 </div>
 </div>
-| 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 and it is validated subjected to standard BagIt checks: verifyvalid, checkpayloadoxum, verifycomplete, verifypayloadmanifests, verifytagmanifests.
+| 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.
 |-
 |}

@@ Line 9: / Line 9: @@
 </br>
-The table below shows micro-services and jobs in Archivematica 0.9.
+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 0.9|user manual]].
 </br>
 =Transfer=
@@ Line 112: / Line 112: @@
 |-
 |}
 =Ingest=

@@ Line 145: / Line 145: @@
 </div>
 </div>
-| Removes any Thumbs.db files
+| Removes any Thumbs.db files.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Normalize'''<div class="mw-collapsible-content">
@@ Line 162: / Line 162: @@
 </div>
 </div>
-| 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.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Process submission documentation'''<div class="mw-collapsible-content">
@@ Line 179: / Line 179: @@
 </div>
 </div>
-| 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".
+| Processes any submission documentation included in the SIP and adds it to the /objects/ directory.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Prepare DIP'''<div class="mw-collapsible-content">
@@ Line 188: / Line 188: @@
 </div>
 </div>
-| Create the DIP with copies of the [[METS]] file, and thumbnails. Moves the DIP to the upload DIP watched directory.
+| Creates the DIP access copies of the objects, a copy of the [[METS]] file, and thumbnails.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Prepare AIP'''<div class="mw-collapsible-content">
@@ Line 204: / Line 204: @@
 </div>
 </div>
-| Create an AIP in [http://sourceforge.net/projects/loc-xferutils/ Bagit] format. Index the AIP, then losslessly compress it.
+| Creates an AIP in [http://sourceforge.net/projects/loc-xferutils/ Bagit] format. Indexes the AIP, then losslessly compresses it.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Store AIP'''<div class="mw-collapsible-content">
@@ Line 213: / Line 213: @@
 </div>
 </div>
-| 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.
+| 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 and it is validated subjected to standard BagIt checks: verifyvalid, checkpayloadoxum, verifycomplete, verifypayloadmanifests, verifytagmanifests.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Upload DIP  to contentDM'''<div class="mw-collapsible-content">

@@ Line 128: / Line 128: @@
 </div>
 | Verifies that the SIP conforms to the folder structure required for processing in Archivematica. The structure is as follows: /logs/, /metadata/, /metadata/submissionDocumentation/, /objects/.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Include default SIP processingMCP.xml'''<div class="mw-collapsible-content">
@@ Line 133: / Line 139: @@
 </div>
 </div>
-| 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.
+| Copies the processing config file added to the transfer in '''Include default Transfer processingMCP.xml''', above, to the SIP.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Remove cache files'''<div class="mw-collapsible-content">
@@ Line 156: / Line 162: @@
 </div>
 </div>
-| Determins which normalization options are available for the SIP and presents them to the user as choices. Normalizes based on selection.
+| 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.
 |-
 |  <div class="toccolours mw-collapsible mw-collapsed">'''Process submission documentation'''<div class="mw-collapsible-content">