Difference between revisions of "Ingest (0.5)"

From Archivematica
Jump to navigation Jump to search
Line 12: Line 12:
 
|- style="background-color:#cccccc;"
 
|- style="background-color:#cccccc;"
 
!style="width:20%"|'''Workflow diagram step'''
 
!style="width:20%"|'''Workflow diagram step'''
−
!style="width:40%"|'''Description'''
+
!style="width:55%"|'''Description'''
−
!style="width:40%"|'''UML diagram references'''
+
!style="width:25%"|'''UML diagram references'''
 
|-
 
|-
 
|-
 
|-
Line 47: Line 47:
 
|- style="background-color:#cccccc;"
 
|- style="background-color:#cccccc;"
 
!style="width:20%"|'''Workflow diagram step'''
 
!style="width:20%"|'''Workflow diagram step'''
−
!style="width:40%"|'''Description'''
+
!style="width:55%"|'''Description'''
−
!style="width:40%"|'''UML diagram references'''
+
!style="width:25%"|'''UML diagram references'''
 
|-
 
|-
 
|Archivist moves SIP from shared folder into quarantine
 
|Archivist moves SIP from shared folder into quarantine
Line 70: Line 70:
 
*Infected files will appear in /home/demo/possiblevirii/. If this occurs, do not take any further steps in the ingest process. Inform the Producer that infected files have been found. It is recommended at this point to delete all SIP copies and request that the Producer take steps to review the causes of the problem and eventually resubmit a malware-free SIP.
 
*Infected files will appear in /home/demo/possiblevirii/. If this occurs, do not take any further steps in the ingest process. Inform the Producer that infected files have been found. It is recommended at this point to delete all SIP copies and request that the Producer take steps to review the causes of the problem and eventually resubmit a malware-free SIP.
 
|
 
|
−
*2.4 Audit SIP for compliance
+
2.4 Audit SIP for compliance
−
*2.5 Assess SIP defiencies
+
2.5 Assess SIP defiencies
−
*2.6 Notify Producer of SIP rejection
+
2.6 Notify Producer of SIP rejection
−
*2.8 Destroy SIP copies
+
2.8 Destroy SIP copies
 
|-
 
|-
 
|Virus-checker report is sent to accessions folder
 
|Virus-checker report is sent to accessions folder
Line 91: Line 91:
 
|- style="background-color:#cccccc;"
 
|- style="background-color:#cccccc;"
 
!style="width:20%"|'''Workflow diagram step'''
 
!style="width:20%"|'''Workflow diagram step'''
−
!style="width:40%"|'''Description'''
+
!style="width:55%"|'''Description'''
−
!style="width:40%"|'''UML diagram references'''
+
!style="width:25%"|'''UML diagram references'''
 
|-
 
|-
  
Line 100: Line 100:
 
*FITS incorporates format identification and validation tools such as DROID. JHOVE and the New Zealand Metadata Extractor, comparing the results of each tool and extracting a set of identification, validation and technical metadata. For more information on the FITS tool, see [http://code.google.com/p/fits/ http://code.google.com/p/fits/]
 
*FITS incorporates format identification and validation tools such as DROID. JHOVE and the New Zealand Metadata Extractor, comparing the results of each tool and extracting a set of identification, validation and technical metadata. For more information on the FITS tool, see [http://code.google.com/p/fits/ http://code.google.com/p/fits/]
 
|
 
|
−
*3.3 Identify formats
+
3.3 Identify formats
−
*3.4 Validate formats
+
3.4 Validate formats
−
*3.5 Extract metadata
+
3.5 Extract metadata
 
|-
 
|-
 
|Identification/validation reports are sent to accessions folder
 
|Identification/validation reports are sent to accessions folder
Line 109: Line 109:
 
*Note that each report contains an MD5 checksum for the file.
 
*Note that each report contains an MD5 checksum for the file.
 
|
 
|
−
*3.3 Identify formats
+
3.3 Identify formats
−
*3.4 Validate formats
+
3.4 Validate formats
−
*3.5 Extract metadata
+
3.5 Extract metadata
 
|-
 
|-
 
|Accession log is sent to accessions folder
 
|Accession log is sent to accessions folder
Line 130: Line 130:
 
|- style="background-color:#cccccc;"
 
|- style="background-color:#cccccc;"
 
!style="width:20%"|'''Workflow diagram step'''
 
!style="width:20%"|'''Workflow diagram step'''
−
!style="width:40%"|'''Description'''
+
!style="width:55%"|'''Description'''
−
!style="width:40%"|'''UML diagram references'''
+
!style="width:25%"|'''UML diagram references'''
 
|-
 
|-
 
|SIP is moved to AIP preparation folder
 
|SIP is moved to AIP preparation folder
Line 195: Line 195:
 
|- style="background-color:#cccccc;"
 
|- style="background-color:#cccccc;"
 
!style="width:20%"|'''Workflow diagram step'''
 
!style="width:20%"|'''Workflow diagram step'''
−
!style="width:40%"|'''Description'''
+
!style="width:55%"|'''Description'''
−
!style="width:40%"|'''UML diagram references'''
+
!style="width:25%"|'''UML diagram references'''
 
|-
 
|-
 
|Archivist moves AIP to archival storage folder
 
|Archivist moves AIP to archival storage folder

Revision as of 18:20, 19 November 2009

Main Page > Documentation > Release 0.5 Documentation > Ingest (0.5)


AD1 Receive SIP

File:Archivematica AD1 ReceiveSIP v1.pdf


Workflow diagram step Description UML diagram references
Producer places SIP in shared folder on host machine
  • The purpose of shared folders is to allow the Producer to drop SIPs into a folder on their host machine or network and have the SIPs automatically appear in a folder in Archivematica, and vice versa.
    • For instructions on setting up shared folders, please go to Virtual appliance instructions.
    • Neither the folder name nor any of the filenames should include spaces or special characters. Underscores are ok.
    • Make the shared folder in Archivematica /home/demoreceiveSIP/.
  • For testing purposes you can avoid setting up shared folders and simply use the test files found in /home/demo/testFiles/.
 1.3 assign network storage for SIP (UC-1.1)
SIP appears in shared folder in Archivematica
  • SIP will appear in /home/demo/receiveSIP/.
  • If using files from /home/demo/testFiles/, copy a folder from /testFiles/ into /home/demo/receiveSIP/.
 1.4 Receive SIP from Producer (UC-1.1)
Archivist copies SIP from shared folder to SIP backup folder
  • Copy the SIP in /home/demo/receiveSIP/ and paste it into /home/demo/receiveSIPbackup/. If anything goes wrong during the ingest process, this backup copy can be retrieved and processed.

AD2 Audit SIP

File:Archivematica AD2 AuditSIP v5.pdf


Workflow diagram step Description UML diagram references
Archivist moves SIP from shared folder into quarantine
  • Drag the SIP from /home/demo/receiveSIP/ to /home/demo/quarantine.
 2.1 Quarantine SIP
SIP is quarantined for 2 minutes
  • In a production system, SIPs would normally be quarantined for a set period of time (for example, four weeks), to allow anti-virus software to be updated with the latest virus profiles.
  • A lock should appear on the SIP folder in quarantine. The archivist will not be able to read or modify the files during this time.
 2.1 Quarantine SIP
SIP is scanned for malware
  • At the end of the quarantine period, ClamAV will automatically scan the files for viruses and other malware.
 2.2 Check SIP for malware
Infected files are sent to possiblevirii folder
  • Infected files will appear in /home/demo/possiblevirii/. If this occurs, do not take any further steps in the ingest process. Inform the Producer that infected files have been found. It is recommended at this point to delete all SIP copies and request that the Producer take steps to review the causes of the problem and eventually resubmit a malware-free SIP.

2.4 Audit SIP for compliance 2.5 Assess SIP defiencies 2.6 Notify Producer of SIP rejection 2.8 Destroy SIP copies

Virus-checker report is sent to accessions folder
  • A report on ClamAV's virus scan will appear automatically: home/demo/accessionreports/virus.log.
 2.4 Audit SIP for compliance

AD3 Accept SIP for Ingest

File:Archivematica AD3 AcceptSIPforIngest v4.pdf


Workflow diagram step Description UML diagram references
SIP contents are identified and validated using FITS
  • FITS (File Information Tool Set) is automatically launched once the quarantine period has ended and the files have been scanned for viruses.
  • FITS incorporates format identification and validation tools such as DROID. JHOVE and the New Zealand Metadata Extractor, comparing the results of each tool and extracting a set of identification, validation and technical metadata. For more information on the FITS tool, see http://code.google.com/p/fits/

3.3 Identify formats 3.4 Validate formats 3.5 Extract metadata

Identification/validation reports are sent to accessions folder
  • The FITS report will appear in /home/demo/accessionreports/. The report appears as a folder with a 10-digit number; inside the folder is a report for each file in the SIP.
  • Note that each report contains an MD5 checksum for the file.

3.3 Identify formats 3.4 Validate formats 3.5 Extract metadata

Accession log is sent to accessions folder
  • A report on the accession process will appear automatically: home/demo/accessionreports/accession.log.
  • For each file in the SIP, the accession log will state "Accession of /tmp/accession-[FITS folder number]/[SIP number]/filename] completed successfully."

AD4 Generate AIP

File:Archivematica AD4 GenerateAIP v2.pdf


Workflow diagram step Description UML diagram references
SIP is moved to AIP preparation folder
  • At the end of the quarantine process, Archivematica automatically drops the SIP into /home/demo/prepareAIP
 4.2 Add content information to AIP
Archivist normalizes files
  • From Archivematica's Linux desktop, open Xena
  • Click Add Directory
  • Select /home/demo/prepareAIP/[SIP]/
  • In Tools > Xena 4.2.1 Preferences > Xena destination directory enter /home/demo/prepareAIP/[SIP].
  • In Tools > Xena 4.2.1 Preferences > Xena log file enter /home/demo/accessionreports/xena_log.
  • Click OK to close Xena 4.2.1 Preferences
  • Click Normalise
  • Wait for normalization process to be completed (a pop-up dialogue box will open indicating that the process has been completed).
  • Click OK to close pop-up window
  • Close Xena
 4.3 Transform content information
Normalized files are saved to AIP preparation folder
  • In the SIP, look for files with the extension .xena. These are normalized versions of the original files.
  • To view representations of normalized files, open the Xena Viewer from Archivematica's Linux desktop.
 4.3 Transform content information
Normalization log is saved to accessions folder
  • A log file showing all the actions taken by Xena will appear: /home/demo/accessionreports/xena_log.0.
 4.3 Transform content information
Archivist moves PDI in accessions folder to SIP in AIP preparation folder
  • In Archivematica, all the contents relating to the SIP in /home/demo/accessionreports/ is considered PDI (Preservation Description Information).
    • Copy these contents to /home/demo/prepareAIP/[SIP]
 4.5 Add PDI to AIP
Archivist moves SIP to AIP generation folder
  • Drag the SIP from /home/demo/prepareAIP/ and drop it into /home/demo/generateAIP/.
SIP content and PDI are zipped into AIP
AIP is moved to AIP receipt folder
  • The bagging process automatically moves the AIP to /home/demo/receiveAIP/.
    • To view the AIP, double-click it. When it opens in a separate window, double-click it again; this will allow you to view (but not modify or delete) the contents of the zipped bag.

AD5 Transfer AIP to Archival Storage

File:Archivematica AD5 TransferAIPtoArchivalStorage v2.pdf


Workflow diagram step Description UML diagram references
Archivist moves AIP to archival storage folder
  • Drag the AIP from /home/demo/receiveAIP/ and drop it into /home/demo/storeAIP/.
  • The folder /home/demo/storeAIP/ should be set up as a shared folder. See Archival Storage (0.5).
 5.2 Transfer AIP to archival storage
Archivist deletes SIP from SIP backup folder
  • Delete the SIP from /home/demo/receiveSIPbackup/.
 5.7 Destroy SIP and AIP copies
Retrieved from "https://wiki.archivematica.org/index.php?title=Ingest_(0.5)&oldid=652"