UM transfer 0.8 - Revision history

Courtney at 17:27, 23 August 2012

2012-08-23T17:27:41Z

Courtney at 17:25, 23 August 2012

2012-08-23T17:25:19Z

Courtney: Created page with "Main Page > Documentation > User manual > User manual 0.8 > Transfer
== General description == During transfer, digital ..."

2012-08-23T17:04:25Z

Created page with "Main Page > Documentation > User manual > User manual 0.8 > Transfer <div class="clearfix"> == General description == During transfer, digital ..."

New page

[[Main Page]] > [[Documentation]] > [[User Manual|User manual]] > [[User manual 0.8]] > Transfer

<div class="clearfix">

== General description ==

During transfer, digital objects are moved into Archivematica and run through several micro-services: UUID assignment; checksum verification (if checksums are present); package extraction (i.e. unzipping of zipped or otherwise packaged files); virus checking; format identification and validation; and metadata extraction. For a definition of "transfer", please see the [[UM glossary|Glossary]]. </br>

At the end of transfer, the user can select a number of ways to create one or more SIPs from the transfer. Once this is done, the SIP(s) are moved into ingest.

If your transfer is a DSpace export, please see [[UM DSpace exports|DSpace exports]].

If your transfer is composed of objects that are the result of digitization, please see [[UM digitization output|Digitization output]].

== Create a transfer ==

#Open the file browser by clicking on the Home folder on the Archivematica desktop ('''figure 1'''). [[Image:desktopg.png|600px|right|thumb|'''Figure 1''' Click on the Home folder on the Archivematica desktop]]

</div>

<div class="clearfix">

</div>

=== Option 1 ===
Use this option if you have not yet compiled your objects and/or directories into a folder ready for processing.
#Navigate to the standardTransfer directory by using the shortcut on the left panel of the file manager.
#Hover your cursor over the empty right-hand panel, right-click and select "Create a structured directory" ('''figure 2'''). For a definition of "structured directory", please see [[UM glossary|Glossary]]
#The structured directory will contain three subdirectories: ''logs'', ''metadata'', ''objects''. Copy the digital files to be preserved into the ''objects'' directory. Note that you can create subdirectories within ''objects'' if desired.[[Image:structuredDirectoryg.png|600px|right|thumb|'''Figure 2''' Option 1: right-click and create a structured directory]]

</div>

<div class="clearfix">

</div>

=== Option 2 ===
Use this option if you have already compiled your objects and/or directories into a folder ready for processing.
#Navigate to a directory of files to be preserved that has not been created using the right-click script in option 1, above.
#Right-click the directory and select "Restructure for compliance" ('''figure 3'''). This will create a structured directory containing the subdirectories required to transfer the files into Archivematica: ''logs'', ''metadata'', ''objects''.
#Copy and paste the directory to ''standardTransfer'' using the shortcut on the left panel of the file manager.[[Image:restructureg.png|600px|right|thumb|'''Figure 3''' Option 2: right-click on a directory and restructure it for compliance]]

</div>

<div class="clearfix">

</div>

== Add submission documentation ==

In the transfer you have just created, navigate to the ''/metadata/submissionDocumentation'' folder and add files if desired. These files could be donor agreements, transfer forms, copyright agreements and any correspondence or other documentation relating to the transfer. Any SIPs subsequently made from this transfer will automatically contain copies of this documentation.

== Process the transfer ==
#Open the Archivematica dashboard by clicking on the Dashboard icon in the Archivematica desktop ('''figure 1''').[[Image:transfer1g.png|600px|right|thumb|'''Figure 4''' Hover cursor over the transfer. Click on the spyglass icon on the right-hand side]]
#Click on the transfer tab.
#The transfer will appear in the dashboard with a bell icon next to it. This means that it is awaiting a decision by the user.
#Hover your cursor over the transfer. This will bring up three icons on the right-hand side ('''figure 4''').
#Click on the spyglass icon ('''figure 4''').
#In the Actions drop-down menu, select "Transfer complete" to begin processing the transfer ('''figure 5'''). [[Image:transfer2g.png|600px|right|thumb|'''Figure 5''' In the Actions drop-down menu, select "Transfer complete"]]
#The transfer will now run through a series of micro-services. These include:
#*Verify transfer compliance (verifies that the transfer is properly structured - i.e. with the logs, metadata and objects folders)
#*Create transfer UUID (assigns a unique universal identifier for the transfer as a whole)
#*Assign file UUIDs to objects (assigns a unique universal identifier to each file in the /objects directory)
#*Verify metadata directory checksums (verifies any checksums included with the transfer)
#*Assign checksums to objects (assigns a sha-256 checksum to each file in the /objects directory)
#*Generate METS.xml document (creates a METS file capturing the original order of the transfer. This METS file is added to any SIPs generated from this transfer)
#*Extract packages (extracts contents from zipped or otherwise packaged files)
#*Sanitize object's file and directory names (removes prohibited characters from folder and filenames, such as ampersands)
#*Scan for viruses (scans for viruses and malware)
#*Characterize and extract metadata (identifies and validates file formats; extracts technical metadata embedded in the files)
#A transfer that is in the middle of processing will show which micro-services have been completed (green) and which are in progress (orange) ('''figure 6'''). [[Image:transfer3g.png|600px|right|thumb|'''Figure 6''' A transfer in the middle of the "Characterize and extract metadata" micro-service]]
#When a micro-service fails or encounters an error, the micro-service background turns from green to pink and a "failed" icon appears next to the transfer or SIP name. See [[UM error handling|Error handling]] for more information about how to handle an error.
#Once the transfer micro-services are completed, a bell icon will appear next to the transfer. This means that the transfer is ready to be packaged into one or more SIPs ('''figure 7'''). See [[UM ingest|Ingest]] for next steps.[[Image:transfer4g.png|600px|right|thumb|'''Figure 7''' A transfer that is ready to be packaged into one or more SIPs and moved into ingest]]

← Older revision		Revision as of 17:25, 23 August 2012
Line 1:		Line 1:
−	[[Main Page]] > [[Documentation]] > [[User Manual\|User manual]] > [[User manual 0.8]] > Transfer	+	[[Main Page]] > [[Documentation]] > [[User Manual\|User manual]] > [[User manual 0.8]] > Transfer 0.8

@@ Line 10: / Line 10: @@
 At the end of transfer, the user can select a number of ways to create one or more SIPs from the transfer. Once this is done, the SIP(s) are moved into ingest.
-If your transfer is a DSpace export, please see [[UM DSpace exports|DSpace exports]].
+If your transfer is a DSpace export, please see [[UM DSpace exports 0.8|DSpace exports]].
-If your transfer is composed of objects that are the result of digitization, please see [[UM digitization output|Digitization output]].
+If your transfer is composed of objects that are the result of digitization, please see [[UM digitization output 0.8|Digitization output]].
 == Create a transfer ==
@@ Line 71: / Line 71: @@
 #*Characterize and extract metadata (identifies and validates file formats; extracts technical metadata embedded in the files)
 #A transfer that is in the middle of processing will show which micro-services have been completed (green) and which are in progress (orange) ('''figure 6'''). [[Image:transfer3g.png|600px|right|thumb|'''Figure 6'''  A transfer in the middle of the "Characterize and extract metadata" micro-service]]
-#When a micro-service fails or encounters an error, the micro-service background turns from green to pink and a "failed" icon appears next to the transfer or SIP name. See [[UM error handling|Error handling]] for more information about how to handle an error.
+#When a micro-service fails or encounters an error, the micro-service background turns from green to pink and a "failed" icon appears next to the transfer or SIP name. See [[UM error handling 0.8|Error handling]] for more information about how to handle an error.
-#Once the transfer micro-services are completed, a bell icon will appear next to the transfer. This means that the transfer is ready to be packaged into one or more SIPs ('''figure 7'''). See [[UM ingest|Ingest]] for next steps.[[Image:transfer4g.png|600px|right|thumb|'''Figure 7'''  A transfer that is ready to be packaged into one or more SIPs and moved into ingest]]
+#Once the transfer micro-services are completed, a bell icon will appear next to the transfer. This means that the transfer is ready to be packaged into one or more SIPs ('''figure 7'''). See [[UM ingest 0.8|Ingest]] for next steps.[[Image:transfer4g.png|600px|right|thumb|'''Figure 7'''  A transfer that is ready to be packaged into one or more SIPs and moved into ingest]]

UM transfer 0.8 - Revision history

Courtney at 17:27, 23 August 2012

Courtney at 17:25, 23 August 2012

Courtney: Created page with "Main Page > Documentation > User manual > User manual 0.8 > Transfer == General description == During transfer, digital ..."

Courtney: Created page with "Main Page > Documentation > User manual > User manual 0.8 > Transfer
== General description == During transfer, digital ..."