Difference between revisions of "UM ingest"

From Archivematica
Jump to navigation Jump to search
 
(69 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Main Page]] > [[Documentation]] > [[User Manual|User manual]] > [[User manual 0.8]] > Ingest
+
[[Main Page]] > [[Documentation]] > [[User Manual|User manual]] > [[User manual 0.10]] > Ingest
  
 
<div class="clearfix">
 
<div class="clearfix">
Line 5: Line 5:
 
== General description ==
 
== General description ==
  
During ingest, digital objects are packaged into SIPs and run through several micro-services, including normalization packaging into an AIP, and generation of a DIP. </br>
+
During ingest, digital objects are packaged into SIPs and run through several micro-services, including normalization, packaging into an AIP and generation of a DIP.  
  
== Create one or more SIP(s) ==
+
If you would like to skip some of the default decision points or make preconfigured choices for your desired workflow, see [[Administrator_manual_0.10#Processing_configuration|Administrator manual - Processing configuration]]
  
#Process one or more transfers as described in [[UM transfer|Transfer]]. [[Image:ingest1g.png|500px|right|thumb|Select an option from the Create SIP(s) Actions drop-down menu]]
+
Should you run into an error during ingest, please see [[UM error handling|Error handling]].
#While still viewing the transfer tab you should see a bell icon next to the transfer. The micro-service related to the bell is "Create SIP(s)".
+
 
#Choose one of three options for creating a SIP (or reject the transfer if desired).
+
Special notice: Do not have OpenOffice running in the VM when processing any SIPs which may contain word processing or other Office docs.
 +
 
 +
== Create SIP ==
 +
 
 +
#Process transfers as described in [[UM transfer|Transfer]].
 +
#Click on the Ingest tab.You will get a pop-up warning you that if you wish to add metadata or PREMIS rights you must do it prior to normalization. Dismiss or wait until it disappears.
 +
#The single SIP will move through a number of micro-services. Wait until it reaches "Normalize" and a bell icon appears ('''figure 5'''). [[Image:NormalizeMS-10.png|600px|right|thumb|'''Figure 5'''  Normalization micro-service]]
 +
#To add descriptive metadata, see Add metadata, below.
 +
#To add PREMIS rights information, see Add PREMIS, below.
 +
#For selecting a normalization option, see Normalization, below.
  
 
</div>
 
</div>
Line 19: Line 28:
 
</div>
 
</div>
  
=== Option 1: Create single SIP and continue processing ===
+
== Add metadata ==
This will create a single SIP from the transfer and move it through the initial micro-services to the normalization step. The user can add metadata and select from a number of normalization options at this point.</br>
+
You must add metadata prior to the normalization step. Any metadata added after normalization will not be included in the AIP package. See [http://www.ica-atom.org/doc/Dublin_Core ICA-AtoM (Qubit) Dublin Core] for information about the Dublin Core elements available. See [http://ica-atom.org/doc/Glossary#Rights_record ICA-AtoM (Qubit) Rights Entity] for information about the rights elements available.
 +
 
 +
*'''Remember''', if you are importing lower-level metadata (i.e. metadata to be attached to subdirectories and files within a SIP) see *[[UM Transfer metadata import|Metadata import]] in the [[UM transfer|Transfer]] section of this manual.
 +
 
 +
#Click on the template icon. ('''figure 6''').[[Image:MetadataIcon-10.png|600px|right|thumb|'''Figure 6'''  To add metadata, click on the template icon]]
 +
#This will take you to the SIP detail panel. On the left-hand side, under metadata click Add ('''figure 7''').[[Image:SIPDetailPanel-10.png|600px|right|thumb|'''Figure 7'''  SIP detail panel]]
 +
#Add metadata as desired ('''figure 8''') and save it by clicking the Create button at the bottom of the screen. Note that in Archivematica 0.10 you can only add metadata at the SIP level. If you would like to add metadata to a digital object, you will need to do that once the object has been uploaded to your access system.[[Image:MetadataformDC-10.png|600px|right|thumb|'''Figure 8'''  SIP metadata entry form]]
 +
#When you click Create, you will see the metadata entry in the list page ('''figure 9'''). To edit it further, click Edit on the right-hand side.To delete it, click Delete. To add more DC metadata, click the Add button below the list.
 +
[[Image:ListMD-10.png|600px|right|thumb|'''Figure 9''' SIP metadata list]]
 +
#Return to the ingest tab to continue processing the SIP.
  
#Once you have selected "Create single SIP and continue processing", click on the Ingest tab.[[Image:ingest2g.png|500px|right|thumb|To add metadata, click anywhere on the grey highlighted area]]
 
#The SIP will be running through a number of micro-services. Wait until it reaches "Normalize" and a bell icon appears.
 
#To add descriptive metadata, click anywhere on the grey highlighted area of the SIP.
 
 
</div>
 
</div>
  
Line 31: Line 46:
 
</div>
 
</div>
  
=== Option 2: Create single SIP ===
+
== Add PREMIS rights ==
#This will create a single SIP from the transfer and allow the user to re-organize or delete digital objects if desired. This is useful if there has been no appraisal on the objects prior to processing in Archivematica.
+
 
#The user can add metadata and approve SIP creation at this point, or approve SIP creation and wait until the normalization step to add metadata.
+
[[Image:CopyrightNext.png|600px|right|thumb|'''Figure 10''' SIP rights template - first page]]
 +
[[Image:RightsPg2AddAct.png|600px|right|thumb|'''Figure 11''' SIP rights template - second page]]
 +
 
 +
You must add PREMIS rights prior to the normalization step. Any rights added after normalization will not be included in the AIP package or the DIP upload. See [http://www.ica-atom.org/doc/Dublin_Core ICA-AtoM (Qubit) Dublin Core] for information about the PREMIS rights bases and elements available.
 +
 
 +
See a screencast demonstration of this feature at [http://youtu.be/BSfQ4bVGiDY Archivematica 0.9-beta Premis] (Oct 10, 2012)
 +
 
 +
#Click on the template icon. ('''figure 6''').
 +
#This will take you to the SIP detail panel. On the left-hand side, under Rights click Add ('''figure 7''').
 +
#Add rights as desired ('''figure 10''') and save it by clicking the Save button at the bottom of the screen, or clicking Next if you are finished and ready to move on to the second page of data entry. Rights entries are made up of two pages of content. To get to the second page to complete data entry, click Next (figure 11). Note that in Archivematica 0.9 you can only add rights at the SIP level. If you would like to add rights to a digital object, you will need to do that once the object has been uploaded to your access system.
 +
#When you click Save on the second page, you will be given the option to add another act with its associated grants and/or restrictions.('''figure 12''') [[Image:Createnewgrant.png|600px|right|thumb|'''Figure 12''' Repeatable acts in rights template]]
 +
# If you have finished adding acts, click Done. You will see the rights entry in the list page . To edit it further, click Edit on the right-hand side.('''figure 13''') [[Image:T16RightsPanelwRights.png|600px|right|thumb|'''Figure 13''' SIP detail panel with rights]]
 +
#Return to the ingest tab to continue processing the SIP.
  
 
</div>
 
</div>
Line 41: Line 68:
 
</div>
 
</div>
  
=== Option 3: Manual SIP creation ===
+
== Normalize ==
#This option allows the user to break one transfer into more than one SIP, or to create one or more SIPs from more than one transfer. The permitted relationships are:
 
#*One transfer --> one or more SIPs
 
#*Many transfers --> one or more SIPs
 
  
== Add metadata ==
+
Normalizing is the process of converting ingested digital objects to preservation and/or access formats. Note that the original objects are always kept along with their normalized versions. For more information about Archivematica's preservation strategy, go to the [[UM preservation planning|Preservation Planning]] section of the manual.
#Click anywhere on the grey background of a SIP to add Dublin Core metadata.[[Image:metadata1g.png|500px|right|thumb|The SIP detail panel]]
+
</div>
#This will take you to the SIP detail panel. On the left-hand side, under metadata click Add.
 
#Add metadata as desired and save it by clicking the Save button at the bottom of the screen. Note that in Archivematica 0.8 you can only add metadata at the SIP level. If you would like to add metadata to a digital object, you will need to do that once the object has been uploaded to your access system.
 
#When you click Save, you will see the metadata entry in the list page. To edit it further, click Edit on the right-hand side.
 
#Return to the ingest tab to continue processing the SIP.[[Image:metadata2g.png|500px|right|thumb|Using the data entry form to add descriptive metadata]] [[Image:metadata3g.png|500px|right|thumb|After saving your metadata]]
 
  
 +
<div class="clearfix">
  
 +
</div>
 +
[[Image:NormPresAccess-10.png|600px|right|thumb|'''Figure 14''' Selecting a normalization option]]
 
</div>
 
</div>
  
Line 59: Line 82:
  
 
</div>
 
</div>
 +
#At the normalization step, the SIP will appear in the dashboard with a bell icon next to it. Select one of the normalization options from the Actions drop-down menu ('''figure 14'''):
 +
#*Normalize for preservation and access: creates preservation copies of the objects plus access copies which will be used to generate the DIP.
 +
#*Normalize for access: no preservation copies are created. Creates access copies which will be used to generate the DIP.
 +
#*Normalize for preservation: creates preservation copies. No access copies are created and no DIP will be generated.
 +
#*Do not normalize: no preservation copies are created. No access copies are created and no DIP will be generated.
 +
#*You may also Reject SIP at this stage.
 +
#Once normalization is completed you can review the results in the normalization report. Click on the report icon next to the Actions drop-down menu ('''figure 15''').
 +
#*The report shows what has been normalized and what is already in an acceptable preservation and access format ('''figure 16''').
 +
#You may review the normalization results in a new tab by clicking on Review. ('''figure 17''') If your browser has the correct plug-ins to open a file, you may open it in another tab by clicking on it. If you click on a file and your browser cannot open it, it will download locally so you can view it using the appropriate software.
 +
#Approve normalization in the Actions drop-down menu to continue processing the SIP.
 +
[[Image:ReportIcon-10.png|600px|right|thumb|'''Figure 15'''  Click on the report icon to open the normalization report]][[Image:NormReport-10.png|600px|right|thumb|'''Figure 16 '''  The normalization report shows what was normalized and what was already in an acceptable preservation or access format]]
 +
[[Image:RvrNorm-10.png|600px|right|thumb|'''Figure 17 '''  Review normalization results in new tab]]
  
== Normalize ==
 
  
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.
+
</div>
 +
 
 +
<div class="clearfix">
 +
 
 +
</div>
  
 
== Store AIP ==
 
== Store AIP ==
 +
 +
[[Image:StoreAIPUpDIP-10.png|600px|right|thumb|'''Figure 18'''  Archivematica ready to store AIP and upload DIP.]]
 +
 +
#After normalization is approved, the SIP runs through a number of micro-services, including processing of the submission documentation, generation of the METS file, indexing, generation of the DIP and packaging of the AIP.
 +
#When these micro-services are complete, the user can upload DIP and store AIP. ('''figure 18''')
 +
#If desired, review the contents of the AIP in another tab by clicking on Review. More information on Archivematica's AIP structure and the METS/PREMIS file is available on the Archivematica wiki: see [[AIP structure]] and [[METS]]. You can download the AIP at this stage, as well, by clicking on it.
 +
#From the Action dropdown menu, select "Store AIP" to move the AIP into archival storage. You can store an AIP in any number of preconfigured directories. For instructions to configure AIP storage locations, see [[Administrator_manual|Administrator manual - AIP storage locations]]
 +
#From the Action dropdown menu, select the AIP storage location from a pre-configured set of options.
 +
#For information on viewing and managing stored AIPs go to [[UM archival storage|Archival storage]]
 +
 +
</div>
 +
 +
<div class="clearfix">
 +
 +
</div>
  
 
== Upload DIP ==
 
== Upload DIP ==
 +
For information on uploading the DIP, go to [[UM access|Access]].

Latest revision as of 18:01, 2 May 2013

Main Page > Documentation > User manual > User manual 0.10 > Ingest

General description[edit]

During ingest, digital objects are packaged into SIPs and run through several micro-services, including normalization, packaging into an AIP and generation of a DIP.

If you would like to skip some of the default decision points or make preconfigured choices for your desired workflow, see Administrator manual - Processing configuration

Should you run into an error during ingest, please see Error handling.

Special notice: Do not have OpenOffice running in the VM when processing any SIPs which may contain word processing or other Office docs.

Create SIP[edit]

  1. Process transfers as described in Transfer.
  2. Click on the Ingest tab.You will get a pop-up warning you that if you wish to add metadata or PREMIS rights you must do it prior to normalization. Dismiss or wait until it disappears.
  3. The single SIP will move through a number of micro-services. Wait until it reaches "Normalize" and a bell icon appears (figure 5).
    Figure 5 Normalization micro-service
  4. To add descriptive metadata, see Add metadata, below.
  5. To add PREMIS rights information, see Add PREMIS, below.
  6. For selecting a normalization option, see Normalization, below.

Add metadata[edit]

You must add metadata prior to the normalization step. Any metadata added after normalization will not be included in the AIP package. See ICA-AtoM (Qubit) Dublin Core for information about the Dublin Core elements available. See ICA-AtoM (Qubit) Rights Entity for information about the rights elements available.

  • Remember, if you are importing lower-level metadata (i.e. metadata to be attached to subdirectories and files within a SIP) see *Metadata import in the Transfer section of this manual.
  1. Click on the template icon. (figure 6).
    Figure 6 To add metadata, click on the template icon
  2. This will take you to the SIP detail panel. On the left-hand side, under metadata click Add (figure 7).
    Figure 7 SIP detail panel
  3. Add metadata as desired (figure 8) and save it by clicking the Create button at the bottom of the screen. Note that in Archivematica 0.10 you can only add metadata at the SIP level. If you would like to add metadata to a digital object, you will need to do that once the object has been uploaded to your access system.
    Figure 8 SIP metadata entry form
  4. When you click Create, you will see the metadata entry in the list page (figure 9). To edit it further, click Edit on the right-hand side.To delete it, click Delete. To add more DC metadata, click the Add button below the list.
Figure 9 SIP metadata list
  1. Return to the ingest tab to continue processing the SIP.

Add PREMIS rights[edit]

Figure 10 SIP rights template - first page
Figure 11 SIP rights template - second page

You must add PREMIS rights prior to the normalization step. Any rights added after normalization will not be included in the AIP package or the DIP upload. See ICA-AtoM (Qubit) Dublin Core for information about the PREMIS rights bases and elements available.

See a screencast demonstration of this feature at Archivematica 0.9-beta Premis (Oct 10, 2012)

  1. Click on the template icon. (figure 6).
  2. This will take you to the SIP detail panel. On the left-hand side, under Rights click Add (figure 7).
  3. Add rights as desired (figure 10) and save it by clicking the Save button at the bottom of the screen, or clicking Next if you are finished and ready to move on to the second page of data entry. Rights entries are made up of two pages of content. To get to the second page to complete data entry, click Next (figure 11). Note that in Archivematica 0.9 you can only add rights at the SIP level. If you would like to add rights to a digital object, you will need to do that once the object has been uploaded to your access system.
  4. When you click Save on the second page, you will be given the option to add another act with its associated grants and/or restrictions.(figure 12)
    Figure 12 Repeatable acts in rights template
  5. If you have finished adding acts, click Done. You will see the rights entry in the list page . To edit it further, click Edit on the right-hand side.(figure 13)
    Figure 13 SIP detail panel with rights
  6. Return to the ingest tab to continue processing the SIP.

Normalize[edit]

Normalizing is the process of converting ingested digital objects to preservation and/or access formats. Note that the original objects are always kept along with their normalized versions. For more information about Archivematica's preservation strategy, go to the Preservation Planning section of the manual.

Figure 14 Selecting a normalization option
  1. At the normalization step, the SIP will appear in the dashboard with a bell icon next to it. Select one of the normalization options from the Actions drop-down menu (figure 14):
    • Normalize for preservation and access: creates preservation copies of the objects plus access copies which will be used to generate the DIP.
    • Normalize for access: no preservation copies are created. Creates access copies which will be used to generate the DIP.
    • Normalize for preservation: creates preservation copies. No access copies are created and no DIP will be generated.
    • Do not normalize: no preservation copies are created. No access copies are created and no DIP will be generated.
    • You may also Reject SIP at this stage.
  2. Once normalization is completed you can review the results in the normalization report. Click on the report icon next to the Actions drop-down menu (figure 15).
    • The report shows what has been normalized and what is already in an acceptable preservation and access format (figure 16).
  3. You may review the normalization results in a new tab by clicking on Review. (figure 17) If your browser has the correct plug-ins to open a file, you may open it in another tab by clicking on it. If you click on a file and your browser cannot open it, it will download locally so you can view it using the appropriate software.
  4. Approve normalization in the Actions drop-down menu to continue processing the SIP.
Figure 15 Click on the report icon to open the normalization report
Figure 16 The normalization report shows what was normalized and what was already in an acceptable preservation or access format
Figure 17 Review normalization results in new tab


Store AIP[edit]

Figure 18 Archivematica ready to store AIP and upload DIP.
  1. After normalization is approved, the SIP runs through a number of micro-services, including processing of the submission documentation, generation of the METS file, indexing, generation of the DIP and packaging of the AIP.
  2. When these micro-services are complete, the user can upload DIP and store AIP. (figure 18)
  3. If desired, review the contents of the AIP in another tab by clicking on Review. More information on Archivematica's AIP structure and the METS/PREMIS file is available on the Archivematica wiki: see AIP structure and METS. You can download the AIP at this stage, as well, by clicking on it.
  4. From the Action dropdown menu, select "Store AIP" to move the AIP into archival storage. You can store an AIP in any number of preconfigured directories. For instructions to configure AIP storage locations, see Administrator manual - AIP storage locations
  5. From the Action dropdown menu, select the AIP storage location from a pre-configured set of options.
  6. For information on viewing and managing stored AIPs go to Archival storage

Upload DIP[edit]

For information on uploading the DIP, go to Access.